diff --git a/.github/workflows/build-openapi-specs.yml b/.github/workflows/build-single-file-specs.yml similarity index 59% rename from .github/workflows/build-openapi-specs.yml rename to .github/workflows/build-single-file-specs.yml index 8bae695d..33a63123 100644 --- a/.github/workflows/build-openapi-specs.yml +++ b/.github/workflows/build-single-file-specs.yml @@ -1,4 +1,4 @@ -name: Build OpenAPI specs +name: Build latest single-file specs on: [push, pull_request] jobs: @@ -8,17 +8,24 @@ jobs: - name: Checkout the repo uses: actions/checkout@v3 + - name: Setup Node.js + uses: actions/setup-node@v2 + with: + node-version: '20' + - name: Build - run: ./gradlew build - - - name: Move OpenAPI specs to root - run: mv build/smithyprojections/opensearch-api-specification/full/openapi/OpenSearch.openapi.json . + working-directory: ./tools + run: |- + npm install + export ROOT_PATH=../spec/OpenSearch.openapi.yaml + export OUTPUT_PATH=../builds/OpenSearch.latest.yaml + npm run merge -- $ROOT_PATH $OUTPUT_PATH - name: Upload OpenAPI model artifact uses: actions/upload-artifact@v3 with: name: opensearch-openapi - path: ./OpenSearch.openapi.json + path: ./builds/OpenSearch.latest.yaml - name: GitHub App token id: github_app_token @@ -34,9 +41,9 @@ jobs: if: github.repository == 'opensearch-project/opensearch-api-specification' && github.event_name == 'push' && github.event.ref == 'refs/heads/main' with: token: ${{ steps.github_app_token.outputs.token }} - commit-message: Update OpenAPI specs + commit-message: Build latest single-file specs signoff: true - title: Update OpenAPI specs + title: Build latest single-file specs body: | - I've noticed an update to the models. This pull request updates the OpenAPI specs accordingly. - branch: create-pull-request/specs-update + I've noticed an update in the `./spec` folder. This pull request updates `./build/OpenSearch.latest.yaml` accordingly. + branch: create-pull-request/single-file-specs \ No newline at end of file diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml deleted file mode 100644 index 97270d6f..00000000 --- a/.github/workflows/ci.yaml +++ /dev/null @@ -1,46 +0,0 @@ -name: Continuous Integration - -on: [push, pull_request] - -jobs: - Testing_Model_APIs: - runs-on: ubuntu-20.04 - steps: - - uses: actions/checkout@v2 - - - name: Set up Node.js - uses: actions/setup-node@v2 - - - name: Installing node modules - run: npm install - working-directory: ./test - - - name: Installing Dredd - run: sudo npm install dredd --global --unsafe-perm=true --allow-root - - - name: Set up Python - uses: actions/setup-python@v2 - - - name: Install pipenv - run: pip install pipenv - - - name: Installing python modules - run: pipenv install --system - working-directory: ./test - - - name: Build the stack - run: docker-compose up -d - shell: bash - working-directory: ./test - - - name: Waiting for OpenSearch domain to be up. - run: sh ./.github/workflows/domain-check.sh - - - name: Run script file - run: | - # Disabling TLS certificate verfication as hosted on docker. - export NODE_TLS_REJECT_UNAUTHORIZED=0 - python driver-code.py - shell: bash - working-directory: ./test/scripts - diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml deleted file mode 100644 index 532e5120..00000000 --- a/.github/workflows/coverage.yml +++ /dev/null @@ -1,55 +0,0 @@ -name: API Coverage - -on: [push, pull_request_target] - -env: - JAVA_VERSION: 11 - OPENSEARCH_INITIAL_ADMIN_PASSWORD: BobgG7YrtsdKf9M - -jobs: - coverage: - permissions: - pull-requests: write - runs-on: ubuntu-latest - steps: - - name: Checkout Repo - uses: actions/checkout@v4 - with: - ref: ${{ github.event.pull_request.head.sha }} - - name: Build and Run Docker Container - run: | - docker build coverage --tag opensearch-with-api-plugin - docker run -d -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" -e OPENSEARCH_INITIAL_ADMIN_PASSWORD="$OPENSEARCH_INITIAL_ADMIN_PASSWORD" opensearch-with-api-plugin - sleep 15 - - name: Display OpenSearch Info - run: | - curl -ks -u "admin:$OPENSEARCH_INITIAL_ADMIN_PASSWORD" https://localhost:9200/ | jq - - name: Dump and Compare API - run: | - curl -ks -u "admin:$OPENSEARCH_INITIAL_ADMIN_PASSWORD" https://localhost:9200/_plugins/api | jq > OpenSearch.auto.openapi.json - docker run --rm --mount type=bind,source=.,target=/specs openapitools/openapi-diff:latest /specs/OpenSearch.openapi.json /specs/OpenSearch.auto.openapi.json --json /specs/diff.json - - name: Show Diff - run: | - echo "-------- Missing APIs" - jq -r '.newEndpoints | group_by(.pathUrl)[] | "\(.[0].pathUrl): \([.[].method])"' diff.json - echo "-------- Legacy APIs" - jq -r '.missingEndpoints | group_by(.pathUrl)[] | "\(.[0].pathUrl): \([.[].method])"' diff.json - - name: Gather Coverage - id: coverage - shell: bash - run: | - current=`jq -r '.paths | keys | length' OpenSearch.openapi.json` - total=`jq -r '.paths | keys | length' OpenSearch.auto.openapi.json` - percent=$((current * 100 / total)) - echo "API specs implemented for $current/$total ($percent%) APIs." - cat >>"$GITHUB_OUTPUT" <.smithy` format. - -Overall, the file structure of the Smithy models looks like this: ``` -model -├── _global -│ ├── index -│ │ ├── operations.smithy -│ │ └── structures.smithy -│ └── search -│ ├── operations.smithy -│ └── structures.smithy -├── cat -│ └── health -│ ├── operations.smithy -│ └── structures.smithy +spec +│ +├── namespaces +│ ├── _core.yaml +│ ├── cat.yaml +│ ├── cluster.yaml +│ ├── nodes.yaml +│ └── ... +│ +├── schemas +│ ├── _common.yaml +│ ├── _common.mapping.yaml +│ ├── _core._common.yaml +│ ├── _core.bulk.yaml +│ ├── cat._common.yaml +│ ├── cat.aliases.yaml +│ └── ... │ -├── common_strings.smithy -└── common_enums.smithy +└── OpenSearch.openapi.yaml ``` +Every `yaml` file is a valid OpenAPI 3 document. This means that you can use any OpenAPI 3 compatible tool to view and edit the files, and IDEs with OpenAPI support will provide you with autocompletion and validation in real-time. -## Defining an API Action +## Grouping Operations -As mentioned in the previous section, each API action is composed of multiple operations that are defined in the same `operations.smithy` file. The `search` action, for example, is consisted of 4 operations: +Each API action is composed of multiple operations. The `search` action, for example, is consisted of 4 operations: - `GET /_search` - `POST /_search` - `GET /{index}/_search` - `POST /{index}/_search` -To group these operations together in the `search` action, we mark them with the `@xOperationGroup` trait with the same value of `search`. Note that this trait tells the client generators that these operations serve identical purpose and should be grouped together in the same API method. The `xOperationGroup` trait also tells the generators the namespace and the name of the API method. For example, operations with `xOperationGroup` trait value of `indicies.create` will result in `client.indices.create()` method to be generated. - - -### Defining operations - -We name each operation using the following format `[ActionName]_[HttpVerb]_[PathParameters]` -- ActionName: The name of the action. CamelCase and without the `.` character. E.g. `search -> Search`, `cat.health -> CatHealth`. -- HttpVerb: The HTTP verb of the operation. E.g. `Get`, `Post`, `Put`, `Delete`. In actions where all operations share the same HTTP verb, we omit the verb from the operation name. -- PathParameters: This part is prefixed with `With` and is followed by the names of the path parameters. E.g. `WithIndex`, `WithId`, and `WithIndexId`. This part can be omitted if the operation does not have any path parameters, or if all operations of the action share the same path parameters. - -The `search` action mentioned above will have the following operations: -- `Search_Get` -- `Search_Post` -- `Search_Get_WithIndex` -- `Search_Post_WithIndex` - -### Defining input and output structures - -Operations of the same API action share: -- Identical Output structure -- Similar Input structure: - - Identical set of querystring parameters - - Identical schema of the request body, if any - - Only differ in the path parameters - -Due to these characteristics, these operations share the same output structure, and their input structures reuse the same querystring parameters and request body schema. The `search` action, for example, will have the following input and output structures: -- `Search_Output` -- `Search_Get_Input` -- `Search_Post_Input` -- `Search_Get_WithIndex_Input` -- `Search_Post_WithIndex_Input` - -These structures are defined in the `structures.smithy` file along with the shared querystring parameters and request body schema. The `search` action's `structures.smithy` file will look like this: -```smithy -@mixin -structure Search_QueryParams { - ... -} - -structure Search_BodyParams { - ... -} - -@input -structure Search_Get_Input with [Search_QueryParams] { -} - -@input -structure Search_Post_Input with [Search_QueryParams] { - @httpPayload - content: Search_BodyParams, -} - -@input -structure Search_Get_WithIndex_Input with [Search_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -@input -structure Search_Post_WithIndex_Input with [Search_QueryParams] { - @required - @httpLabel - index: PathIndices, - @httpPayload - content: Search_BodyParams, -} - -structure Search_Output { - _scroll_id: String, - took: Long, - timed_out: Boolean, - _shards: ShardStatistics, - hits: HitsMetadata -} -``` - -Note that all input structures utilize the `Search_QueryParams` mixin, and The `Search_BodyParams` structure is used as `@httpPayload` for the both POST operations as seen in `Search_Post_Input` and `Search_Post_WithIndex_Input`. - -## Defining Request and Response Bodies -The bodies of request and response are also defined inside the `structures.smithy` file. The request body is a member (usually named `content`) of the input structure and MUST be accompanied by the `@httpPayload` trait. It is also often accompanied by the `@required` trait since most operations that accept a request body also require it. The response body, on the other hand, is the output structure itself. - -```smithy -@input -structure Operation_Input { - @required - @httpPayload - content: Search_BodyParams, -} - -structure Request_Body { - // Request body members are defined here -} - -structure Operation_Output { - // Response body members are defined here -} -``` - -## Defining Common Parameters - -Common parameters that are used across OpenSearch namespaces are defined in the root folder, `model/`, and grouped by data-type in files of `common_.smithy` format. There are a few things to note when defining global common parameters: -- All path parameters should be prefixed with `Path` like `PathIndex` and `PathDocumentID`. -- Smithy doesn't support _enum_ or _list_ as path parameters. We, therefore, have to define such parameters as _string_ and use `x-data-type` vendor extension to denote their actual types (More on this in the traits section). -- Parameters of type `time` are defined as `string` and has `@pattern("^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$")` trait to denote that they are in the format of ``. E.g. `1d`, `2h`, `3m`, `4s`, `5ms`, `6micros`, `7nanos`. We use `x-data-type: "time"` vendor extension for this type. -- Path parameters that are defined as strings must be accompanied by a `@pattern` trait and should be default to `^[^_][\\d\\w-*]*$` to signify that they are not allowed to start with `_` to avoid URI Conflict errors. -- The `@documentation`, `@default`, and `@deprecation` traits can later be overridden by the operations that use these parameters. - -Common parameters that are used within a namespace, especially namespaces representing plugins like `security` are defined in the namespace folder (e.g. `model/security`) - -## Smithy Traits -We use Smithy traits extensively in this project to work around some limitations of Smithy and to deal with some quirks of the OpenSearch API. Here are some of the traits that you should be aware of: -- `@suppress(["HttpMethodSemantics.UnexpectedPayload"])`: Used in DELETE operations with request body to suppress the UnexpectedPayload error. -- `@suppress(["HttpUriConflict"])`: Used to suppress the HttpUriConflict error that is thrown when two operations have conflicting URI. Unfortunately, this happens a lot in OpenSearch API. When in doubt, add this trait to the operation. -- `@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)")`: Required for most Path parameters to avoid URI Conflict errors. This is often used in tandem with the @suppress trait above. To denote the actual pattern of the parameter, use `x-string-pattern` vendor extension. -- `@readonly`: Should accompany most GET operations to denote that they are read-only. -- `@idempotent`: Should accompany most PUT operations to denote that they are idempotent. - -### OpenAPI Specification Extension Traits - -This repository includes several custom Smithy traits that map to OpenAPI Specification Extensions to fill in any metadata not directly supported by Smithy or OpenAPI. These traits are used to add the following metadata: -- `@xOperationGroup("{namespace}.{operation}")`: Used to group operations into API actions. -- `@xVersionAdded("{version}")`: OpenSearch version when the operation/parameter was added. -- `@xVersionDeprecated("{version}")`: OpenSearch version when the operation/parameter was deprecated. -- `@xDeprecationDescription("{description}")`: Reason for deprecation and guidance on how to prepare for the next major version. -- `@xSerialize("bulk")`: Denotes that the request body should be serialized as bulk data. -- `@xDataType("{type}")`: Denotes the actual data-type of the parameters. This extension is used where a certain data-type is not supported by Smithy/OpenAPI (like `time`), or not supported in a certain context (like `enum` and `list` as **path** parameters). -- `@xEnumOptions(["{opt1}", "{opt2}", ...])`: List of options for an `enum` **path** parameter. -- `@xOverloadedParam("{param}")`: Denotes that the parameter is overloaded with another parameter. This is used in the `/_nodes/{node_id}` operation where you can also treat `{node_id}` as `{metric}`. Future operations should avoid this situation because it is bad API design. See [Client Generator Guide](./CLIENT_GENERATOR_GUIDE.md#overloaded-name) for more info. -- `@xIgnorable(true)`: Denotes that the operation should be ignored by the client generator. This is used in operation groups where some operations have been replaced by newer ones, but we still keep them in the specs because the server still supports them. - -```smithy -@xOperationGroup("search") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_search") -@documentation("Returns results matching a query.") -operation Search_Post_WithIndex { - input: Search_Post_WithIndex_Input, - output: Search_Output -} -``` - -```smithy -@xDataType("list") -@xEnumOptions(["settings", "os", "process", "jvm", "thread_pool", "transport", "http", "plugins", "ingest"]) -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless)") -@documentation("Comma-separated list of metrics you wish returned. Leave empty to return all.") -string PathNodesInfoMetric -``` - -```smithy -@xDataType("time") -@pattern("^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$") -@documentation("The maximum time to wait for wait_for_metadata_version before timing out.") -string WaitForTimeout -``` - -## Adding a test-case for API definition - -Once you've finished with the model API, follow the steps below to create a test-case. - -### File Structure for Test-folder - -Let's suppose we have test-cases for put mapping and search api at first. -Structure of the test folder's project tree: -``` -test - ├── scripts - └── model - ├── _global - │ └── search - │ ├── hooks.js - │ └── OpenSearchModel.json - └── indices - └── put_mapping - ├── hooks.js - └── OpenSearchModel.json -``` - -We'd want to include the *Index-Aliases API* now. -The project-tree structure will be as follows: -``` -test - ├── scripts - └── model - ├── _global - │ └── search - │ ├── hooks.js - │ └── OpenSearchModel.json - └── indices - ├── put_mapping - │ ├── hooks.js - │ └── OpenSearchModel.json - └── aliases - ├── hooks.js - └── OpenSearchModel.json -``` - -### Defining test-case for API model -Two files must be defined: - -1. OpenSearchModel.js: This is a json file that includes the API model's test-case. -- The steps to create this file are listed below. - - Move to the project-directory. - - Run ```cd test/scripts```. - - Run ```python operation-filter.py --operation --output ```. - In case of the Index-aliases API, for example ```python operation-filter.py --operation PostAliases --output /Users/xxx-xxx/Desktop/```. - - When the preceding step is completed successfully, a file named ```model.openapi.json``` will be generated in the defined directory. - Copy the contents of the file into the ```OpenSearchModel.json``` file. - -2. hooks.js: This file contains the API model's setup and teardown procedures. - -NOTE: -1. The arguments ```--operation``` and ```--output``` are necessary. -2. For the ```--output``` parameter, provide the full directory path. - -References: -If you're having trouble while writing API test cases, check out the [Index Aliases API](https://github.com/opensearch-project/opensearch-api-specification/pull/41/files). +To group these operations together in the `search` action, we mark them with the `x-operation-group` extension with the same value of `search`. The value of `x-operation-group` is a string that follows the format `[namespace].[action]`, except for the `_core` namespace where the namespace is omitted. For example, the `search` action in the `_core` namespace will have the `x-operation-group` value of `search`, and the `create` action in the `indices` namespace will have the `x-operation-group` value of `indices.create`. -## Local testing -The procedures outlined here will assist you in ensuring that the API model accurately represents the OpenAPI specification while testing it against the API's backend implementation. To do so, follow the steps below. +Note that this extension tells the client generators that these operations serve identical purpose and should be grouped together in the same API method. This extension also tells the generators the namespace and the name of the API method. For example, operations with `x-operation-group` value of `indicies.create` will result in `client.indices.create()` method to be generated, while operation group of `search` will result in `client.search()` as it's part of the `_core` namespace. -### Pre-requisite -- [Install and set-up docker](https://docs.docker.com/get-docker/) -- [Install dredd](https://dredd.org/en/latest/installation.html#installing-dredd) +For this reason, every operation MUST be accompanied by the `x-operation-group` extension, and operations in the same group MUST have identical descriptions, request and response bodies, and querystring parameters. -### Testing model API -Following the instructions below will allow you to test the API documentation locally. -1. In Docker go-to Preferences > Resources, set RAM to at least 4 GB. -2. Move to project directory then run ```cd test/```. -3. Install all node-modules using ```npm install```. -4. Install all python dependencies using ```pipenv install --system```. -5. Run docker using ```docker-compose up -d```. -6. Wait for around 1 minute (for opensearch domain to be operational). -7. Run ```cd scripts/```. +## Grouping Schemas -We are ready with the setup now, for finally testing our API implementation use below commands: +Schemas are grouped by categories to keep their names short and aid in client generation: +- `_common` category holds the common schemas that are used across multiple namespaces and features. +- `_common.` category holds the common schemas of a specific sub_category. (e.g. `_common.mapping`) +- `._common` category holds the common schemas of a specific namespace. (e.g. `cat._common`, `_core._common`) +- `.` category holds the schemas of a specific sub_category of a namespace. (e.g. `cat.aliases`, `_core.search`) -1. To test API implementation on default endpoint and all APIs. -- Run ```python driver-code.py``` -2. To test API implementation on default endpoint and specific API. -- Run ```python driver-code.py --testname ```. -3. To test all the APIs implementation with custom OpenSearch service endpoint. -- Run ```python driver-code.py --endpoint --user :```. -4. To test API implementation with custom OpenSearch service endpoint and specific APIs. -- Run ```python driver-code.py --endpoint --user : --path ```. +## OpenAPI Extensions -Arguments supported while testing are mentioned below: -1. *--endpoint:* (String) To specific the custom OpenSearch service URL for testing. -2. *--user:* (String) To specify the username and password associated with the endpoint used. -3. *--path:* (String) To specify the directory path of specific test to be tested. -4. *--testname:* (String) To specify the name of API to be tested if not provided then all the tests are run. -5. *--testpass:* (Boolean) When this option is set to True, a table of passed test cases will be printed as well. - (By default, only the table for failed test-cases is printed.) +This repository includes several penAPI Specification Extensions to fill in any metadata not directly supported OpenAPI: +- `x-operation-group`: Used to group operations into API actions. +- `x-version-added`: OpenSearch version when the operation/parameter was added. +- `x-version-deprecated`: OpenSearch version when the operation/parameter was deprecated. +- `x-version-removed`: OpenSearch version when the operation/parameter was removed. +- `x-deprecation-message`: Reason for deprecation and guidance on how to prepare for the next major version. +- `x-ignorable`: Denotes that the operation should be ignored by the client generator. This is used in operation groups where some operations have been replaced by newer ones, but we still keep them in the specs because the server still supports them. -NOTE: -Due to Ubuntu security updates, the version of Ubuntu mentioned in the CI workflow file may not be compatible with the Continuous Integration framework. +## Linting +[WORK IN PROGRESS] +We are working on a linter that will validate every `yaml` file in the `./spec` folder to assure that they follow the guidelines we have set. The linter will be run on every pull request to make sure that the changes are in line with the guidelines. diff --git a/OpenSearch.openapi.json b/OpenSearch.openapi.json deleted file mode 100644 index 5a5d33b9..00000000 --- a/OpenSearch.openapi.json +++ /dev/null @@ -1,35949 +0,0 @@ -{ - "openapi": "3.0.2", - "info": { - "title": "OpenSearch", - "version": "2021-11-23" - }, - "paths": { - "/": { - "get": { - "description": "Returns basic information about the cluster.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "Info", - "responses": { - "200": { - "description": "Info 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoResponseContent" - } - } - } - } - }, - "x-operation-group": "info", - "x-version-added": "1.0" - }, - "head": { - "description": "Returns whether the cluster is running.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "Ping", - "responses": { - "200": { - "description": "Ping 200 response" - } - }, - "x-operation-group": "ping", - "x-version-added": "1.0" - } - }, - "/_alias": { - "get": { - "description": "Returns an alias.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/im-plugin/index-alias/" - }, - "operationId": "IndicesGetAlias", - "parameters": [ - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetAlias 200 response" - } - }, - "x-operation-group": "indices.get_alias", - "x-version-added": "1.0" - } - }, - "/_alias/{name}": { - "get": { - "description": "Returns an alias.", - "operationId": "IndicesGetAlias_WithName", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Comma-separated list of alias names.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of alias names.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetAlias_WithName 200 response" - } - }, - "x-operation-group": "indices.get_alias", - "x-version-added": "1.0" - }, - "head": { - "description": "Returns information about whether a particular alias exists.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesExistsAlias", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Comma-separated list of alias names.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of alias names.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "IndicesExistsAlias 200 response" - } - }, - "x-operation-group": "indices.exists_alias", - "x-version-added": "1.0" - } - }, - "/_aliases": { - "post": { - "description": "Updates index aliases.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/alias/" - }, - "operationId": "IndicesUpdateAliases", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesUpdateAliases_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesUpdateAliases 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesUpdateAliasesResponseContent" - } - } - } - } - }, - "x-operation-group": "indices.update_aliases", - "x-version-added": "1.0" - } - }, - "/_analyze": { - "get": { - "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/" - }, - "operationId": "IndicesAnalyze_Get", - "parameters": [ - { - "name": "index", - "in": "query", - "description": "The name of the index to scope the operation.", - "schema": { - "type": "string", - "description": "The name of the index to scope the operation." - } - } - ], - "responses": { - "200": { - "description": "IndicesAnalyze_Get 200 response" - } - }, - "x-operation-group": "indices.analyze", - "x-version-added": "1.0" - }, - "post": { - "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", - "operationId": "IndicesAnalyze_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesAnalyze_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "query", - "description": "The name of the index to scope the operation.", - "schema": { - "type": "string", - "description": "The name of the index to scope the operation." - } - } - ], - "responses": { - "200": { - "description": "IndicesAnalyze_Post 200 response" - } - }, - "x-operation-group": "indices.analyze", - "x-version-added": "1.0" - } - }, - "/_bulk": { - "post": { - "description": "Allows to perform multiple index/update/delete operations in a single request.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/document-apis/bulk/" - }, - "operationId": "Bulk_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Bulk_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the 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).", - "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the 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": "refresh", - "in": "query", - "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.", - "schema": { - "$ref": "#/components/schemas/RefreshEnum" - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "type", - "in": "query", - "description": "Default document type for items which don't provide one.", - "schema": { - "type": "string", - "description": "Default document type for items which don't provide one." - } - }, - { - "name": "_source", - "in": "query", - "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.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "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." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request." - }, - "explode": true - }, - { - "name": "pipeline", - "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", - "schema": { - "type": "string", - "description": "The pipeline id to preprocess incoming documents with." - } - }, - { - "name": "require_alias", - "in": "query", - "description": "Sets require_alias for all incoming documents.", - "schema": { - "type": "boolean", - "default": false, - "description": "Sets require_alias for all incoming documents." - } - } - ], - "responses": { - "200": { - "description": "Bulk_Post 200 response" - } - }, - "x-operation-group": "bulk", - "x-version-added": "1.0" - }, - "put": { - "description": "Allows to perform multiple index/update/delete operations in a single request.", - "operationId": "Bulk_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Bulk_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the 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).", - "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the 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": "refresh", - "in": "query", - "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.", - "schema": { - "$ref": "#/components/schemas/RefreshEnum" - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "type", - "in": "query", - "description": "Default document type for items which don't provide one.", - "schema": { - "type": "string", - "description": "Default document type for items which don't provide one." - } - }, - { - "name": "_source", - "in": "query", - "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.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "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." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request." - }, - "explode": true - }, - { - "name": "pipeline", - "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", - "schema": { - "type": "string", - "description": "The pipeline id to preprocess incoming documents with." - } - }, - { - "name": "require_alias", - "in": "query", - "description": "Sets require_alias for all incoming documents.", - "schema": { - "type": "boolean", - "default": false, - "description": "Sets require_alias for all incoming documents." - } - } - ], - "responses": { - "200": { - "description": "Bulk_Put 200 response" - } - }, - "x-operation-group": "bulk", - "x-version-added": "1.0" - } - }, - "/_cache/clear": { - "post": { - "description": "Clears all or specific caches for one or more indices.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/" - }, - "operationId": "IndicesClearCache", - "parameters": [ - { - "name": "fielddata", - "in": "query", - "description": "Clear field data.", - "schema": { - "type": "boolean", - "description": "Clear field data." - } - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields to clear when using the `fielddata` parameter (default: all).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to clear when using the `fielddata` parameter (default: all)." - }, - "explode": true - }, - { - "name": "query", - "in": "query", - "description": "Clear query caches.", - "schema": { - "type": "boolean", - "description": "Clear query caches." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "index", - "in": "query", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices." - }, - "explode": true - }, - { - "name": "request", - "in": "query", - "description": "Clear request cache.", - "schema": { - "type": "boolean", - "description": "Clear request cache." - } - } - ], - "responses": { - "200": { - "description": "IndicesClearCache 200 response" - } - }, - "x-operation-group": "indices.clear_cache", - "x-version-added": "1.0" - } - }, - "/_cat": { - "get": { - "description": "Returns help for the Cat APIs.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/index/" - }, - "operationId": "CatHelp", - "parameters": [ - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - } - ], - "responses": { - "200": { - "description": "CatHelp 200 response" - } - }, - "x-operation-group": "cat.help", - "x-version-added": "1.0" - } - }, - "/_cat/aliases": { - "get": { - "description": "Shows information about currently configured aliases to indices including filter and routing infos.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/" - }, - "operationId": "CatAliases", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "CatAliases 200 response" - } - }, - "x-operation-group": "cat.aliases", - "x-version-added": "1.0" - } - }, - "/_cat/aliases/{name}": { - "get": { - "description": "Shows information about currently configured aliases to indices including filter and routing infos.", - "operationId": "CatAliases_WithName", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Comma-separated list of alias names.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of alias names.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "CatAliases_WithName 200 response" - } - }, - "x-operation-group": "cat.aliases", - "x-version-added": "1.0" - } - }, - "/_cat/allocation": { - "get": { - "description": "Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/" - }, - "operationId": "CatAllocation", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatAllocation 200 response" - } - }, - "x-operation-group": "cat.allocation", - "x-version-added": "1.0" - } - }, - "/_cat/allocation/{node_id}": { - "get": { - "description": "Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.", - "operationId": "CatAllocation_WithNodeId", - "parameters": [ - { - "name": "node_id", - "in": "path", - "description": "Comma-separated list of node IDs or names to limit the returned information.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of node IDs or names to limit the returned information.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatAllocation_WithNodeId 200 response" - } - }, - "x-operation-group": "cat.allocation", - "x-version-added": "1.0" - } - }, - "/_cat/cluster_manager": { - "get": { - "description": "Returns information about the cluster-manager node.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/" - }, - "operationId": "CatClusterManager", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatClusterManager 200 response" - } - }, - "x-operation-group": "cat.cluster_manager", - "x-version-added": "2.0" - } - }, - "/_cat/count": { - "get": { - "description": "Provides quick access to the document count of the entire cluster, or individual indices.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-count/" - }, - "operationId": "CatCount", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatCount 200 response" - } - }, - "x-operation-group": "cat.count", - "x-version-added": "1.0" - } - }, - "/_cat/count/{index}": { - "get": { - "description": "Provides quick access to the document count of the entire cluster, or individual indices.", - "operationId": "CatCount_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to limit the returned information.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to limit the returned information.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatCount_WithIndex 200 response" - } - }, - "x-operation-group": "cat.count", - "x-version-added": "1.0" - } - }, - "/_cat/fielddata": { - "get": { - "description": "Shows how much heap memory is currently being used by fielddata on every data node in the cluster.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/" - }, - "operationId": "CatFielddata", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields to return in the output.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return in the output." - }, - "explode": true - } - ], - "responses": { - "200": { - "description": "CatFielddata 200 response" - } - }, - "x-operation-group": "cat.fielddata", - "x-version-added": "1.0" - } - }, - "/_cat/fielddata/{fields}": { - "get": { - "description": "Shows how much heap memory is currently being used by fielddata on every data node in the cluster.", - "operationId": "CatFielddata_WithFields", - "parameters": [ - { - "name": "fields", - "in": "path", - "description": "Comma-separated list of fields to return the fielddata size.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of fields to return the fielddata size.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields to return in the output.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return in the output." - }, - "explode": true - } - ], - "responses": { - "200": { - "description": "CatFielddata_WithFields 200 response" - } - }, - "x-operation-group": "cat.fielddata", - "x-version-added": "1.0" - } - }, - "/_cat/health": { - "get": { - "description": "Returns a concise representation of the cluster health.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-health/" - }, - "operationId": "CatHealth", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "time", - "in": "query", - "description": "The unit in which to display time values.", - "schema": { - "$ref": "#/components/schemas/Time" - } - }, - { - "name": "ts", - "in": "query", - "description": "Set to false to disable timestamping.", - "schema": { - "type": "boolean", - "default": true, - "description": "Set to false to disable timestamping." - } - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatHealth 200 response" - } - }, - "x-operation-group": "cat.health", - "x-version-added": "1.0" - } - }, - "/_cat/indices": { - "get": { - "description": "Returns information about indices: number of primaries and replicas, document counts, disk size, ...", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-indices/" - }, - "operationId": "CatIndices", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "health", - "in": "query", - "description": "Health status ('green', 'yellow', or 'red') to filter only indices matching the specified health status.", - "schema": { - "$ref": "#/components/schemas/Health" - } - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "pri", - "in": "query", - "description": "Set to true to return stats only for primary shards.", - "schema": { - "type": "boolean", - "default": false, - "description": "Set to true to return stats only for primary shards." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "time", - "in": "query", - "description": "The unit in which to display time values.", - "schema": { - "$ref": "#/components/schemas/Time" - } - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - }, - { - "name": "include_unloaded_segments", - "in": "query", - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory.", - "schema": { - "type": "boolean", - "default": false, - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "CatIndices 200 response" - } - }, - "x-operation-group": "cat.indices", - "x-version-added": "1.0" - } - }, - "/_cat/indices/{index}": { - "get": { - "description": "Returns information about indices: number of primaries and replicas, document counts, disk size, ...", - "operationId": "CatIndices_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to limit the returned information.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to limit the returned information.", - "x-data-type": "array" - }, - "required": true, - "examples": { - "CatIndices_WithIndex_example1": { - "summary": "Examples for Cat indices with Index Operation.", - "description": "", - "value": "books" - } - } - }, - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "health", - "in": "query", - "description": "Health status ('green', 'yellow', or 'red') to filter only indices matching the specified health status.", - "schema": { - "$ref": "#/components/schemas/Health" - } - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "pri", - "in": "query", - "description": "Set to true to return stats only for primary shards.", - "schema": { - "type": "boolean", - "default": false, - "description": "Set to true to return stats only for primary shards." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "time", - "in": "query", - "description": "The unit in which to display time values.", - "schema": { - "$ref": "#/components/schemas/Time" - } - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - }, - { - "name": "include_unloaded_segments", - "in": "query", - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory.", - "schema": { - "type": "boolean", - "default": false, - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "CatIndices_WithIndex 200 response" - } - }, - "x-operation-group": "cat.indices", - "x-version-added": "1.0" - } - }, - "/_cat/master": { - "get": { - "description": "Returns information about the cluster-manager node.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/" - }, - "operationId": "CatMaster", - "deprecated": true, - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatMaster 200 response" - } - }, - "x-deprecation-message": "To promote inclusive language, please use '/_cat/cluster_manager' instead.", - "x-operation-group": "cat.master", - "x-version-added": "1.0", - "x-version-deprecated": "2.0" - } - }, - "/_cat/nodeattrs": { - "get": { - "description": "Returns information about custom node attributes.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/" - }, - "operationId": "CatNodeattrs", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatNodeattrs 200 response" - } - }, - "x-operation-group": "cat.nodeattrs", - "x-version-added": "1.0" - } - }, - "/_cat/nodes": { - "get": { - "description": "Returns basic statistics about performance of cluster nodes.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/" - }, - "operationId": "CatNodes", - "parameters": [ - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - }, - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "full_id", - "in": "query", - "description": "Return the full node ID instead of the shortened version.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return the full node ID instead of the shortened version." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "x-version-deprecated": "1.0", - "x-deprecation-message": "This parameter does not cause this API to act locally.", - "deprecated": true - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "time", - "in": "query", - "description": "The unit in which to display time values.", - "schema": { - "$ref": "#/components/schemas/Time" - } - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatNodes 200 response" - } - }, - "x-operation-group": "cat.nodes", - "x-version-added": "1.0" - } - }, - "/_cat/pending_tasks": { - "get": { - "description": "Returns a concise representation of the cluster pending tasks.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/" - }, - "operationId": "CatPendingTasks", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "time", - "in": "query", - "description": "The unit in which to display time values.", - "schema": { - "$ref": "#/components/schemas/Time" - } - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatPendingTasks 200 response" - } - }, - "x-operation-group": "cat.pending_tasks", - "x-version-added": "1.0" - } - }, - "/_cat/pit_segments": { - "get": { - "description": "List segments for one or several PITs.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/" - }, - "operationId": "CatPitSegments", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CatPitSegments_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - }, - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - } - ], - "responses": { - "200": { - "description": "CatPitSegments 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CatPitSegmentsOutputPayload" - } - } - } - } - }, - "x-operation-group": "cat.pit_segments", - "x-version-added": "2.4" - } - }, - "/_cat/pit_segments/_all": { - "get": { - "description": "Lists all active point-in-time segments.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/" - }, - "operationId": "CatAllPitSegments", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - }, - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - } - ], - "responses": { - "200": { - "description": "CatAllPitSegments 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CatAllPitSegmentsOutputPayload" - } - } - } - } - }, - "x-operation-group": "cat.all_pit_segments", - "x-version-added": "2.4" - } - }, - "/_cat/plugins": { - "get": { - "description": "Returns information about installed plugins across nodes node.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/" - }, - "operationId": "CatPlugins", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatPlugins 200 response" - } - }, - "x-operation-group": "cat.plugins", - "x-version-added": "1.0" - } - }, - "/_cat/recovery": { - "get": { - "description": "Returns information about index shard recoveries, both on-going completed.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/" - }, - "operationId": "CatRecovery", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "active_only", - "in": "query", - "description": "If `true`, the response only includes ongoing shard recoveries.", - "schema": { - "type": "boolean", - "default": false, - "description": "If `true`, the response only includes ongoing shard recoveries." - } - }, - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - }, - { - "name": "detailed", - "in": "query", - "description": "If `true`, the response includes detailed information about shard recoveries.", - "schema": { - "type": "boolean", - "default": false, - "description": "If `true`, the response includes detailed information about shard recoveries." - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "index", - "in": "query", - "description": "Comma-separated list or wildcard expression of index names to limit the returned information.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list or wildcard expression of index names to limit the returned information." - }, - "explode": true - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "time", - "in": "query", - "description": "The unit in which to display time values.", - "schema": { - "$ref": "#/components/schemas/Time" - } - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatRecovery 200 response" - } - }, - "x-operation-group": "cat.recovery", - "x-version-added": "1.0" - } - }, - "/_cat/recovery/{index}": { - "get": { - "description": "Returns information about index shard recoveries, both on-going completed.", - "operationId": "CatRecovery_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list or wildcard expression of index names to limit the returned information.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list or wildcard expression of index names to limit the returned information.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "active_only", - "in": "query", - "description": "If `true`, the response only includes ongoing shard recoveries.", - "schema": { - "type": "boolean", - "default": false, - "description": "If `true`, the response only includes ongoing shard recoveries." - } - }, - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - }, - { - "name": "detailed", - "in": "query", - "description": "If `true`, the response includes detailed information about shard recoveries.", - "schema": { - "type": "boolean", - "default": false, - "description": "If `true`, the response includes detailed information about shard recoveries." - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "index", - "in": "query", - "description": "Comma-separated list or wildcard expression of index names to limit the returned information.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list or wildcard expression of index names to limit the returned information." - }, - "explode": true - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "time", - "in": "query", - "description": "The unit in which to display time values.", - "schema": { - "$ref": "#/components/schemas/Time" - } - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatRecovery_WithIndex 200 response" - } - }, - "x-operation-group": "cat.recovery", - "x-version-added": "1.0" - } - }, - "/_cat/repositories": { - "get": { - "description": "Returns information about snapshot repositories registered in the cluster.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/" - }, - "operationId": "CatRepositories", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatRepositories 200 response" - } - }, - "x-operation-group": "cat.repositories", - "x-version-added": "1.0" - } - }, - "/_cat/segment_replication": { - "get": { - "description": "Returns information about both on-going and latest completed Segment Replication events.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/" - }, - "operationId": "CatSegmentReplication", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "active_only", - "in": "query", - "description": "If `true`, the response only includes ongoing segment replication events.", - "schema": { - "type": "boolean", - "default": false, - "description": "If `true`, the response only includes ongoing segment replication events." - } - }, - { - "name": "completed_only", - "in": "query", - "description": "If `true`, the response only includes latest completed segment replication events.", - "schema": { - "type": "boolean", - "default": false, - "description": "If `true`, the response only includes latest completed segment replication events." - } - }, - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - }, - { - "name": "detailed", - "in": "query", - "description": "If `true`, the response includes detailed information about segment replications.", - "schema": { - "type": "boolean", - "default": false, - "description": "If `true`, the response includes detailed information about segment replications." - } - }, - { - "name": "shards", - "in": "query", - "description": "Comma-separated list of shards to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of shards to display." - }, - "explode": true - }, - { - "name": "index", - "in": "query", - "description": "Comma-separated list or wildcard expression of index names to limit the returned information.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list or wildcard expression of index names to limit the returned information." - }, - "explode": true - }, - { - "name": "time", - "in": "query", - "description": "The unit in which to display time values.", - "schema": { - "$ref": "#/components/schemas/Time" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "CatSegmentReplication 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CatSegmentReplicationOutputPayload" - } - } - } - } - }, - "x-operation-group": "cat.segment_replication", - "x-version-added": "2.6.0" - } - }, - "/_cat/segment_replication/{index}": { - "get": { - "description": "Returns information about both on-going and latest completed Segment Replication events.", - "operationId": "CatSegmentReplication_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list or wildcard expression of index names to limit the returned information.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list or wildcard expression of index names to limit the returned information.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "active_only", - "in": "query", - "description": "If `true`, the response only includes ongoing segment replication events.", - "schema": { - "type": "boolean", - "default": false, - "description": "If `true`, the response only includes ongoing segment replication events." - } - }, - { - "name": "completed_only", - "in": "query", - "description": "If `true`, the response only includes latest completed segment replication events.", - "schema": { - "type": "boolean", - "default": false, - "description": "If `true`, the response only includes latest completed segment replication events." - } - }, - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - }, - { - "name": "detailed", - "in": "query", - "description": "If `true`, the response includes detailed information about segment replications.", - "schema": { - "type": "boolean", - "default": false, - "description": "If `true`, the response includes detailed information about segment replications." - } - }, - { - "name": "shards", - "in": "query", - "description": "Comma-separated list of shards to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of shards to display." - }, - "explode": true - }, - { - "name": "index", - "in": "query", - "description": "Comma-separated list or wildcard expression of index names to limit the returned information.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list or wildcard expression of index names to limit the returned information." - }, - "explode": true - }, - { - "name": "time", - "in": "query", - "description": "The unit in which to display time values.", - "schema": { - "$ref": "#/components/schemas/Time" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "CatSegmentReplication_WithIndex 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CatSegmentReplication_WithIndexOutputPayload" - } - } - } - } - }, - "x-operation-group": "cat.segment_replication", - "x-version-added": "2.6.0" - } - }, - "/_cat/segments": { - "get": { - "description": "Provides low-level information about the segments in the shards of an index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-segments/" - }, - "operationId": "CatSegments", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatSegments 200 response" - } - }, - "x-operation-group": "cat.segments", - "x-version-added": "1.0" - } - }, - "/_cat/segments/{index}": { - "get": { - "description": "Provides low-level information about the segments in the shards of an index.", - "operationId": "CatSegments_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to limit the returned information.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to limit the returned information.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatSegments_WithIndex 200 response" - } - }, - "x-operation-group": "cat.segments", - "x-version-added": "1.0" - } - }, - "/_cat/shards": { - "get": { - "description": "Provides a detailed view of shard allocation on nodes.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-shards/" - }, - "operationId": "CatShards", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "time", - "in": "query", - "description": "The unit in which to display time values.", - "schema": { - "$ref": "#/components/schemas/Time" - } - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatShards 200 response" - } - }, - "x-operation-group": "cat.shards", - "x-version-added": "1.0" - } - }, - "/_cat/shards/{index}": { - "get": { - "description": "Provides a detailed view of shard allocation on nodes.", - "operationId": "CatShards_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to limit the returned information.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to limit the returned information.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "bytes", - "in": "query", - "description": "The unit in which to display byte values.", - "schema": { - "$ref": "#/components/schemas/Bytes" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "time", - "in": "query", - "description": "The unit in which to display time values.", - "schema": { - "$ref": "#/components/schemas/Time" - } - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatShards_WithIndex 200 response" - } - }, - "x-operation-group": "cat.shards", - "x-version-added": "1.0" - } - }, - "/_cat/snapshots": { - "get": { - "description": "Returns all snapshots in a specific repository.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/" - }, - "operationId": "CatSnapshots", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "time", - "in": "query", - "description": "The unit in which to display time values.", - "schema": { - "$ref": "#/components/schemas/Time" - } - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatSnapshots 200 response" - } - }, - "x-operation-group": "cat.snapshots", - "x-version-added": "1.0" - } - }, - "/_cat/snapshots/{repository}": { - "get": { - "description": "Returns all snapshots in a specific repository.", - "operationId": "CatSnapshots_WithRepository", - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Comma-separated list of repository names.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of repository names.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "time", - "in": "query", - "description": "The unit in which to display time values.", - "schema": { - "$ref": "#/components/schemas/Time" - } - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatSnapshots_WithRepository 200 response" - } - }, - "x-operation-group": "cat.snapshots", - "x-version-added": "1.0" - } - }, - "/_cat/tasks": { - "get": { - "description": "Returns information about the tasks currently executing on one or more nodes in the cluster.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/" - }, - "operationId": "CatTasks", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "nodes", - "in": "query", - "description": "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.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "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." - }, - "explode": true - }, - { - "name": "actions", - "in": "query", - "description": "Comma-separated list of actions that should be returned. Leave empty to return all.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of actions that should be returned. Leave empty to return all." - }, - "explode": true - }, - { - "name": "detailed", - "in": "query", - "description": "Return detailed task information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return detailed task information." - } - }, - { - "name": "parent_task_id", - "in": "query", - "description": "Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.", - "schema": { - "type": "string", - "description": "Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all." - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "time", - "in": "query", - "description": "The unit in which to display time values.", - "schema": { - "$ref": "#/components/schemas/Time" - } - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatTasks 200 response" - } - }, - "x-operation-group": "cat.tasks", - "x-version-added": "1.0" - } - }, - "/_cat/templates": { - "get": { - "description": "Returns information about existing templates.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-templates/" - }, - "operationId": "CatTemplates", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatTemplates 200 response" - } - }, - "x-operation-group": "cat.templates", - "x-version-added": "1.0" - } - }, - "/_cat/templates/{name}": { - "get": { - "description": "Returns information about existing templates.", - "operationId": "CatTemplates_WithName", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the template.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the template." - }, - "required": true - }, - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatTemplates_WithName 200 response" - } - }, - "x-operation-group": "cat.templates", - "x-version-added": "1.0" - } - }, - "/_cat/thread_pool": { - "get": { - "description": "Returns cluster-wide thread pool statistics per node.\nBy default the active, queue and rejected statistics are returned for all thread pools.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/" - }, - "operationId": "CatThreadPool", - "parameters": [ - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "size", - "in": "query", - "description": "The multiplier in which to display values.", - "schema": { - "type": "integer", - "description": "The multiplier in which to display values.", - "format": "int32" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatThreadPool 200 response" - } - }, - "x-operation-group": "cat.thread_pool", - "x-version-added": "1.0" - } - }, - "/_cat/thread_pool/{thread_pool_patterns}": { - "get": { - "description": "Returns cluster-wide thread pool statistics per node.\nBy default the active, queue and rejected statistics are returned for all thread pools.", - "operationId": "CatThreadPool_WithThreadPoolPatterns", - "parameters": [ - { - "name": "thread_pool_patterns", - "in": "path", - "description": "Comma-separated list of regular-expressions to filter the thread pools in the output.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of regular-expressions to filter the thread pools in the output.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "format", - "in": "query", - "description": "A short version of the Accept header, e.g. json, yaml.", - "schema": { - "type": "string", - "description": "A short version of the Accept header, e.g. json, yaml." - } - }, - { - "name": "size", - "in": "query", - "description": "The multiplier in which to display values.", - "schema": { - "type": "integer", - "description": "The multiplier in which to display values.", - "format": "int32" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "h", - "in": "query", - "description": "Comma-separated list of column names to display.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names to display." - }, - "explode": true - }, - { - "name": "help", - "in": "query", - "description": "Return help information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return help information." - } - }, - { - "name": "s", - "in": "query", - "description": "Comma-separated list of column names or column aliases to sort by.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of column names or column aliases to sort by." - }, - "explode": true - }, - { - "name": "v", - "in": "query", - "description": "Verbose mode. Display column headers.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display column headers." - } - } - ], - "responses": { - "200": { - "description": "CatThreadPool_WithThreadPoolPatterns 200 response" - } - }, - "x-operation-group": "cat.thread_pool", - "x-version-added": "1.0" - } - }, - "/_cluster/allocation/explain": { - "get": { - "description": "Provides explanations for shard allocations in the cluster.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/" - }, - "operationId": "ClusterAllocationExplain_Get", - "parameters": [ - { - "name": "include_yes_decisions", - "in": "query", - "description": "Return 'YES' decisions in explanation.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return 'YES' decisions in explanation." - } - }, - { - "name": "include_disk_info", - "in": "query", - "description": "Return information about disk usage and shard sizes.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return information about disk usage and shard sizes." - } - } - ], - "responses": { - "200": { - "description": "ClusterAllocationExplain_Get 200 response" - } - }, - "x-operation-group": "cluster.allocation_explain", - "x-version-added": "1.0" - }, - "post": { - "description": "Provides explanations for shard allocations in the cluster.", - "operationId": "ClusterAllocationExplain_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClusterAllocationExplain_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "include_yes_decisions", - "in": "query", - "description": "Return 'YES' decisions in explanation.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return 'YES' decisions in explanation." - } - }, - { - "name": "include_disk_info", - "in": "query", - "description": "Return information about disk usage and shard sizes.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return information about disk usage and shard sizes." - } - } - ], - "responses": { - "200": { - "description": "ClusterAllocationExplain_Post 200 response" - } - }, - "x-operation-group": "cluster.allocation_explain", - "x-version-added": "1.0" - } - }, - "/_cluster/decommission/awareness": { - "delete": { - "description": "Delete any existing decommission.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone" - }, - "operationId": "ClusterDeleteDecommissionAwareness", - "responses": { - "200": { - "description": "ClusterDeleteDecommissionAwareness 200 response" - } - }, - "x-operation-group": "cluster.delete_decommission_awareness", - "x-version-added": "1.0" - } - }, - "/_cluster/decommission/awareness/{awareness_attribute_name}/_status": { - "get": { - "description": "Get details and status of decommissioned attribute.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-getting-zone-decommission-status" - }, - "operationId": "ClusterGetDecommissionAwareness", - "parameters": [ - { - "name": "awareness_attribute_name", - "in": "path", - "description": "Awareness attribute name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Awareness attribute name." - }, - "required": true - } - ], - "responses": { - "200": { - "description": "ClusterGetDecommissionAwareness 200 response" - } - }, - "x-operation-group": "cluster.get_decommission_awareness", - "x-version-added": "1.0" - } - }, - "/_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}": { - "put": { - "description": "Decommissions an awareness attribute.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone" - }, - "operationId": "ClusterPutDecommissionAwareness", - "parameters": [ - { - "name": "awareness_attribute_name", - "in": "path", - "description": "Awareness attribute name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Awareness attribute name." - }, - "required": true - }, - { - "name": "awareness_attribute_value", - "in": "path", - "description": "Awareness attribute value.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Awareness attribute value." - }, - "required": true - } - ], - "responses": { - "200": { - "description": "ClusterPutDecommissionAwareness 200 response" - } - }, - "x-operation-group": "cluster.put_decommission_awareness", - "x-version-added": "1.0" - } - }, - "/_cluster/health": { - "get": { - "description": "Returns basic information about the health of the cluster.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/" - }, - "operationId": "ClusterHealth", - "parameters": [ - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "level", - "in": "query", - "description": "Specify the level of detail for returned information.", - "schema": { - "$ref": "#/components/schemas/ClusterHealthLevel" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Wait until the specified number of shards is active.", - "schema": { - "type": "string", - "description": "Wait until the specified number of shards is active." - } - }, - { - "name": "wait_for_nodes", - "in": "query", - "description": "Wait until the specified number of nodes is available.", - "schema": { - "type": "string", - "description": "Wait until the specified number of nodes is available." - } - }, - { - "name": "wait_for_events", - "in": "query", - "description": "Wait until all currently queued events with the given priority are processed.", - "schema": { - "$ref": "#/components/schemas/WaitForEvents" - } - }, - { - "name": "wait_for_no_relocating_shards", - "in": "query", - "description": "Whether to wait until there are no relocating shards in the cluster.", - "schema": { - "type": "boolean", - "description": "Whether to wait until there are no relocating shards in the cluster." - } - }, - { - "name": "wait_for_no_initializing_shards", - "in": "query", - "description": "Whether to wait until there are no initializing shards in the cluster.", - "schema": { - "type": "boolean", - "description": "Whether to wait until there are no initializing shards in the cluster." - } - }, - { - "name": "wait_for_status", - "in": "query", - "description": "Wait until cluster is in a specific state.", - "schema": { - "$ref": "#/components/schemas/WaitForStatus" - } - }, - { - "name": "awareness_attribute", - "in": "query", - "description": "The awareness attribute for which the health is required.", - "schema": { - "type": "string", - "description": "The awareness attribute for which the health is required." - } - } - ], - "responses": { - "200": { - "description": "ClusterHealth 200 response" - } - }, - "x-operation-group": "cluster.health", - "x-version-added": "1.0" - } - }, - "/_cluster/health/{index}": { - "get": { - "description": "Returns basic information about the health of the cluster.", - "operationId": "ClusterHealth_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Limit the information returned to specific indicies.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Limit the information returned to specific indicies.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "level", - "in": "query", - "description": "Specify the level of detail for returned information.", - "schema": { - "$ref": "#/components/schemas/ClusterHealthLevel" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Wait until the specified number of shards is active.", - "schema": { - "type": "string", - "description": "Wait until the specified number of shards is active." - } - }, - { - "name": "wait_for_nodes", - "in": "query", - "description": "Wait until the specified number of nodes is available.", - "schema": { - "type": "string", - "description": "Wait until the specified number of nodes is available." - } - }, - { - "name": "wait_for_events", - "in": "query", - "description": "Wait until all currently queued events with the given priority are processed.", - "schema": { - "$ref": "#/components/schemas/WaitForEvents" - } - }, - { - "name": "wait_for_no_relocating_shards", - "in": "query", - "description": "Whether to wait until there are no relocating shards in the cluster.", - "schema": { - "type": "boolean", - "description": "Whether to wait until there are no relocating shards in the cluster." - } - }, - { - "name": "wait_for_no_initializing_shards", - "in": "query", - "description": "Whether to wait until there are no initializing shards in the cluster.", - "schema": { - "type": "boolean", - "description": "Whether to wait until there are no initializing shards in the cluster." - } - }, - { - "name": "wait_for_status", - "in": "query", - "description": "Wait until cluster is in a specific state.", - "schema": { - "$ref": "#/components/schemas/WaitForStatus" - } - }, - { - "name": "awareness_attribute", - "in": "query", - "description": "The awareness attribute for which the health is required.", - "schema": { - "type": "string", - "description": "The awareness attribute for which the health is required." - } - } - ], - "responses": { - "200": { - "description": "ClusterHealth_WithIndex 200 response" - } - }, - "x-operation-group": "cluster.health", - "x-version-added": "1.0" - } - }, - "/_cluster/nodes/hot_threads": { - "get": { - "description": "Returns information about hot threads on each node in the cluster.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/" - }, - "operationId": "NodesHotThreads_DeprecatedDash", - "deprecated": true, - "parameters": [ - { - "name": "interval", - "in": "query", - "description": "The interval for the second sampling of threads.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "The interval for the second sampling of threads.", - "x-data-type": "time" - } - }, - { - "name": "snapshots", - "in": "query", - "description": "Number of samples of thread stacktrace.", - "schema": { - "type": "integer", - "default": 10, - "description": "Number of samples of thread stacktrace.", - "format": "int32" - } - }, - { - "name": "threads", - "in": "query", - "description": "Specify the number of threads to provide information for.", - "schema": { - "type": "integer", - "default": 3, - "description": "Specify the number of threads to provide information for.", - "format": "int32" - } - }, - { - "name": "ignore_idle_threads", - "in": "query", - "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue.", - "schema": { - "type": "boolean", - "default": true, - "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue." - } - }, - { - "name": "type", - "in": "query", - "description": "The type to sample.", - "schema": { - "$ref": "#/components/schemas/SampleType" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesHotThreads_DeprecatedDash 200 response" - } - }, - "x-deprecation-message": "The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons", - "x-ignorable": true, - "x-operation-group": "nodes.hot_threads", - "x-version-added": "1.0", - "x-version-deprecated": "1.0" - } - }, - "/_cluster/nodes/hotthreads": { - "get": { - "description": "Returns information about hot threads on each node in the cluster.", - "operationId": "NodesHotThreads_DeprecatedCluster", - "deprecated": true, - "parameters": [ - { - "name": "interval", - "in": "query", - "description": "The interval for the second sampling of threads.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "The interval for the second sampling of threads.", - "x-data-type": "time" - } - }, - { - "name": "snapshots", - "in": "query", - "description": "Number of samples of thread stacktrace.", - "schema": { - "type": "integer", - "default": 10, - "description": "Number of samples of thread stacktrace.", - "format": "int32" - } - }, - { - "name": "threads", - "in": "query", - "description": "Specify the number of threads to provide information for.", - "schema": { - "type": "integer", - "default": 3, - "description": "Specify the number of threads to provide information for.", - "format": "int32" - } - }, - { - "name": "ignore_idle_threads", - "in": "query", - "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue.", - "schema": { - "type": "boolean", - "default": true, - "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue." - } - }, - { - "name": "type", - "in": "query", - "description": "The type to sample.", - "schema": { - "$ref": "#/components/schemas/SampleType" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesHotThreads_DeprecatedCluster 200 response" - } - }, - "x-deprecation-message": "The hot threads API accepts `hotthreads` but only `hot_threads` is documented", - "x-ignorable": true, - "x-operation-group": "nodes.hot_threads", - "x-version-added": "1.0", - "x-version-deprecated": "1.0" - } - }, - "/_cluster/nodes/{node_id}/hot_threads": { - "get": { - "description": "Returns information about hot threads on each node in the cluster.", - "operationId": "NodesHotThreads_WithNodeId_DeprecatedDash", - "deprecated": true, - "parameters": [ - { - "name": "node_id", - "in": "path", - "description": "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.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "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.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "interval", - "in": "query", - "description": "The interval for the second sampling of threads.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "The interval for the second sampling of threads.", - "x-data-type": "time" - } - }, - { - "name": "snapshots", - "in": "query", - "description": "Number of samples of thread stacktrace.", - "schema": { - "type": "integer", - "default": 10, - "description": "Number of samples of thread stacktrace.", - "format": "int32" - } - }, - { - "name": "threads", - "in": "query", - "description": "Specify the number of threads to provide information for.", - "schema": { - "type": "integer", - "default": 3, - "description": "Specify the number of threads to provide information for.", - "format": "int32" - } - }, - { - "name": "ignore_idle_threads", - "in": "query", - "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue.", - "schema": { - "type": "boolean", - "default": true, - "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue." - } - }, - { - "name": "type", - "in": "query", - "description": "The type to sample.", - "schema": { - "$ref": "#/components/schemas/SampleType" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesHotThreads_WithNodeId_DeprecatedDash 200 response" - } - }, - "x-deprecation-message": "The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons", - "x-ignorable": true, - "x-operation-group": "nodes.hot_threads", - "x-version-added": "1.0", - "x-version-deprecated": "1.0" - } - }, - "/_cluster/nodes/{node_id}/hotthreads": { - "get": { - "description": "Returns information about hot threads on each node in the cluster.", - "operationId": "NodesHotThreads_WithNodeId_DeprecatedCluster", - "deprecated": true, - "parameters": [ - { - "name": "node_id", - "in": "path", - "description": "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.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "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.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "interval", - "in": "query", - "description": "The interval for the second sampling of threads.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "The interval for the second sampling of threads.", - "x-data-type": "time" - } - }, - { - "name": "snapshots", - "in": "query", - "description": "Number of samples of thread stacktrace.", - "schema": { - "type": "integer", - "default": 10, - "description": "Number of samples of thread stacktrace.", - "format": "int32" - } - }, - { - "name": "threads", - "in": "query", - "description": "Specify the number of threads to provide information for.", - "schema": { - "type": "integer", - "default": 3, - "description": "Specify the number of threads to provide information for.", - "format": "int32" - } - }, - { - "name": "ignore_idle_threads", - "in": "query", - "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue.", - "schema": { - "type": "boolean", - "default": true, - "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue." - } - }, - { - "name": "type", - "in": "query", - "description": "The type to sample.", - "schema": { - "$ref": "#/components/schemas/SampleType" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesHotThreads_WithNodeId_DeprecatedCluster 200 response" - } - }, - "x-deprecation-message": "The hot threads API accepts `hotthreads` but only `hot_threads` is documented", - "x-ignorable": true, - "x-operation-group": "nodes.hot_threads", - "x-version-added": "1.0", - "x-version-deprecated": "1.0" - } - }, - "/_cluster/pending_tasks": { - "get": { - "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.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "ClusterPendingTasks", - "parameters": [ - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "ClusterPendingTasks 200 response" - } - }, - "x-operation-group": "cluster.pending_tasks", - "x-version-added": "1.0" - } - }, - "/_cluster/reroute": { - "post": { - "description": "Allows to manually change the allocation of individual shards in the cluster.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "ClusterReroute", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClusterReroute_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "dry_run", - "in": "query", - "description": "Simulate the operation only and return the resulting state.", - "schema": { - "type": "boolean", - "description": "Simulate the operation only and return the resulting state." - } - }, - { - "name": "explain", - "in": "query", - "description": "Return an explanation of why the commands can or cannot be executed.", - "schema": { - "type": "boolean", - "description": "Return an explanation of why the commands can or cannot be executed." - } - }, - { - "name": "retry_failed", - "in": "query", - "description": "Retries allocation of shards that are blocked due to too many subsequent allocation failures.", - "schema": { - "type": "boolean", - "description": "Retries allocation of shards that are blocked due to too many subsequent allocation failures." - } - }, - { - "name": "metric", - "in": "query", - "description": "Limit the information returned to the specified metrics. Defaults to all but metadata.", - "style": "form", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ClusterRerouteMetric_Member" - }, - "description": "Limit the information returned to the specified metrics. Defaults to all but metadata." - }, - "explode": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "ClusterReroute 200 response" - } - }, - "x-operation-group": "cluster.reroute", - "x-version-added": "1.0" - } - }, - "/_cluster/routing/awareness/weights": { - "delete": { - "description": "Delete weighted shard routing weights.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-deleting-weights" - }, - "operationId": "ClusterDeleteWeightedRouting", - "responses": { - "200": { - "description": "ClusterDeleteWeightedRouting 200 response" - } - }, - "x-operation-group": "cluster.delete_weighted_routing", - "x-version-added": "1.0" - } - }, - "/_cluster/routing/awareness/{attribute}/weights": { - "get": { - "description": "Fetches weighted shard routing weights.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-getting-weights-for-all-zones" - }, - "operationId": "ClusterGetWeightedRouting", - "parameters": [ - { - "name": "attribute", - "in": "path", - "description": "Awareness attribute name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Awareness attribute name." - }, - "required": true - } - ], - "responses": { - "200": { - "description": "ClusterGetWeightedRouting 200 response" - } - }, - "x-operation-group": "cluster.get_weighted_routing", - "x-version-added": "1.0" - }, - "put": { - "description": "Updates weighted shard routing weights.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-weighted-round-robin-search" - }, - "operationId": "ClusterPutWeightedRouting", - "parameters": [ - { - "name": "attribute", - "in": "path", - "description": "Awareness attribute name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Awareness attribute name." - }, - "required": true - } - ], - "responses": { - "200": { - "description": "ClusterPutWeightedRouting 200 response" - } - }, - "x-operation-group": "cluster.put_weighted_routing", - "x-version-added": "1.0" - } - }, - "/_cluster/settings": { - "get": { - "description": "Returns cluster settings.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/" - }, - "operationId": "ClusterGetSettings", - "parameters": [ - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "include_defaults", - "in": "query", - "description": "Whether to return all default clusters setting.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to return all default clusters setting." - }, - "examples": { - "ClusterGetSettings_example1": { - "summary": "Examples for Get cluster settings Operation.", - "description": "", - "value": true - } - } - } - ], - "responses": { - "200": { - "description": "ClusterGetSettings 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClusterGetSettingsResponseContent" - }, - "examples": { - "ClusterGetSettings_example1": { - "summary": "Examples for Get cluster settings Operation.", - "description": "", - "value": {} - } - } - } - } - } - }, - "x-operation-group": "cluster.get_settings", - "x-version-added": "1.0" - }, - "put": { - "description": "Updates the cluster settings.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cluster-settings/" - }, - "operationId": "ClusterPutSettings", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClusterPutSettings_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "ClusterPutSettings 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClusterPutSettingsResponseContent" - } - } - } - } - }, - "x-operation-group": "cluster.put_settings", - "x-version-added": "1.0" - } - }, - "/_cluster/state": { - "get": { - "description": "Returns a comprehensive information about the state of the cluster.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "ClusterState", - "parameters": [ - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "wait_for_metadata_version", - "in": "query", - "description": "Wait for the metadata version to be equal or greater than the specified metadata version.", - "schema": { - "type": "integer", - "description": "Wait for the metadata version to be equal or greater than the specified metadata version.", - "format": "int32" - } - }, - { - "name": "wait_for_timeout", - "in": "query", - "description": "The maximum time to wait for wait_for_metadata_version before timing out.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "The maximum time to wait for wait_for_metadata_version before timing out.", - "x-data-type": "time" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "ClusterState 200 response" - } - }, - "x-operation-group": "cluster.state", - "x-version-added": "1.0" - } - }, - "/_cluster/state/{metric}": { - "get": { - "description": "Returns a comprehensive information about the state of the cluster.", - "operationId": "ClusterState_WithMetric", - "parameters": [ - { - "name": "metric", - "in": "path", - "description": "Limit the information returned to the specified metrics.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Limit the information returned to the specified metrics.", - "x-enum-options": [ - "_all", - "blocks", - "metadata", - "nodes", - "routing_table", - "routing_nodes", - "master_node", - "cluster_manager_node", - "version" - ], - "x-data-type": "array" - }, - "required": true - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "wait_for_metadata_version", - "in": "query", - "description": "Wait for the metadata version to be equal or greater than the specified metadata version.", - "schema": { - "type": "integer", - "description": "Wait for the metadata version to be equal or greater than the specified metadata version.", - "format": "int32" - } - }, - { - "name": "wait_for_timeout", - "in": "query", - "description": "The maximum time to wait for wait_for_metadata_version before timing out.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "The maximum time to wait for wait_for_metadata_version before timing out.", - "x-data-type": "time" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "ClusterState_WithMetric 200 response" - } - }, - "x-operation-group": "cluster.state", - "x-version-added": "1.0" - } - }, - "/_cluster/state/{metric}/{index}": { - "get": { - "description": "Returns a comprehensive information about the state of the cluster.", - "operationId": "ClusterState_WithIndexMetric", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "metric", - "in": "path", - "description": "Limit the information returned to the specified metrics.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Limit the information returned to the specified metrics.", - "x-enum-options": [ - "_all", - "blocks", - "metadata", - "nodes", - "routing_table", - "routing_nodes", - "master_node", - "cluster_manager_node", - "version" - ], - "x-data-type": "array" - }, - "required": true - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "wait_for_metadata_version", - "in": "query", - "description": "Wait for the metadata version to be equal or greater than the specified metadata version.", - "schema": { - "type": "integer", - "description": "Wait for the metadata version to be equal or greater than the specified metadata version.", - "format": "int32" - } - }, - { - "name": "wait_for_timeout", - "in": "query", - "description": "The maximum time to wait for wait_for_metadata_version before timing out.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "The maximum time to wait for wait_for_metadata_version before timing out.", - "x-data-type": "time" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "ClusterState_WithIndexMetric 200 response" - } - }, - "x-operation-group": "cluster.state", - "x-version-added": "1.0" - } - }, - "/_cluster/stats": { - "get": { - "description": "Returns high-level overview of cluster statistics.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/" - }, - "operationId": "ClusterStats", - "parameters": [ - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "ClusterStats 200 response" - } - }, - "x-operation-group": "cluster.stats", - "x-version-added": "1.0" - } - }, - "/_cluster/stats/nodes/{node_id}": { - "get": { - "description": "Returns high-level overview of cluster statistics.", - "operationId": "ClusterStats_WithNodeId", - "parameters": [ - { - "name": "node_id", - "in": "path", - "description": "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.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "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.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "ClusterStats_WithNodeId 200 response" - } - }, - "x-operation-group": "cluster.stats", - "x-version-added": "1.0" - } - }, - "/_cluster/voting_config_exclusions": { - "delete": { - "description": "Clears cluster voting config exclusions.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "ClusterDeleteVotingConfigExclusions", - "parameters": [ - { - "name": "wait_for_removal", - "in": "query", - "description": "Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list." - } - } - ], - "responses": { - "200": { - "description": "ClusterDeleteVotingConfigExclusions 200 response" - } - }, - "x-operation-group": "cluster.delete_voting_config_exclusions", - "x-version-added": "1.0" - }, - "post": { - "description": "Updates the cluster voting config exclusions by node ids or node names.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "ClusterPostVotingConfigExclusions", - "parameters": [ - { - "name": "node_ids", - "in": "query", - "description": "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.", - "schema": { - "type": "string", - "description": "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." - } - }, - { - "name": "node_names", - "in": "query", - "description": "Comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_ids.", - "schema": { - "type": "string", - "description": "Comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_ids." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "ClusterPostVotingConfigExclusions 200 response" - } - }, - "x-operation-group": "cluster.post_voting_config_exclusions", - "x-version-added": "1.0" - } - }, - "/_component_template": { - "get": { - "description": "Returns one or more component templates.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "ClusterGetComponentTemplate", - "parameters": [ - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "ClusterGetComponentTemplate 200 response" - } - }, - "x-operation-group": "cluster.get_component_template", - "x-version-added": "1.0" - } - }, - "/_component_template/{name}": { - "delete": { - "description": "Deletes a component template.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "ClusterDeleteComponentTemplate", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the template.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the template." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "ClusterDeleteComponentTemplate 200 response" - } - }, - "x-operation-group": "cluster.delete_component_template", - "x-version-added": "1.0" - }, - "get": { - "description": "Returns one or more component templates.", - "operationId": "ClusterGetComponentTemplate_WithName", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The Comma-separated names of the component templates.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The Comma-separated names of the component templates.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "ClusterGetComponentTemplate_WithName 200 response" - } - }, - "x-operation-group": "cluster.get_component_template", - "x-version-added": "1.0" - }, - "head": { - "description": "Returns information about whether a particular component template exist.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "ClusterExistsComponentTemplate", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the template.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the template." - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "ClusterExistsComponentTemplate 200 response" - } - }, - "x-operation-group": "cluster.exists_component_template", - "x-version-added": "1.0" - }, - "post": { - "description": "Creates or updates a component template.", - "operationId": "ClusterPutComponentTemplate_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClusterPutComponentTemplate_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the template.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the template." - }, - "required": true - }, - { - "name": "create", - "in": "query", - "description": "Whether the index template should only be added if new or can also replace an existing one.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether the index template should only be added if new or can also replace an existing one." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "ClusterPutComponentTemplate_Post 200 response" - } - }, - "x-operation-group": "cluster.put_component_template", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or updates a component template.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template" - }, - "operationId": "ClusterPutComponentTemplate_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClusterPutComponentTemplate_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the template.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the template." - }, - "required": true - }, - { - "name": "create", - "in": "query", - "description": "Whether the index template should only be added if new or can also replace an existing one.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether the index template should only be added if new or can also replace an existing one." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "ClusterPutComponentTemplate_Put 200 response" - } - }, - "x-operation-group": "cluster.put_component_template", - "x-version-added": "1.0" - } - }, - "/_count": { - "get": { - "description": "Returns number of documents matching a query.", - "operationId": "Count_Get", - "parameters": [ - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "min_score", - "in": "query", - "description": "Include only documents with a specific `_score` value in the result.", - "schema": { - "type": "integer", - "description": "Include only documents with a specific `_score` value in the result.", - "format": "int32" - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "terminate_after", - "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Count_Get 200 response" - } - }, - "x-operation-group": "count", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns number of documents matching a query.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/count/" - }, - "operationId": "Count_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Count_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "min_score", - "in": "query", - "description": "Include only documents with a specific `_score` value in the result.", - "schema": { - "type": "integer", - "description": "Include only documents with a specific `_score` value in the result.", - "format": "int32" - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "terminate_after", - "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Count_Post 200 response" - } - }, - "x-operation-group": "count", - "x-version-added": "1.0" - } - }, - "/_dangling": { - "get": { - "description": "Returns all dangling indices.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/" - }, - "operationId": "DanglingIndicesListDanglingIndices", - "responses": { - "200": { - "description": "DanglingIndicesListDanglingIndices 200 response" - } - }, - "x-operation-group": "dangling_indices.list_dangling_indices", - "x-version-added": "1.0" - } - }, - "/_dangling/{index_uuid}": { - "delete": { - "description": "Deletes the specified dangling index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/" - }, - "operationId": "DanglingIndicesDeleteDanglingIndex", - "parameters": [ - { - "name": "index_uuid", - "in": "path", - "description": "The UUID of the dangling index.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The UUID of the dangling index." - }, - "required": true - }, - { - "name": "accept_data_loss", - "in": "query", - "description": "Must be set to true in order to delete the dangling index.", - "schema": { - "type": "boolean", - "description": "Must be set to true in order to delete the dangling index." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "DanglingIndicesDeleteDanglingIndex 200 response" - } - }, - "x-operation-group": "dangling_indices.delete_dangling_index", - "x-version-added": "1.0" - }, - "post": { - "description": "Imports the specified dangling index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/" - }, - "operationId": "DanglingIndicesImportDanglingIndex", - "parameters": [ - { - "name": "index_uuid", - "in": "path", - "description": "The UUID of the dangling index.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The UUID of the dangling index." - }, - "required": true - }, - { - "name": "accept_data_loss", - "in": "query", - "description": "Must be set to true in order to import the dangling index.", - "schema": { - "type": "boolean", - "description": "Must be set to true in order to import the dangling index." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "DanglingIndicesImportDanglingIndex 200 response" - } - }, - "x-operation-group": "dangling_indices.import_dangling_index", - "x-version-added": "1.0" - } - }, - "/_data_stream": { - "get": { - "description": "Returns data streams.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/im-plugin/data-streams/" - }, - "operationId": "IndicesGetDataStream", - "responses": { - "200": { - "description": "IndicesGetDataStream 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesGetDataStreamResponseContent" - } - } - } - } - }, - "x-operation-group": "indices.get_data_stream", - "x-version-added": "1.0" - } - }, - "/_data_stream/_stats": { - "get": { - "description": "Provides statistics on operations happening in a data stream.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/im-plugin/data-streams/" - }, - "operationId": "IndicesDataStreamsStats", - "responses": { - "200": { - "description": "IndicesDataStreamsStats 200 response" - } - }, - "x-operation-group": "indices.data_streams_stats", - "x-version-added": "1.0" - } - }, - "/_data_stream/{name}": { - "delete": { - "description": "Deletes a data stream.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/im-plugin/data-streams/" - }, - "operationId": "IndicesDeleteDataStream", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Comma-separated list of data streams; use `_all` or empty string to perform the operation on all data streams.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of data streams; use `_all` or empty string to perform the operation on all data streams.", - "x-data-type": "array" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "IndicesDeleteDataStream 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesDeleteDataStreamResponseContent" - } - } - } - } - }, - "x-operation-group": "indices.delete_data_stream", - "x-version-added": "1.0" - }, - "get": { - "description": "Returns data streams.", - "operationId": "IndicesGetDataStream_WithName", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Comma-separated list of data streams; use `_all` or empty string to perform the operation on all data streams.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of data streams; use `_all` or empty string to perform the operation on all data streams.", - "x-data-type": "array" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "IndicesGetDataStream_WithName 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesGetDataStream_WithNameResponseContent" - } - } - } - } - }, - "x-operation-group": "indices.get_data_stream", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or updates a data stream.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/im-plugin/data-streams/" - }, - "operationId": "IndicesCreateDataStream", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesCreateDataStream_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the data stream.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the data stream." - }, - "required": true - } - ], - "responses": { - "200": { - "description": "IndicesCreateDataStream 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesCreateDataStreamResponseContent" - } - } - } - } - }, - "x-operation-group": "indices.create_data_stream", - "x-version-added": "1.0" - } - }, - "/_data_stream/{name}/_stats": { - "get": { - "description": "Provides statistics on operations happening in a data stream.", - "operationId": "IndicesDataStreamsStats_WithName", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Comma-separated list of data streams; use `_all` or empty string to perform the operation on all data streams.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of data streams; use `_all` or empty string to perform the operation on all data streams.", - "x-data-type": "array" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "IndicesDataStreamsStats_WithName 200 response" - } - }, - "x-operation-group": "indices.data_streams_stats", - "x-version-added": "1.0" - } - }, - "/_delete_by_query/{task_id}/_rethrottle": { - "post": { - "description": "Changes the number of requests per second for a particular Delete By Query operation.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "DeleteByQueryRethrottle", - "parameters": [ - { - "name": "task_id", - "in": "path", - "description": "The task id to rethrottle.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The task id to rethrottle." - }, - "required": true - }, - { - "name": "requests_per_second", - "in": "query", - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "schema": { - "type": "integer", - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "format": "int32" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "DeleteByQueryRethrottle 200 response" - } - }, - "x-operation-group": "delete_by_query_rethrottle", - "x-version-added": "1.0" - } - }, - "/_field_caps": { - "get": { - "description": "Returns the information about the capabilities of fields among multiple indices.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations" - }, - "operationId": "FieldCaps_Get", - "parameters": [ - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of field names.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of field names." - }, - "explode": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "include_unmapped", - "in": "query", - "description": "Indicates whether unmapped fields should be included in the response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether unmapped fields should be included in the response." - } - } - ], - "responses": { - "200": { - "description": "FieldCaps_Get 200 response" - } - }, - "x-operation-group": "field_caps", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns the information about the capabilities of fields among multiple indices.", - "operationId": "FieldCaps_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FieldCaps_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of field names.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of field names." - }, - "explode": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "include_unmapped", - "in": "query", - "description": "Indicates whether unmapped fields should be included in the response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether unmapped fields should be included in the response." - } - } - ], - "responses": { - "200": { - "description": "FieldCaps_Post 200 response" - } - }, - "x-operation-group": "field_caps", - "x-version-added": "1.0" - } - }, - "/_flush": { - "get": { - "description": "Performs the flush operation on one or more indices.", - "operationId": "IndicesFlush_Get", - "parameters": [ - { - "name": "force", - "in": "query", - "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).", - "schema": { - "type": "boolean", - "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": "wait_if_ongoing", - "in": "query", - "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running.", - "schema": { - "type": "boolean", - "default": true, - "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesFlush_Get 200 response" - } - }, - "x-operation-group": "indices.flush", - "x-version-added": "1.0" - }, - "post": { - "description": "Performs the flush operation on one or more indices.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesFlush_Post", - "parameters": [ - { - "name": "force", - "in": "query", - "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).", - "schema": { - "type": "boolean", - "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": "wait_if_ongoing", - "in": "query", - "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running.", - "schema": { - "type": "boolean", - "default": true, - "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesFlush_Post 200 response" - } - }, - "x-operation-group": "indices.flush", - "x-version-added": "1.0" - } - }, - "/_forcemerge": { - "post": { - "description": "Performs the force merge operation on one or more indices.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesForcemerge", - "parameters": [ - { - "name": "flush", - "in": "query", - "description": "Specify whether the index should be flushed after performing the operation.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specify whether the index should be flushed after performing the operation." - } - }, - { - "name": "primary_only", - "in": "query", - "description": "Specify whether the operation should only perform on primary shards. Defaults to false.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether the operation should only perform on primary shards. Defaults to false." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "max_num_segments", - "in": "query", - "description": "The number of segments the index should be merged into (default: dynamic).", - "schema": { - "type": "integer", - "description": "The number of segments the index should be merged into (default: dynamic).", - "format": "int32" - } - }, - { - "name": "only_expunge_deletes", - "in": "query", - "description": "Specify whether the operation should only expunge deleted documents.", - "schema": { - "type": "boolean", - "description": "Specify whether the operation should only expunge deleted documents." - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": true, - "description": "Should this request wait until the operation has completed before returning." - } - } - ], - "responses": { - "200": { - "description": "IndicesForcemerge 200 response" - } - }, - "x-operation-group": "indices.forcemerge", - "x-version-added": "1.0" - } - }, - "/_index_template": { - "get": { - "description": "Returns an index template.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/im-plugin/index-templates/" - }, - "operationId": "IndicesGetIndexTemplate", - "parameters": [ - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetIndexTemplate 200 response" - } - }, - "x-operation-group": "indices.get_index_template", - "x-version-added": "1.0" - } - }, - "/_index_template/_simulate": { - "post": { - "description": "Simulate resolving the given template name or body.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesSimulateTemplate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesSimulateTemplate_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "create", - "in": "query", - "description": "Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one." - } - }, - { - "name": "cause", - "in": "query", - "description": "User defined reason for dry-run creating the new template for simulation purposes.", - "schema": { - "type": "string", - "default": "false", - "description": "User defined reason for dry-run creating the new template for simulation purposes." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesSimulateTemplate 200 response" - } - }, - "x-operation-group": "indices.simulate_template", - "x-version-added": "1.0" - } - }, - "/_index_template/_simulate/{name}": { - "post": { - "description": "Simulate resolving the given template name or body.", - "operationId": "IndicesSimulateTemplate_WithName", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesSimulateTemplate_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the template.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the template." - }, - "required": true - }, - { - "name": "create", - "in": "query", - "description": "Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one." - } - }, - { - "name": "cause", - "in": "query", - "description": "User defined reason for dry-run creating the new template for simulation purposes.", - "schema": { - "type": "string", - "default": "false", - "description": "User defined reason for dry-run creating the new template for simulation purposes." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesSimulateTemplate_WithName 200 response" - } - }, - "x-operation-group": "indices.simulate_template", - "x-version-added": "1.0" - } - }, - "/_index_template/_simulate_index/{name}": { - "post": { - "description": "Simulate matching the given index name against the index templates in the system.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesSimulateIndexTemplate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesSimulateIndexTemplate_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the index (it must be a concrete index name).", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the index (it must be a concrete index name)." - }, - "required": true - }, - { - "name": "create", - "in": "query", - "description": "Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one." - } - }, - { - "name": "cause", - "in": "query", - "description": "User defined reason for dry-run creating the new template for simulation purposes.", - "schema": { - "type": "string", - "default": "false", - "description": "User defined reason for dry-run creating the new template for simulation purposes." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesSimulateIndexTemplate 200 response" - } - }, - "x-operation-group": "indices.simulate_index_template", - "x-version-added": "1.0" - } - }, - "/_index_template/{name}": { - "delete": { - "description": "Deletes an index template.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/im-plugin/index-templates/#delete-a-template" - }, - "operationId": "IndicesDeleteIndexTemplate", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the template.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the template." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesDeleteIndexTemplate 200 response" - } - }, - "x-operation-group": "indices.delete_index_template", - "x-version-added": "1.0" - }, - "get": { - "description": "Returns an index template.", - "operationId": "IndicesGetIndexTemplate_WithName", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Comma-separated names of the index templates.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated names of the index templates.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetIndexTemplate_WithName 200 response" - } - }, - "x-operation-group": "indices.get_index_template", - "x-version-added": "1.0" - }, - "head": { - "description": "Returns information about whether a particular index template exists.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/im-plugin/index-templates/" - }, - "operationId": "IndicesExistsIndexTemplate", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the template.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the template." - }, - "required": true - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "IndicesExistsIndexTemplate 200 response" - } - }, - "x-operation-group": "indices.exists_index_template", - "x-version-added": "1.0" - }, - "post": { - "description": "Creates or updates an index template.", - "operationId": "IndicesPutIndexTemplate_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutIndexTemplate_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the template.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the template." - }, - "required": true - }, - { - "name": "create", - "in": "query", - "description": "Whether the index template should only be added if new or can also replace an existing one.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether the index template should only be added if new or can also replace an existing one." - } - }, - { - "name": "cause", - "in": "query", - "description": "User defined reason for creating/updating the index template.", - "schema": { - "type": "string", - "default": "false", - "description": "User defined reason for creating/updating the index template." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesPutIndexTemplate_Post 200 response" - } - }, - "x-operation-group": "indices.put_index_template", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or updates an index template.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/im-plugin/index-templates/" - }, - "operationId": "IndicesPutIndexTemplate_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutIndexTemplate_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the template.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the template." - }, - "required": true - }, - { - "name": "create", - "in": "query", - "description": "Whether the index template should only be added if new or can also replace an existing one.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether the index template should only be added if new or can also replace an existing one." - } - }, - { - "name": "cause", - "in": "query", - "description": "User defined reason for creating/updating the index template.", - "schema": { - "type": "string", - "default": "false", - "description": "User defined reason for creating/updating the index template." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesPutIndexTemplate_Put 200 response" - } - }, - "x-operation-group": "indices.put_index_template", - "x-version-added": "1.0" - } - }, - "/_ingest/pipeline": { - "get": { - "description": "Returns a pipeline.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/" - }, - "operationId": "IngestGetPipeline", - "parameters": [ - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IngestGetPipeline 200 response" - } - }, - "x-operation-group": "ingest.get_pipeline", - "x-version-added": "1.0" - } - }, - "/_ingest/pipeline/_simulate": { - "get": { - "description": "Allows to simulate a pipeline with example documents.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/" - }, - "operationId": "IngestSimulate_Get", - "parameters": [ - { - "name": "verbose", - "in": "query", - "description": "Verbose mode. Display data output for each processor in executed pipeline.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display data output for each processor in executed pipeline." - } - } - ], - "responses": { - "200": { - "description": "IngestSimulate_Get 200 response" - } - }, - "x-operation-group": "ingest.simulate", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to simulate a pipeline with example documents.", - "operationId": "IngestSimulate_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IngestSimulate_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "verbose", - "in": "query", - "description": "Verbose mode. Display data output for each processor in executed pipeline.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display data output for each processor in executed pipeline." - } - } - ], - "responses": { - "200": { - "description": "IngestSimulate_Post 200 response" - } - }, - "x-operation-group": "ingest.simulate", - "x-version-added": "1.0" - } - }, - "/_ingest/pipeline/{id}": { - "delete": { - "description": "Deletes a pipeline.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/" - }, - "operationId": "IngestDeletePipeline", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Pipeline ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Pipeline ID." - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IngestDeletePipeline 200 response" - } - }, - "x-operation-group": "ingest.delete_pipeline", - "x-version-added": "1.0" - }, - "get": { - "description": "Returns a pipeline.", - "operationId": "IngestGetPipeline_WithId", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Comma-separated list of pipeline ids. Wildcards supported.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of pipeline ids. Wildcards supported.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IngestGetPipeline_WithId 200 response" - } - }, - "x-operation-group": "ingest.get_pipeline", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or updates a pipeline.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/" - }, - "operationId": "IngestPutPipeline", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IngestPutPipeline_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Pipeline ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Pipeline ID." - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IngestPutPipeline 200 response" - } - }, - "x-operation-group": "ingest.put_pipeline", - "x-version-added": "1.0" - } - }, - "/_ingest/pipeline/{id}/_simulate": { - "get": { - "description": "Allows to simulate a pipeline with example documents.", - "operationId": "IngestSimulate_Get_WithId", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Pipeline ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Pipeline ID." - }, - "required": true - }, - { - "name": "verbose", - "in": "query", - "description": "Verbose mode. Display data output for each processor in executed pipeline.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display data output for each processor in executed pipeline." - } - } - ], - "responses": { - "200": { - "description": "IngestSimulate_Get_WithId 200 response" - } - }, - "x-operation-group": "ingest.simulate", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to simulate a pipeline with example documents.", - "operationId": "IngestSimulate_Post_WithId", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IngestSimulate_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Pipeline ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Pipeline ID." - }, - "required": true - }, - { - "name": "verbose", - "in": "query", - "description": "Verbose mode. Display data output for each processor in executed pipeline.", - "schema": { - "type": "boolean", - "default": false, - "description": "Verbose mode. Display data output for each processor in executed pipeline." - } - } - ], - "responses": { - "200": { - "description": "IngestSimulate_Post_WithId 200 response" - } - }, - "x-operation-group": "ingest.simulate", - "x-version-added": "1.0" - } - }, - "/_ingest/processor/grok": { - "get": { - "description": "Returns a list of the built-in patterns.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IngestProcessorGrok", - "responses": { - "200": { - "description": "IngestProcessorGrok 200 response" - } - }, - "x-operation-group": "ingest.processor_grok", - "x-version-added": "1.0" - } - }, - "/_mapping": { - "get": { - "description": "Returns mappings for one or more indices.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/field-types/index/#get-a-mapping" - }, - "operationId": "IndicesGetMapping", - "parameters": [ - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "x-version-deprecated": "1.0", - "x-deprecation-message": "This parameter is a no-op and field mappings are always retrieved locally.", - "deprecated": true - } - } - ], - "responses": { - "200": { - "description": "IndicesGetMapping 200 response" - } - }, - "x-operation-group": "indices.get_mapping", - "x-version-added": "1.0" - } - }, - "/_mapping/field/{fields}": { - "get": { - "description": "Returns mapping for one or more fields.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/field-types/index/" - }, - "operationId": "IndicesGetFieldMapping", - "parameters": [ - { - "name": "fields", - "in": "path", - "description": "Comma-separated list of fields.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of fields.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "include_defaults", - "in": "query", - "description": "Whether the default mapping values should be returned as well.", - "schema": { - "type": "boolean", - "description": "Whether the default mapping values should be returned as well." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetFieldMapping 200 response" - } - }, - "x-operation-group": "indices.get_field_mapping", - "x-version-added": "1.0" - } - }, - "/_mget": { - "get": { - "description": "Allows to get multiple documents in one request.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/" - }, - "operationId": "Mget_Get", - "parameters": [ - { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specify whether to perform the operation in realtime or search mode.", - "schema": { - "type": "boolean", - "description": "Specify whether to perform the operation in realtime or search mode." - } - }, - { - "name": "refresh", - "in": "query", - "description": "Refresh the shard containing the document before performing the operation.", - "schema": { - "type": "boolean", - "description": "Refresh the shard containing the document before performing the operation." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - } - ], - "responses": { - "200": { - "description": "Mget_Get 200 response" - } - }, - "x-operation-group": "mget", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to get multiple documents in one request.", - "operationId": "Mget_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Mget_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specify whether to perform the operation in realtime or search mode.", - "schema": { - "type": "boolean", - "description": "Specify whether to perform the operation in realtime or search mode." - } - }, - { - "name": "refresh", - "in": "query", - "description": "Refresh the shard containing the document before performing the operation.", - "schema": { - "type": "boolean", - "description": "Refresh the shard containing the document before performing the operation." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - } - ], - "responses": { - "200": { - "description": "Mget_Post 200 response" - } - }, - "x-operation-group": "mget", - "x-version-added": "1.0" - } - }, - "/_msearch": { - "get": { - "description": "Allows to execute several search operations in one request.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/multi-search/" - }, - "operationId": "Msearch_Get", - "parameters": [ - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" - } - }, - { - "name": "max_concurrent_searches", - "in": "query", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "schema": { - "type": "integer", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "format": "int32" - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "pre_filter_shard_size", - "in": "query", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "schema": { - "type": "integer", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "format": "int32" - } - }, - { - "name": "max_concurrent_shard_requests", - "in": "query", - "description": "The number of concurrent shard requests each sub search executes concurrently per node. 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.", - "schema": { - "type": "integer", - "default": 5, - "description": "The number of concurrent shard requests each sub search executes concurrently per node. 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.", - "format": "int32" - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - } - ], - "responses": { - "200": { - "description": "Msearch_Get 200 response" - } - }, - "x-operation-group": "msearch", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to execute several search operations in one request.", - "operationId": "Msearch_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Msearch_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" - } - }, - { - "name": "max_concurrent_searches", - "in": "query", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "schema": { - "type": "integer", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "format": "int32" - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "pre_filter_shard_size", - "in": "query", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "schema": { - "type": "integer", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "format": "int32" - } - }, - { - "name": "max_concurrent_shard_requests", - "in": "query", - "description": "The number of concurrent shard requests each sub search executes concurrently per node. 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.", - "schema": { - "type": "integer", - "default": 5, - "description": "The number of concurrent shard requests each sub search executes concurrently per node. 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.", - "format": "int32" - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - } - ], - "responses": { - "200": { - "description": "Msearch_Post 200 response" - } - }, - "x-operation-group": "msearch", - "x-version-added": "1.0" - } - }, - "/_msearch/template": { - "get": { - "description": "Allows to execute several search template operations in one request.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/search-plugins/search-template/" - }, - "operationId": "MsearchTemplate_Get", - "parameters": [ - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "max_concurrent_searches", - "in": "query", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "schema": { - "type": "integer", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "format": "int32" - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - } - ], - "responses": { - "200": { - "description": "MsearchTemplate_Get 200 response" - } - }, - "x-operation-group": "msearch_template", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to execute several search template operations in one request.", - "operationId": "MsearchTemplate_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MsearchTemplate_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "max_concurrent_searches", - "in": "query", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "schema": { - "type": "integer", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "format": "int32" - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - } - ], - "responses": { - "200": { - "description": "MsearchTemplate_Post 200 response" - } - }, - "x-operation-group": "msearch_template", - "x-version-added": "1.0" - } - }, - "/_mtermvectors": { - "get": { - "description": "Returns multiple termvectors in one request.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "Mtermvectors_Get", - "parameters": [ - { - "name": "ids", - "in": "query", - "description": "Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body." - }, - "explode": true - }, - { - "name": "term_statistics", - "in": "query", - "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'.", - "schema": { - "type": "boolean", - "default": false, - "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": "field_statistics", - "in": "query", - "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'.", - "schema": { - "type": "boolean", - "default": true, - "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": "fields", - "in": "query", - "description": "Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - }, - "explode": true - }, - { - "name": "offsets", - "in": "query", - "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "positions", - "in": "query", - "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "payloads", - "in": "query", - "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "string", - "description": "Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specifies if requests are real-time as opposed to near-real-time.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if requests are real-time as opposed to near-real-time." - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "Mtermvectors_Get 200 response" - } - }, - "x-operation-group": "mtermvectors", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns multiple termvectors in one request.", - "operationId": "Mtermvectors_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Mtermvectors_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "ids", - "in": "query", - "description": "Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body." - }, - "explode": true - }, - { - "name": "term_statistics", - "in": "query", - "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'.", - "schema": { - "type": "boolean", - "default": false, - "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": "field_statistics", - "in": "query", - "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'.", - "schema": { - "type": "boolean", - "default": true, - "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": "fields", - "in": "query", - "description": "Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - }, - "explode": true - }, - { - "name": "offsets", - "in": "query", - "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "positions", - "in": "query", - "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "payloads", - "in": "query", - "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "string", - "description": "Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specifies if requests are real-time as opposed to near-real-time.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if requests are real-time as opposed to near-real-time." - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "Mtermvectors_Post 200 response" - } - }, - "x-operation-group": "mtermvectors", - "x-version-added": "1.0" - } - }, - "/_nodes": { - "get": { - "description": "Returns information about nodes in the cluster.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/" - }, - "operationId": "NodesInfo", - "parameters": [ - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesInfo 200 response" - } - }, - "x-operation-group": "nodes.info", - "x-version-added": "1.0" - } - }, - "/_nodes/hot_threads": { - "get": { - "description": "Returns information about hot threads on each node in the cluster.", - "operationId": "NodesHotThreads", - "parameters": [ - { - "name": "interval", - "in": "query", - "description": "The interval for the second sampling of threads.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "The interval for the second sampling of threads.", - "x-data-type": "time" - } - }, - { - "name": "snapshots", - "in": "query", - "description": "Number of samples of thread stacktrace.", - "schema": { - "type": "integer", - "default": 10, - "description": "Number of samples of thread stacktrace.", - "format": "int32" - } - }, - { - "name": "threads", - "in": "query", - "description": "Specify the number of threads to provide information for.", - "schema": { - "type": "integer", - "default": 3, - "description": "Specify the number of threads to provide information for.", - "format": "int32" - } - }, - { - "name": "ignore_idle_threads", - "in": "query", - "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue.", - "schema": { - "type": "boolean", - "default": true, - "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue." - } - }, - { - "name": "type", - "in": "query", - "description": "The type to sample.", - "schema": { - "$ref": "#/components/schemas/SampleType" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesHotThreads 200 response" - } - }, - "x-operation-group": "nodes.hot_threads", - "x-version-added": "1.0" - } - }, - "/_nodes/hotthreads": { - "get": { - "description": "Returns information about hot threads on each node in the cluster.", - "operationId": "NodesHotThreads_Deprecated", - "deprecated": true, - "parameters": [ - { - "name": "interval", - "in": "query", - "description": "The interval for the second sampling of threads.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "The interval for the second sampling of threads.", - "x-data-type": "time" - } - }, - { - "name": "snapshots", - "in": "query", - "description": "Number of samples of thread stacktrace.", - "schema": { - "type": "integer", - "default": 10, - "description": "Number of samples of thread stacktrace.", - "format": "int32" - } - }, - { - "name": "threads", - "in": "query", - "description": "Specify the number of threads to provide information for.", - "schema": { - "type": "integer", - "default": 3, - "description": "Specify the number of threads to provide information for.", - "format": "int32" - } - }, - { - "name": "ignore_idle_threads", - "in": "query", - "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue.", - "schema": { - "type": "boolean", - "default": true, - "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue." - } - }, - { - "name": "type", - "in": "query", - "description": "The type to sample.", - "schema": { - "$ref": "#/components/schemas/SampleType" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesHotThreads_Deprecated 200 response" - } - }, - "x-deprecation-message": "The hot threads API accepts `hotthreads` but only `hot_threads` is documented", - "x-ignorable": true, - "x-operation-group": "nodes.hot_threads", - "x-version-added": "1.0", - "x-version-deprecated": "1.0" - } - }, - "/_nodes/reload_secure_settings": { - "post": { - "description": "Reloads secure settings.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/" - }, - "operationId": "NodesReloadSecureSettings", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NodesReloadSecureSettings_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesReloadSecureSettings 200 response" - } - }, - "x-operation-group": "nodes.reload_secure_settings", - "x-version-added": "1.0" - } - }, - "/_nodes/stats": { - "get": { - "description": "Returns statistical information about nodes in the cluster.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/" - }, - "operationId": "NodesStats", - "parameters": [ - { - "name": "completion_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fielddata_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "groups", - "in": "query", - "description": "Comma-separated list of search groups for `search` index metric.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of search groups for `search` index metric." - }, - "explode": true - }, - { - "name": "level", - "in": "query", - "description": "Return indices stats aggregated at index, node or shard level.", - "schema": { - "$ref": "#/components/schemas/NodesStatLevel" - } - }, - { - "name": "types", - "in": "query", - "description": "Comma-separated list of document types for the `indexing` index metric.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of document types for the `indexing` index metric." - }, - "explode": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "include_segment_file_sizes", - "in": "query", - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)." - } - } - ], - "responses": { - "200": { - "description": "NodesStats 200 response" - } - }, - "x-operation-group": "nodes.stats", - "x-version-added": "1.0" - } - }, - "/_nodes/stats/{metric}": { - "get": { - "description": "Returns statistical information about nodes in the cluster.", - "operationId": "NodesStats_WithMetric", - "parameters": [ - { - "name": "metric", - "in": "path", - "description": "Limit the information returned to the specified metrics.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Limit the information returned to the specified metrics.", - "x-enum-options": [ - "_all", - "breaker", - "fs", - "http", - "indices", - "jvm", - "os", - "process", - "thread_pool", - "transport", - "discovery", - "indexing_pressure", - "search_pipeline" - ], - "x-data-type": "array" - }, - "required": true - }, - { - "name": "completion_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fielddata_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "groups", - "in": "query", - "description": "Comma-separated list of search groups for `search` index metric.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of search groups for `search` index metric." - }, - "explode": true - }, - { - "name": "level", - "in": "query", - "description": "Return indices stats aggregated at index, node or shard level.", - "schema": { - "$ref": "#/components/schemas/NodesStatLevel" - } - }, - { - "name": "types", - "in": "query", - "description": "Comma-separated list of document types for the `indexing` index metric.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of document types for the `indexing` index metric." - }, - "explode": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "include_segment_file_sizes", - "in": "query", - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)." - } - } - ], - "responses": { - "200": { - "description": "NodesStats_WithMetric 200 response" - } - }, - "x-operation-group": "nodes.stats", - "x-version-added": "1.0" - } - }, - "/_nodes/stats/{metric}/{index_metric}": { - "get": { - "description": "Returns statistical information about nodes in the cluster.", - "operationId": "NodesStats_WithIndexMetricMetric", - "parameters": [ - { - "name": "metric", - "in": "path", - "description": "Limit the information returned to the specified metrics.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Limit the information returned to the specified metrics.", - "x-enum-options": [ - "_all", - "breaker", - "fs", - "http", - "indices", - "jvm", - "os", - "process", - "thread_pool", - "transport", - "discovery", - "indexing_pressure", - "search_pipeline" - ], - "x-data-type": "array" - }, - "required": true - }, - { - "name": "index_metric", - "in": "path", - "description": "Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified.", - "x-enum-options": [ - "_all", - "store", - "indexing", - "get", - "search", - "merge", - "flush", - "refresh", - "query_cache", - "fielddata", - "docs", - "warmer", - "completion", - "segments", - "translog", - "suggest", - "request_cache", - "recovery" - ], - "x-data-type": "array" - }, - "required": true - }, - { - "name": "completion_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fielddata_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "groups", - "in": "query", - "description": "Comma-separated list of search groups for `search` index metric.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of search groups for `search` index metric." - }, - "explode": true - }, - { - "name": "level", - "in": "query", - "description": "Return indices stats aggregated at index, node or shard level.", - "schema": { - "$ref": "#/components/schemas/NodesStatLevel" - } - }, - { - "name": "types", - "in": "query", - "description": "Comma-separated list of document types for the `indexing` index metric.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of document types for the `indexing` index metric." - }, - "explode": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "include_segment_file_sizes", - "in": "query", - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)." - } - } - ], - "responses": { - "200": { - "description": "NodesStats_WithIndexMetricMetric 200 response" - } - }, - "x-operation-group": "nodes.stats", - "x-version-added": "1.0" - } - }, - "/_nodes/usage": { - "get": { - "description": "Returns low-level information about REST actions usage on nodes.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "NodesUsage", - "parameters": [ - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesUsage 200 response" - } - }, - "x-operation-group": "nodes.usage", - "x-version-added": "1.0" - } - }, - "/_nodes/usage/{metric}": { - "get": { - "description": "Returns low-level information about REST actions usage on nodes.", - "operationId": "NodesUsage_WithMetric", - "parameters": [ - { - "name": "metric", - "in": "path", - "description": "Limit the information returned to the specified metrics.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Limit the information returned to the specified metrics.", - "x-enum-options": [ - "_all", - "rest_actions" - ], - "x-data-type": "array" - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesUsage_WithMetric 200 response" - } - }, - "x-operation-group": "nodes.usage", - "x-version-added": "1.0" - } - }, - "/_nodes/{node_id}": { - "get": { - "description": "Returns information about nodes in the cluster.", - "operationId": "NodesInfo_WithNodeId", - "parameters": [ - { - "name": "node_id", - "in": "path", - "description": "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.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "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.", - "x-overloaded-param": "metric", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesInfo_WithNodeId 200 response" - } - }, - "x-operation-group": "nodes.info", - "x-version-added": "1.0" - } - }, - "/_nodes/{node_id}/hot_threads": { - "get": { - "description": "Returns information about hot threads on each node in the cluster.", - "operationId": "NodesHotThreads_WithNodeId", - "parameters": [ - { - "name": "node_id", - "in": "path", - "description": "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.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "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.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "interval", - "in": "query", - "description": "The interval for the second sampling of threads.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "The interval for the second sampling of threads.", - "x-data-type": "time" - } - }, - { - "name": "snapshots", - "in": "query", - "description": "Number of samples of thread stacktrace.", - "schema": { - "type": "integer", - "default": 10, - "description": "Number of samples of thread stacktrace.", - "format": "int32" - } - }, - { - "name": "threads", - "in": "query", - "description": "Specify the number of threads to provide information for.", - "schema": { - "type": "integer", - "default": 3, - "description": "Specify the number of threads to provide information for.", - "format": "int32" - } - }, - { - "name": "ignore_idle_threads", - "in": "query", - "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue.", - "schema": { - "type": "boolean", - "default": true, - "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue." - } - }, - { - "name": "type", - "in": "query", - "description": "The type to sample.", - "schema": { - "$ref": "#/components/schemas/SampleType" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesHotThreads_WithNodeId 200 response" - } - }, - "x-operation-group": "nodes.hot_threads", - "x-version-added": "1.0" - } - }, - "/_nodes/{node_id}/hotthreads": { - "get": { - "description": "Returns information about hot threads on each node in the cluster.", - "operationId": "NodesHotThreads_WithNodeId_Deprecated", - "deprecated": true, - "parameters": [ - { - "name": "node_id", - "in": "path", - "description": "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.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "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.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "interval", - "in": "query", - "description": "The interval for the second sampling of threads.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "The interval for the second sampling of threads.", - "x-data-type": "time" - } - }, - { - "name": "snapshots", - "in": "query", - "description": "Number of samples of thread stacktrace.", - "schema": { - "type": "integer", - "default": 10, - "description": "Number of samples of thread stacktrace.", - "format": "int32" - } - }, - { - "name": "threads", - "in": "query", - "description": "Specify the number of threads to provide information for.", - "schema": { - "type": "integer", - "default": 3, - "description": "Specify the number of threads to provide information for.", - "format": "int32" - } - }, - { - "name": "ignore_idle_threads", - "in": "query", - "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue.", - "schema": { - "type": "boolean", - "default": true, - "description": "Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue." - } - }, - { - "name": "type", - "in": "query", - "description": "The type to sample.", - "schema": { - "$ref": "#/components/schemas/SampleType" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesHotThreads_WithNodeId_Deprecated 200 response" - } - }, - "x-deprecation-message": "The hot threads API accepts `hotthreads` but only `hot_threads` is documented", - "x-ignorable": true, - "x-operation-group": "nodes.hot_threads", - "x-version-added": "1.0", - "x-version-deprecated": "1.0" - } - }, - "/_nodes/{node_id}/reload_secure_settings": { - "post": { - "description": "Reloads secure settings.", - "operationId": "NodesReloadSecureSettings_WithNodeId", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NodesReloadSecureSettings_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "node_id", - "in": "path", - "description": "Comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesReloadSecureSettings_WithNodeId 200 response" - } - }, - "x-operation-group": "nodes.reload_secure_settings", - "x-version-added": "1.0" - } - }, - "/_nodes/{node_id}/stats": { - "get": { - "description": "Returns statistical information about nodes in the cluster.", - "operationId": "NodesStats_WithNodeId", - "parameters": [ - { - "name": "node_id", - "in": "path", - "description": "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.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "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.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "completion_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fielddata_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "groups", - "in": "query", - "description": "Comma-separated list of search groups for `search` index metric.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of search groups for `search` index metric." - }, - "explode": true - }, - { - "name": "level", - "in": "query", - "description": "Return indices stats aggregated at index, node or shard level.", - "schema": { - "$ref": "#/components/schemas/NodesStatLevel" - } - }, - { - "name": "types", - "in": "query", - "description": "Comma-separated list of document types for the `indexing` index metric.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of document types for the `indexing` index metric." - }, - "explode": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "include_segment_file_sizes", - "in": "query", - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)." - } - } - ], - "responses": { - "200": { - "description": "NodesStats_WithNodeId 200 response" - } - }, - "x-operation-group": "nodes.stats", - "x-version-added": "1.0" - } - }, - "/_nodes/{node_id}/stats/{metric}": { - "get": { - "description": "Returns statistical information about nodes in the cluster.", - "operationId": "NodesStats_WithMetricNodeId", - "parameters": [ - { - "name": "metric", - "in": "path", - "description": "Limit the information returned to the specified metrics.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Limit the information returned to the specified metrics.", - "x-enum-options": [ - "_all", - "breaker", - "fs", - "http", - "indices", - "jvm", - "os", - "process", - "thread_pool", - "transport", - "discovery", - "indexing_pressure", - "search_pipeline" - ], - "x-data-type": "array" - }, - "required": true - }, - { - "name": "node_id", - "in": "path", - "description": "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.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "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.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "completion_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fielddata_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "groups", - "in": "query", - "description": "Comma-separated list of search groups for `search` index metric.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of search groups for `search` index metric." - }, - "explode": true - }, - { - "name": "level", - "in": "query", - "description": "Return indices stats aggregated at index, node or shard level.", - "schema": { - "$ref": "#/components/schemas/NodesStatLevel" - } - }, - { - "name": "types", - "in": "query", - "description": "Comma-separated list of document types for the `indexing` index metric.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of document types for the `indexing` index metric." - }, - "explode": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "include_segment_file_sizes", - "in": "query", - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)." - } - } - ], - "responses": { - "200": { - "description": "NodesStats_WithMetricNodeId 200 response" - } - }, - "x-operation-group": "nodes.stats", - "x-version-added": "1.0" - } - }, - "/_nodes/{node_id}/stats/{metric}/{index_metric}": { - "get": { - "description": "Returns statistical information about nodes in the cluster.", - "operationId": "NodesStats_WithIndexMetricMetricNodeId", - "parameters": [ - { - "name": "metric", - "in": "path", - "description": "Limit the information returned to the specified metrics.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Limit the information returned to the specified metrics.", - "x-enum-options": [ - "_all", - "breaker", - "fs", - "http", - "indices", - "jvm", - "os", - "process", - "thread_pool", - "transport", - "discovery", - "indexing_pressure", - "search_pipeline" - ], - "x-data-type": "array" - }, - "required": true - }, - { - "name": "index_metric", - "in": "path", - "description": "Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified.", - "x-enum-options": [ - "_all", - "store", - "indexing", - "get", - "search", - "merge", - "flush", - "refresh", - "query_cache", - "fielddata", - "docs", - "warmer", - "completion", - "segments", - "translog", - "suggest", - "request_cache", - "recovery" - ], - "x-data-type": "array" - }, - "required": true - }, - { - "name": "node_id", - "in": "path", - "description": "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.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "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.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "completion_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fielddata_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "groups", - "in": "query", - "description": "Comma-separated list of search groups for `search` index metric.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of search groups for `search` index metric." - }, - "explode": true - }, - { - "name": "level", - "in": "query", - "description": "Return indices stats aggregated at index, node or shard level.", - "schema": { - "$ref": "#/components/schemas/NodesStatLevel" - } - }, - { - "name": "types", - "in": "query", - "description": "Comma-separated list of document types for the `indexing` index metric.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of document types for the `indexing` index metric." - }, - "explode": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "include_segment_file_sizes", - "in": "query", - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)." - } - } - ], - "responses": { - "200": { - "description": "NodesStats_WithIndexMetricMetricNodeId 200 response" - } - }, - "x-operation-group": "nodes.stats", - "x-version-added": "1.0" - } - }, - "/_nodes/{node_id}/usage": { - "get": { - "description": "Returns low-level information about REST actions usage on nodes.", - "operationId": "NodesUsage_WithNodeId", - "parameters": [ - { - "name": "node_id", - "in": "path", - "description": "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.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "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.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesUsage_WithNodeId 200 response" - } - }, - "x-operation-group": "nodes.usage", - "x-version-added": "1.0" - } - }, - "/_nodes/{node_id}/usage/{metric}": { - "get": { - "description": "Returns low-level information about REST actions usage on nodes.", - "operationId": "NodesUsage_WithMetricNodeId", - "parameters": [ - { - "name": "metric", - "in": "path", - "description": "Limit the information returned to the specified metrics.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Limit the information returned to the specified metrics.", - "x-enum-options": [ - "_all", - "rest_actions" - ], - "x-data-type": "array" - }, - "required": true - }, - { - "name": "node_id", - "in": "path", - "description": "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.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "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.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesUsage_WithMetricNodeId 200 response" - } - }, - "x-operation-group": "nodes.usage", - "x-version-added": "1.0" - } - }, - "/_nodes/{node_id}/{metric}": { - "get": { - "description": "Returns information about nodes in the cluster.", - "operationId": "NodesInfo_WithMetricNodeId", - "parameters": [ - { - "name": "node_id", - "in": "path", - "description": "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.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "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.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "metric", - "in": "path", - "description": "Comma-separated list of metrics you wish returned. Leave empty to return all.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of metrics you wish returned. Leave empty to return all.", - "x-enum-options": [ - "settings", - "os", - "process", - "jvm", - "thread_pool", - "transport", - "http", - "plugins", - "ingest" - ], - "x-data-type": "array" - }, - "required": true - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "NodesInfo_WithMetricNodeId 200 response" - } - }, - "x-operation-group": "nodes.info", - "x-version-added": "1.0" - } - }, - "/_plugins/_knn/models/_search": { - "get": { - "description": "Use an OpenSearch query to search for models in the index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/search-plugins/knn/api/#search-model" - }, - "operationId": "KNNSearchModels_Get", - "parameters": [ - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "explain", - "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." - } - }, - { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true - }, - { - "name": "docvalue_fields", - "in": "query", - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit." - }, - "explode": true - }, - { - "name": "from", - "in": "query", - "description": "Starting offset.", - "schema": { - "type": "integer", - "default": 0, - "description": "Starting offset.", - "format": "int32" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchType" - } - }, - { - "name": "size", - "in": "query", - "description": "Number of hits to return.", - "schema": { - "type": "integer", - "default": 10, - "description": "Number of hits to return.", - "format": "int32" - } - }, - { - "name": "sort", - "in": "query", - "description": "Comma-separated list of : pairs.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of : pairs." - }, - "explode": true - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - }, - { - "name": "terminate_after", - "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" - } - }, - { - "name": "stats", - "in": "query", - "description": "Specific 'tag' of the request for logging and statistical purposes.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specific 'tag' of the request for logging and statistical purposes." - }, - "explode": true - }, - { - "name": "suggest_field", - "in": "query", - "description": "Specify which field to use for suggestions.", - "schema": { - "type": "string", - "description": "Specify which field to use for suggestions." - } - }, - { - "name": "suggest_mode", - "in": "query", - "description": "Specify suggest mode.", - "schema": { - "$ref": "#/components/schemas/SuggestMode" - } - }, - { - "name": "suggest_size", - "in": "query", - "description": "How many suggestions to return in response.", - "schema": { - "type": "integer", - "description": "How many suggestions to return in response.", - "format": "int32" - } - }, - { - "name": "suggest_text", - "in": "query", - "description": "The source text for which the suggestions should be returned.", - "schema": { - "type": "string", - "description": "The source text for which the suggestions should be returned." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "track_scores", - "in": "query", - "description": "Whether to calculate and return scores even if they are not used for sorting.", - "schema": { - "type": "boolean", - "description": "Whether to calculate and return scores even if they are not used for sorting." - } - }, - { - "name": "track_total_hits", - "in": "query", - "description": "Indicate if the number of documents that match the query should be tracked.", - "schema": { - "type": "boolean", - "description": "Indicate if the number of documents that match the query should be tracked." - } - }, - { - "name": "allow_partial_search_results", - "in": "query", - "description": "Indicate if an error should be returned if there is a partial search failure or timeout.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicate if an error should be returned if there is a partial search failure or timeout." - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "version", - "in": "query", - "description": "Whether to return document version as part of a hit.", - "schema": { - "type": "boolean", - "description": "Whether to return document version as part of a hit." - } - }, - { - "name": "seq_no_primary_term", - "in": "query", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit." - } - }, - { - "name": "request_cache", - "in": "query", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", - "schema": { - "type": "boolean", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting." - } - }, - { - "name": "batched_reduce_size", - "in": "query", - "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.", - "schema": { - "type": "integer", - "default": 512, - "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.", - "format": "int32" - } - }, - { - "name": "max_concurrent_shard_requests", - "in": "query", - "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.", - "schema": { - "type": "integer", - "default": 5, - "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.", - "format": "int32" - } - }, - { - "name": "pre_filter_shard_size", - "in": "query", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "schema": { - "type": "integer", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "format": "int32" - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - } - ], - "responses": { - "200": { - "description": "KNNSearchModels_Get 200 response" - } - }, - "x-operation-group": "knn.search_models", - "x-version-added": "1.0" - }, - "post": { - "description": "Use an OpenSearch query to search for models in the index.", - "operationId": "KNNSearchModels_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KNNSearchModels_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "explain", - "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." - } - }, - { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true - }, - { - "name": "docvalue_fields", - "in": "query", - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit." - }, - "explode": true - }, - { - "name": "from", - "in": "query", - "description": "Starting offset.", - "schema": { - "type": "integer", - "default": 0, - "description": "Starting offset.", - "format": "int32" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchType" - } - }, - { - "name": "size", - "in": "query", - "description": "Number of hits to return.", - "schema": { - "type": "integer", - "default": 10, - "description": "Number of hits to return.", - "format": "int32" - } - }, - { - "name": "sort", - "in": "query", - "description": "Comma-separated list of : pairs.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of : pairs." - }, - "explode": true - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - }, - { - "name": "terminate_after", - "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" - } - }, - { - "name": "stats", - "in": "query", - "description": "Specific 'tag' of the request for logging and statistical purposes.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specific 'tag' of the request for logging and statistical purposes." - }, - "explode": true - }, - { - "name": "suggest_field", - "in": "query", - "description": "Specify which field to use for suggestions.", - "schema": { - "type": "string", - "description": "Specify which field to use for suggestions." - } - }, - { - "name": "suggest_mode", - "in": "query", - "description": "Specify suggest mode.", - "schema": { - "$ref": "#/components/schemas/SuggestMode" - } - }, - { - "name": "suggest_size", - "in": "query", - "description": "How many suggestions to return in response.", - "schema": { - "type": "integer", - "description": "How many suggestions to return in response.", - "format": "int32" - } - }, - { - "name": "suggest_text", - "in": "query", - "description": "The source text for which the suggestions should be returned.", - "schema": { - "type": "string", - "description": "The source text for which the suggestions should be returned." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "track_scores", - "in": "query", - "description": "Whether to calculate and return scores even if they are not used for sorting.", - "schema": { - "type": "boolean", - "description": "Whether to calculate and return scores even if they are not used for sorting." - } - }, - { - "name": "track_total_hits", - "in": "query", - "description": "Indicate if the number of documents that match the query should be tracked.", - "schema": { - "type": "boolean", - "description": "Indicate if the number of documents that match the query should be tracked." - } - }, - { - "name": "allow_partial_search_results", - "in": "query", - "description": "Indicate if an error should be returned if there is a partial search failure or timeout.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicate if an error should be returned if there is a partial search failure or timeout." - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "version", - "in": "query", - "description": "Whether to return document version as part of a hit.", - "schema": { - "type": "boolean", - "description": "Whether to return document version as part of a hit." - } - }, - { - "name": "seq_no_primary_term", - "in": "query", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit." - } - }, - { - "name": "request_cache", - "in": "query", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", - "schema": { - "type": "boolean", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting." - } - }, - { - "name": "batched_reduce_size", - "in": "query", - "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.", - "schema": { - "type": "integer", - "default": 512, - "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.", - "format": "int32" - } - }, - { - "name": "max_concurrent_shard_requests", - "in": "query", - "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.", - "schema": { - "type": "integer", - "default": 5, - "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.", - "format": "int32" - } - }, - { - "name": "pre_filter_shard_size", - "in": "query", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "schema": { - "type": "integer", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "format": "int32" - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - } - ], - "responses": { - "200": { - "description": "KNNSearchModels_Post 200 response" - } - }, - "x-operation-group": "knn.search_models", - "x-version-added": "1.0" - } - }, - "/_plugins/_knn/models/_train": { - "post": { - "description": "Create and train a model that can be used for initializing k-NN native library indexes during indexing.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/search-plugins/knn/api/#train-model" - }, - "operationId": "KNNTrainModel", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KNNTrainModel_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "preference", - "in": "query", - "description": "Preferred node to execute training.", - "schema": { - "type": "string", - "description": "Preferred node to execute training." - } - } - ], - "responses": { - "200": { - "description": "KNNTrainModel 200 response" - } - }, - "x-operation-group": "knn.train_model", - "x-version-added": "1.0" - } - }, - "/_plugins/_knn/models/{model_id}": { - "delete": { - "description": "Used to delete a particular model in the cluster.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/search-plugins/knn/api/#delete-model" - }, - "operationId": "KNNDeleteModel", - "parameters": [ - { - "name": "model_id", - "in": "path", - "description": "The id of the model.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The id of the model." - }, - "required": true - } - ], - "responses": { - "200": { - "description": "KNNDeleteModel 200 response" - } - }, - "x-operation-group": "knn.delete_model", - "x-version-added": "1.0" - }, - "get": { - "description": "Used to retrieve information about models present in the cluster.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/search-plugins/knn/api/#get-model" - }, - "operationId": "KNNGetModel", - "parameters": [ - { - "name": "model_id", - "in": "path", - "description": "The id of the model.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The id of the model." - }, - "required": true - } - ], - "responses": { - "200": { - "description": "KNNGetModel 200 response" - } - }, - "x-operation-group": "knn.get_model", - "x-version-added": "1.0" - } - }, - "/_plugins/_knn/models/{model_id}/_train": { - "post": { - "description": "Create and train a model that can be used for initializing k-NN native library indexes during indexing.", - "operationId": "KNNTrainModel_WithModelId", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KNNTrainModel_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "model_id", - "in": "path", - "description": "The id of the model.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The id of the model." - }, - "required": true - }, - { - "name": "preference", - "in": "query", - "description": "Preferred node to execute training.", - "schema": { - "type": "string", - "description": "Preferred node to execute training." - } - } - ], - "responses": { - "200": { - "description": "KNNTrainModel_WithModelId 200 response" - } - }, - "x-operation-group": "knn.train_model", - "x-version-added": "1.0" - } - }, - "/_plugins/_knn/stats": { - "get": { - "description": "Provides information about the current status of the k-NN plugin.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/search-plugins/knn/api/#stats" - }, - "operationId": "KNNStats", - "parameters": [ - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "KNNStats 200 response" - } - }, - "x-operation-group": "knn.stats", - "x-version-added": "1.0" - } - }, - "/_plugins/_knn/stats/{stat}": { - "get": { - "description": "Provides information about the current status of the k-NN plugin.", - "operationId": "KNNStats_WithStat", - "parameters": [ - { - "name": "stat", - "in": "path", - "description": "Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats.", - "x-enum-options": [ - "circuit_breaker_triggered", - "total_load_time", - "eviction_count", - "hit_count", - "miss_count", - "graph_memory_usage", - "graph_memory_usage_percentage", - "graph_index_requests", - "graph_index_errors", - "graph_query_requests", - "graph_query_errors", - "knn_query_requests", - "cache_capacity_reached", - "load_success_count", - "load_exception_count", - "indices_in_cache", - "script_compilations", - "script_compilation_errors", - "script_query_requests", - "script_query_errors", - "nmslib_initialized", - "faiss_initialized", - "model_index_status", - "indexing_from_model_degraded", - "training_requests", - "training_errors", - "training_memory_usage", - "training_memory_usage_percentage" - ], - "x-data-type": "array" - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "KNNStats_WithStat 200 response" - } - }, - "x-operation-group": "knn.stats", - "x-version-added": "1.0" - } - }, - "/_plugins/_knn/warmup/{index}": { - "get": { - "description": "Preloads native library files into memory, reducing initial search latency for specified indexes", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/search-plugins/knn/api/#warmup-operation" - }, - "operationId": "KNNWarmup", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "KNNWarmup 200 response" - } - }, - "x-operation-group": "knn.warmup", - "x-version-added": "1.0" - } - }, - "/_plugins/_knn/{node_id}/stats": { - "get": { - "description": "Provides information about the current status of the k-NN plugin.", - "operationId": "KNNStats_WithNodeId", - "parameters": [ - { - "name": "node_id", - "in": "path", - "description": "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.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "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.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "KNNStats_WithNodeId 200 response" - } - }, - "x-operation-group": "knn.stats", - "x-version-added": "1.0" - } - }, - "/_plugins/_knn/{node_id}/stats/{stat}": { - "get": { - "description": "Provides information about the current status of the k-NN plugin.", - "operationId": "KNNStats_WithStatNodeId", - "parameters": [ - { - "name": "node_id", - "in": "path", - "description": "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.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "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.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "stat", - "in": "path", - "description": "Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats.", - "x-enum-options": [ - "circuit_breaker_triggered", - "total_load_time", - "eviction_count", - "hit_count", - "miss_count", - "graph_memory_usage", - "graph_memory_usage_percentage", - "graph_index_requests", - "graph_index_errors", - "graph_query_requests", - "graph_query_errors", - "knn_query_requests", - "cache_capacity_reached", - "load_success_count", - "load_exception_count", - "indices_in_cache", - "script_compilations", - "script_compilation_errors", - "script_query_requests", - "script_query_errors", - "nmslib_initialized", - "faiss_initialized", - "model_index_status", - "indexing_from_model_degraded", - "training_requests", - "training_errors", - "training_memory_usage", - "training_memory_usage_percentage" - ], - "x-data-type": "array" - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "KNNStats_WithStatNodeId 200 response" - } - }, - "x-operation-group": "knn.stats", - "x-version-added": "1.0" - } - }, - "/_plugins/_notifications/configs": { - "delete": { - "description": "Delete channel configuration.", - "operationId": "NotificationsConfigs_Delete_WithQueryParams", - "parameters": [ - { - "name": "config_id", - "in": "query", - "description": "A channel ID.", - "schema": { - "type": "string", - "description": "A channel ID." - } - }, - { - "name": "config_id_list", - "in": "query", - "description": "A comma-separated list of channel IDs.", - "schema": { - "type": "string", - "description": "A comma-separated list of channel IDs." - } - } - ], - "responses": { - "200": { - "description": "NotificationsConfigs_Delete_WithQueryParams 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationsConfigs_Delete_WithQueryParamsResponseContent" - } - } - } - } - }, - "x-operation-group": "notifications.delete_config", - "x-version-added": "2.2" - }, - "get": { - "description": "Get channel configuration.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#get-channel-configuration" - }, - "operationId": "NotificationsConfigs_Get", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationsConfigs_GetRequestContent" - } - } - } - }, - "parameters": [ - { - "name": "last_updated_time_ms", - "in": "query", - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "created_time_ms", - "in": "query", - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "config_type", - "in": "query", - "description": "Type of notification configuration.", - "schema": { - "$ref": "#/components/schemas/NotificationConfigType" - } - }, - { - "name": "email.email_account_id", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "email.email_group_id_list", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "smtp_account.method", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ses_account.region", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "name", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "name.keyword", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "description", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "description.keyword", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "slack.url", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "slack.url.keyword", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "chime.url", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "chime.url.keyword", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "microsoft_teams.url", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "microsoft_teams.url.keyword", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "webhook.url", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "webhook.url.keyword", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "smtp_account.host", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "smtp_account.host.keyword", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "smtp_account.from_address", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "smtp_account.from_address.keyword", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "sns.topic_arn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "sns.topic_arn.keyword", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "sns.role_arn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "sns.role_arn.keyword", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ses_account.role_arn", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ses_account.role_arn.keyword", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ses_account.from_address", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ses_account.from_address.keyword", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "is_enabled", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "email.recipient_list.recipient", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "email.recipient_list.recipient.keyword", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "email_group.recipient_list.recipient", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "email_group.recipient_list.recipient.keyword", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "query", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "text_query", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "NotificationsConfigs_Get 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationsConfigs_GetResponseContent" - } - } - } - } - }, - "x-operation-group": "notifications.get_config", - "x-version-added": "2.0" - }, - "post": { - "description": "Create channel configuration.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#create-channel-configuration" - }, - "operationId": "NotificationsConfigs_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationsConfig" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "NotificationsConfigs_Post 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationsConfigs_PostResponseContent" - } - } - } - } - }, - "x-operation-group": "notifications.create_config", - "x-version-added": "2.0" - } - }, - "/_plugins/_notifications/configs/{config_id}": { - "delete": { - "description": "Delete channel configuration.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#delete-channel-configuration" - }, - "operationId": "NotificationsConfigs_Delete_WithPathParams", - "parameters": [ - { - "name": "config_id", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "NotificationsConfigs_Delete_WithPathParams 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationsConfigs_Delete_WithPathParamsResponseContent" - } - } - } - } - }, - "x-operation-group": "notifications.delete_config", - "x-version-added": "2.0" - }, - "get": { - "description": "Get channel configuration.", - "operationId": "NotificationsConfigsItem_Get", - "parameters": [ - { - "name": "config_id", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "NotificationsConfigsItem_Get 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationsConfigsItem_GetResponseContent" - } - } - } - } - }, - "x-operation-group": "notifications.get_config", - "x-version-added": "2.0" - }, - "put": { - "description": "Update channel configuration.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#update-channel-configuration" - }, - "operationId": "NotificationsConfigs_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationsConfig" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "config_id", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "NotificationsConfigs_Put 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationsConfigs_PutResponseContent" - } - } - } - } - }, - "x-operation-group": "notifications.update_config", - "x-version-added": "2.0" - } - }, - "/_plugins/_notifications/feature/test/{config_id}": { - "get": { - "description": "Send a test notification.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#send-test-notification" - }, - "operationId": "NotificationsFeatureTest_Get", - "deprecated": true, - "parameters": [ - { - "name": "config_id", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "NotificationsFeatureTest_Get 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationsFeatureTest_GetResponseContent" - } - } - } - } - }, - "x-deprecation-message": "Use the POST method instead.", - "x-operation-group": "notifications.send_test", - "x-version-added": "2.0", - "x-version-deprecated": "2.3" - }, - "post": { - "description": "Send a test notification.", - "operationId": "NotificationsFeatureTest_Post", - "parameters": [ - { - "name": "config_id", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "NotificationsFeatureTest_Post 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationsFeatureTest_PostResponseContent" - } - } - } - } - }, - "x-operation-group": "notifications.send_test", - "x-version-added": "2.0" - } - }, - "/_plugins/_notifications/features": { - "get": { - "description": "List supported channel configurations.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-supported-channel-configurations" - }, - "operationId": "NotificationsFeatures_Get", - "responses": { - "200": { - "description": "NotificationsFeatures_Get 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationsFeatures_GetResponseContent" - } - } - } - } - }, - "x-operation-group": "notifications.list_features", - "x-version-added": "2.0" - } - }, - "/_plugins/_security/api/account": { - "get": { - "description": "Returns account details for the current user.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-account-details" - }, - "operationId": "GetAccountDetails", - "responses": { - "200": { - "description": "GetAccountDetails 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AccountDetails" - } - } - } - } - }, - "x-operation-group": "security.get_account_details", - "x-version-added": "1.0" - }, - "put": { - "description": "Changes the password for the current user.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#change-password" - }, - "operationId": "ChangePassword", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangePasswordRequestContent" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "ChangePassword 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChangePasswordResponseContent" - } - } - } - } - }, - "x-operation-group": "security.change_password", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/actiongroups": { - "get": { - "description": "Retrieves all action groups.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-action-groups" - }, - "operationId": "GetActionGroups", - "responses": { - "200": { - "description": "GetActionGroups 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActionGroupsMap" - } - } - } - } - }, - "x-operation-group": "security.get_action_groups", - "x-version-added": "1.0" - }, - "patch": { - "description": "Creates, updates, or deletes multiple action groups in a single call.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#patch-action-groups" - }, - "operationId": "PatchActionGroups", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchActionGroupsInputPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "PatchActionGroups 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchActionGroupsResponseContent" - } - } - } - } - }, - "x-operation-group": "security.patch_action_groups", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/actiongroups/{action_group}": { - "delete": { - "description": "Delete a specified action group.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group" - }, - "operationId": "DeleteActionGroup", - "parameters": [ - { - "name": "action_group", - "in": "path", - "description": "Action group to delete.", - "schema": { - "type": "string", - "description": "Action group to delete." - }, - "required": true - } - ], - "responses": { - "200": { - "description": "DeleteActionGroup 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeleteActionGroupResponseContent" - } - } - } - } - }, - "x-operation-group": "security.delete_action_group", - "x-version-added": "1.0" - }, - "get": { - "description": "Retrieves one action group.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-action-group" - }, - "operationId": "GetActionGroup", - "parameters": [ - { - "name": "action_group", - "in": "path", - "description": "Action group to retrieve.", - "schema": { - "type": "string", - "description": "Action group to retrieve." - }, - "required": true - } - ], - "responses": { - "200": { - "description": "GetActionGroup 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ActionGroupsMap" - } - } - } - } - }, - "x-operation-group": "security.get_action_group", - "x-version-added": "1.0" - }, - "patch": { - "description": "Updates individual attributes of an action group.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#patch-action-group" - }, - "operationId": "PatchActionGroup", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchActionGroupInputPayload" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "action_group", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "PatchActionGroup 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchActionGroupResponseContent" - } - } - } - } - }, - "x-operation-group": "security.patch_action_group", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or replaces the specified action group.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#create-action-group" - }, - "operationId": "CreateActionGroup", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Action_Group" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "action_group", - "in": "path", - "description": "The name of the action group to create or replace", - "schema": { - "type": "string", - "description": "The name of the action group to create or replace" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "CreateActionGroup 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateActionGroupResponseContent" - } - } - } - } - }, - "x-operation-group": "security.create_action_group", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/audit": { - "get": { - "description": "Retrieves the audit configuration.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#audit-logs" - }, - "operationId": "GetAuditConfiguration", - "responses": { - "200": { - "description": "GetAuditConfiguration 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AuditConfigWithReadOnly" - } - } - } - } - }, - "x-operation-group": "security.get_audit_configuration", - "x-version-added": "1.0" - }, - "patch": { - "description": "A PATCH call is used to update specified fields in the audit configuration.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#audit-logs" - }, - "operationId": "PatchAuditConfiguration", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchAuditConfigurationInputPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "PatchAuditConfiguration 200 response" - } - }, - "x-operation-group": "security.patch_audit_configuration", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/audit/config": { - "put": { - "description": "Updates the audit configuration.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#audit-logs" - }, - "operationId": "UpdateAuditConfiguration", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AuditConfig" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "UpdateAuditConfiguration 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateAuditConfigurationResponseContent" - } - } - } - } - }, - "x-operation-group": "security.update_audit_configuration", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/cache": { - "delete": { - "description": "Flushes the Security plugin user, authentication, and authorization cache.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/2.7/security/access-control/api/#flush-cache" - }, - "operationId": "FlushCache", - "responses": { - "200": { - "description": "FlushCache 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FlushCacheResponseContent" - } - } - } - } - }, - "x-operation-group": "security.flush_cache", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/internalusers": { - "get": { - "description": "Retrieve all internal users.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-users" - }, - "operationId": "GetUsers", - "responses": { - "200": { - "description": "GetUsers 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UsersMap" - } - } - } - } - }, - "x-operation-group": "security.get_users", - "x-version-added": "1.0" - }, - "patch": { - "description": "Creates, updates, or deletes multiple internal users in a single call.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#patch-users" - }, - "operationId": "PatchUsers", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchUsersInputPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "PatchUsers 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchUsersResponseContent" - } - } - } - } - }, - "x-operation-group": "security.patch_users", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/internalusers/{username}": { - "delete": { - "description": "Delete the specified user.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#delete-user" - }, - "operationId": "DeleteUser", - "parameters": [ - { - "name": "username", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "DeleteUser 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeleteUserResponseContent" - } - } - } - } - }, - "x-operation-group": "security.delete_user", - "x-version-added": "1.0" - }, - "get": { - "description": "Retrieve one internal user.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-user" - }, - "operationId": "GetUser", - "parameters": [ - { - "name": "username", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "GetUser 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UsersMap" - } - } - } - } - }, - "x-operation-group": "security.get_user", - "x-version-added": "1.0" - }, - "patch": { - "description": "Updates individual attributes of an internal user.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#patch-user" - }, - "operationId": "PatchUser", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchUserInputPayload" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "username", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "PatchUser 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchUserResponseContent" - } - } - } - } - }, - "x-operation-group": "security.patch_user", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or replaces the specified user.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#create-user" - }, - "operationId": "CreateUser", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "username", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "CreateUser 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateUserResponseContent" - } - } - } - } - }, - "x-operation-group": "security.create_user", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/nodesdn": { - "get": { - "description": "Retrieves all distinguished names in the allow list.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names" - }, - "operationId": "GetDistinguishedNames", - "responses": { - "200": { - "description": "GetDistinguishedNames 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DistinguishedNamesMap" - } - } - } - } - }, - "x-operation-group": "security.get_distinguished_names", - "x-version-added": "1.0" - }, - "patch": { - "description": "Bulk update of distinguished names.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#update-all-distinguished-names" - }, - "operationId": "PatchDistinguishedNames", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchDistinguishedNamesInputPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "PatchDistinguishedNames 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchDistinguishedNamesResponseContent" - } - } - } - } - }, - "x-operation-group": "security.patch_distinguished_names", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/nodesdn/{cluster_name}": { - "delete": { - "description": "Deletes all distinguished names in the specified cluster’s or node’s allow list.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names" - }, - "operationId": "DeleteDistinguishedNames", - "parameters": [ - { - "name": "cluster_name", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "DeleteDistinguishedNames 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeleteDistinguishedNamesResponseContent" - } - } - } - } - }, - "x-operation-group": "security.delete_distinguished_names", - "x-version-added": "1.0" - }, - "get": { - "description": "Retrieve distinguished names of a specified cluster.", - "operationId": "GetDistinguishedNamesWithClusterName", - "parameters": [ - { - "name": "cluster_name", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "GetDistinguishedNamesWithClusterName 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DistinguishedNamesMap" - } - } - } - } - }, - "x-operation-group": "security.get_distinguished_names", - "x-version-added": "1.0" - }, - "put": { - "description": "Adds or updates the specified distinguished names in the cluster’s or node’s allow list.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names" - }, - "operationId": "UpdateDistinguishedNames", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DistinguishedNames" - } - } - } - }, - "parameters": [ - { - "name": "cluster_name", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "UpdateDistinguishedNames 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateDistinguishedNamesResponseContent" - } - } - } - } - }, - "x-operation-group": "security.update_distinguished_names", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/roles": { - "patch": { - "description": "Creates, updates, or deletes multiple roles in a single call.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#patch-roles" - }, - "operationId": "PatchRoles", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchRolesInputPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "PatchRoles 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchRolesResponseContent" - } - } - } - } - }, - "x-operation-group": "security.patch_roles", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/roles/": { - "get": { - "description": "Retrieves all roles.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-roles" - }, - "operationId": "GetRoles", - "responses": { - "200": { - "description": "GetRoles 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RolesMap" - } - } - } - } - }, - "x-operation-group": "security.get_roles", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/roles/{role}": { - "delete": { - "description": "Delete the specified role.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#delete-role" - }, - "operationId": "DeleteRole", - "parameters": [ - { - "name": "role", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "DeleteRole 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeleteRoleResponseContent" - } - } - } - } - }, - "x-operation-group": "security.delete_role", - "x-version-added": "1.0" - }, - "get": { - "description": "Retrieves one role.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-role" - }, - "operationId": "GetRole", - "parameters": [ - { - "name": "role", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "GetRole 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RolesMap" - } - } - } - } - }, - "x-operation-group": "security.get_role", - "x-version-added": "1.0" - }, - "patch": { - "description": "Updates individual attributes of a role.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#patch-role" - }, - "operationId": "PatchRole", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchRoleInputPayload" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "role", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "PatchRole 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchRoleResponseContent" - } - } - } - } - }, - "x-operation-group": "security.patch_role", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or replaces the specified role.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#create-role" - }, - "operationId": "CreateRole", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Role" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "role", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "CreateRole 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateRoleResponseContent" - } - } - } - } - }, - "x-operation-group": "security.create_role", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/rolesmapping": { - "get": { - "description": "Retrieves all role mappings.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-role-mappings" - }, - "operationId": "GetRoleMappings", - "responses": { - "200": { - "description": "GetRoleMappings 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RoleMappings" - } - } - } - } - }, - "x-operation-group": "security.get_role_mappings", - "x-version-added": "1.0" - }, - "patch": { - "description": "Creates or updates multiple role mappings in a single call.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mappings" - }, - "operationId": "PatchRoleMappings", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchRoleMappingsInputPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "PatchRoleMappings 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchRoleMappingsResponseContent" - } - } - } - } - }, - "x-operation-group": "security.patch_role_mappings", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/rolesmapping/{role}": { - "delete": { - "description": "Deletes the specified role mapping.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping" - }, - "operationId": "DeleteRoleMapping", - "parameters": [ - { - "name": "role", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "DeleteRoleMapping 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeleteRoleMappingResponseContent" - } - } - } - } - }, - "x-operation-group": "security.delete_role_mapping", - "x-version-added": "1.0" - }, - "get": { - "description": "Retrieves one role mapping.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping" - }, - "operationId": "GetRoleMapping", - "parameters": [ - { - "name": "role", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "GetRoleMapping 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RoleMappings" - } - } - } - } - }, - "x-operation-group": "security.get_role_mapping", - "x-version-added": "1.0" - }, - "patch": { - "description": "Updates individual attributes of a role mapping.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mapping" - }, - "operationId": "PatchRoleMapping", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchRoleMappingInputPayload" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "role", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "PatchRoleMapping 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchRoleMappingResponseContent" - } - } - } - } - }, - "x-operation-group": "security.patch_role_mapping", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or replaces the specified role mapping.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping" - }, - "operationId": "CreateRoleMapping", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RoleMapping" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "role", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "CreateRoleMapping 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateRoleMappingResponseContent" - } - } - } - } - }, - "x-operation-group": "security.create_role_mapping", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/securityconfig": { - "get": { - "description": "Returns the current Security plugin configuration in JSON format.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/2.7/security/access-control/api/#get-configuration" - }, - "operationId": "GetConfiguration", - "responses": { - "200": { - "description": "GetConfiguration 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DynamicConfig" - } - } - } - } - }, - "x-operation-group": "security.get_configuration", - "x-version-added": "1.0" - }, - "patch": { - "description": "A PATCH call is used to update the existing configuration using the REST API.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/2.7/security/access-control/api/#patch-configuration" - }, - "operationId": "PatchConfiguration", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchConfigurationInputPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "PatchConfiguration 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchConfigurationResponseContent" - } - } - } - } - }, - "x-operation-group": "security.patch_configuration", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/securityconfig/config": { - "put": { - "description": "Adds or updates the existing configuration using the REST API.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/2.7/security/access-control/api/#update-configuration" - }, - "operationId": "UpdateConfiguration", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DynamicConfig" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "UpdateConfiguration 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateConfigurationResponseContent" - } - } - } - } - }, - "x-operation-group": "security.update_configuration", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/ssl/certs": { - "get": { - "description": "Retrieves the cluster’s security certificates.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#get-certificates" - }, - "operationId": "GetCertificates", - "responses": { - "200": { - "description": "GetCertificates 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetCertificatesResponseContent" - } - } - } - } - }, - "x-operation-group": "security.get_certificates", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/ssl/http/reloadcerts": { - "put": { - "description": "Reload HTTP layer communication certificates.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates" - }, - "operationId": "ReloadHttpCertificates", - "responses": { - "200": { - "description": "ReloadHttpCertificates 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReloadHttpCertificatesResponseContent" - } - } - } - } - }, - "x-operation-group": "security.reload_http_certificates", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/ssl/transport/reloadcerts": { - "put": { - "description": "Reload transport layer communication certificates.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates" - }, - "operationId": "ReloadTransportCertificates", - "responses": { - "200": { - "description": "ReloadTransportCertificates 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ReloadTransportCertificatesResponseContent" - } - } - } - } - }, - "x-operation-group": "security.reload_transport_certificates", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/tenants/": { - "get": { - "description": "Retrieves all tenants.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/2.7/security/access-control/api/#get-tenants" - }, - "operationId": "GetTenants", - "responses": { - "200": { - "description": "GetTenants 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantsMap" - } - } - } - } - }, - "x-operation-group": "security.get_tenants", - "x-version-added": "1.0" - }, - "patch": { - "description": "Add, delete, or modify multiple tenants in a single call.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/2.7/security/access-control/api/#patch-tenants" - }, - "operationId": "PatchTenants", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchTenantsInputPayload" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "PatchTenants 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchTenantsResponseContent" - } - } - } - } - }, - "x-operation-group": "security.patch_tenants", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/api/tenants/{tenant}": { - "delete": { - "description": "Delete the specified tenant.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group" - }, - "operationId": "DeleteTenant", - "parameters": [ - { - "name": "tenant", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "DeleteTenant 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeleteTenantResponseContent" - } - } - } - } - }, - "x-operation-group": "security.delete_tenant", - "x-version-added": "1.0" - }, - "get": { - "description": "Retrieves one tenant.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/2.7/security/access-control/api/#get-tenant" - }, - "operationId": "GetTenant", - "parameters": [ - { - "name": "tenant", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "GetTenant 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TenantsMap" - } - } - } - } - }, - "x-operation-group": "security.get_tenant", - "x-version-added": "1.0" - }, - "patch": { - "description": "Add, delete, or modify a single tenant.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/2.7/security/access-control/api/#patch-tenant" - }, - "operationId": "PatchTenant", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchTenantInputPayload" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "tenant", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "PatchTenant 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchTenantResponseContent" - } - } - } - } - }, - "x-operation-group": "security.patch_tenant", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or replaces the specified tenant.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/2.7/security/access-control/api/#create-tenant" - }, - "operationId": "CreateTenant", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateTenantParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "tenant", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "CreateTenant 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateTenantResponseContent" - } - } - } - } - }, - "x-operation-group": "security.create_tenant", - "x-version-added": "1.0" - } - }, - "/_plugins/_security/health": { - "get": { - "description": "Checks to see if the Security plugin is up and running.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/security/access-control/api/#health-check" - }, - "operationId": "SecurityHealth", - "responses": { - "200": { - "description": "SecurityHealth 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SecurityHealthResponseContent" - } - } - } - } - }, - "x-operation-group": "security.health", - "x-version-added": "1.0" - } - }, - "/_rank_eval": { - "get": { - "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/rank-eval/" - }, - "operationId": "RankEval_Get", - "parameters": [ - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchType" - } - } - ], - "responses": { - "200": { - "description": "RankEval_Get 200 response" - } - }, - "x-operation-group": "rank_eval", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries.", - "operationId": "RankEval_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RankEval_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchType" - } - } - ], - "responses": { - "200": { - "description": "RankEval_Post 200 response" - } - }, - "x-operation-group": "rank_eval", - "x-version-added": "1.0" - } - }, - "/_recovery": { - "get": { - "description": "Returns information about ongoing index shard recoveries.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesRecovery", - "parameters": [ - { - "name": "detailed", - "in": "query", - "description": "Whether to display detailed information about shard recovery.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to display detailed information about shard recovery." - } - }, - { - "name": "active_only", - "in": "query", - "description": "Display only those recoveries that are currently on-going.", - "schema": { - "type": "boolean", - "default": false, - "description": "Display only those recoveries that are currently on-going." - } - } - ], - "responses": { - "200": { - "description": "IndicesRecovery 200 response" - } - }, - "x-operation-group": "indices.recovery", - "x-version-added": "1.0" - } - }, - "/_refresh": { - "get": { - "description": "Performs the refresh operation in one or more indices.", - "operationId": "IndicesRefresh_Get", - "parameters": [ - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesRefresh_Get 200 response" - } - }, - "x-operation-group": "indices.refresh", - "x-version-added": "1.0" - }, - "post": { - "description": "Performs the refresh operation in one or more indices.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability" - }, - "operationId": "IndicesRefresh_Post", - "parameters": [ - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesRefresh_Post 200 response" - } - }, - "x-operation-group": "indices.refresh", - "x-version-added": "1.0" - } - }, - "/_reindex": { - "post": { - "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.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/im-plugin/reindex-data/" - }, - "operationId": "Reindex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Reindex_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "refresh", - "in": "query", - "description": "Should the affected indexes be refreshed?.", - "schema": { - "type": "boolean", - "description": "Should the affected indexes be refreshed?." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Time each individual bulk request should wait for shards that are unavailable.", - "schema": { - "type": "string", - "default": "1m", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Time each individual bulk request should wait for shards that are unavailable.", - "x-data-type": "time" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the 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).", - "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the 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_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": true, - "description": "Should this request wait until the operation has completed before returning." - } - }, - { - "name": "requests_per_second", - "in": "query", - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "schema": { - "type": "integer", - "default": 0, - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "format": "int32" - } - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "slices", - "in": "query", - "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`.", - "schema": { - "type": "string", - "default": "1", - "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": "max_docs", - "in": "query", - "description": "Maximum number of documents to process (default: all documents).", - "schema": { - "type": "integer", - "description": "Maximum number of documents to process (default: all documents).", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Reindex 200 response" - } - }, - "x-operation-group": "reindex", - "x-version-added": "1.0" - } - }, - "/_reindex/{task_id}/_rethrottle": { - "post": { - "description": "Changes the number of requests per second for a particular Reindex operation.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "ReindexRethrottle", - "parameters": [ - { - "name": "task_id", - "in": "path", - "description": "The task id to rethrottle.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The task id to rethrottle." - }, - "required": true - }, - { - "name": "requests_per_second", - "in": "query", - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "schema": { - "type": "integer", - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "format": "int32" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "ReindexRethrottle 200 response" - } - }, - "x-operation-group": "reindex_rethrottle", - "x-version-added": "1.0" - } - }, - "/_remote/info": { - "get": { - "description": "Returns the information about configured remote clusters.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/remote-info/" - }, - "operationId": "ClusterRemoteInfo", - "responses": { - "200": { - "description": "ClusterRemoteInfo 200 response" - } - }, - "x-operation-group": "cluster.remote_info", - "x-version-added": "1.0" - } - }, - "/_remotestore/_restore": { - "post": { - "description": "Restores from remote store.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/opensearch/remote/#restoring-from-a-backup" - }, - "operationId": "RemoteStoreRestore", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RemoteStoreRestore_BodyParams" - }, - "examples": { - "RemoteStoreRestore_example1": { - "summary": "Examples for Post Remote Storage Restore Operation.", - "description": "", - "value": { - "indices": [ - "books" - ] - } - } - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": false, - "description": "Should this request wait until the operation has completed before returning." - } - } - ], - "responses": { - "200": { - "description": "RemoteStoreRestore 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RemoteStoreRestoreResponseContent" - }, - "examples": { - "RemoteStoreRestore_example1": { - "summary": "Examples for Post Remote Storage Restore Operation.", - "description": "", - "value": { - "remote_store": { - "indices": [ - "books" - ], - "shards": { - "total": 1, - "failed": 0, - "successful": 1 - } - } - } - } - } - } - } - } - }, - "x-operation-group": "remote_store.restore", - "x-version-added": "1.0" - } - }, - "/_render/template": { - "get": { - "description": "Allows to use the Mustache language to pre-render a search definition.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/search-plugins/search-template/" - }, - "operationId": "RenderSearchTemplate_Get", - "responses": { - "200": { - "description": "RenderSearchTemplate_Get 200 response" - } - }, - "x-operation-group": "render_search_template", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to use the Mustache language to pre-render a search definition.", - "operationId": "RenderSearchTemplate_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RenderSearchTemplate_BodyParams" - } - } - } - }, - "responses": { - "200": { - "description": "RenderSearchTemplate_Post 200 response" - } - }, - "x-operation-group": "render_search_template", - "x-version-added": "1.0" - } - }, - "/_render/template/{id}": { - "get": { - "description": "Allows to use the Mustache language to pre-render a search definition.", - "operationId": "RenderSearchTemplate_Get_WithId", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the stored search template.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The id of the stored search template." - }, - "required": true - } - ], - "responses": { - "200": { - "description": "RenderSearchTemplate_Get_WithId 200 response" - } - }, - "x-operation-group": "render_search_template", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to use the Mustache language to pre-render a search definition.", - "operationId": "RenderSearchTemplate_Post_WithId", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RenderSearchTemplate_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The id of the stored search template.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The id of the stored search template." - }, - "required": true - } - ], - "responses": { - "200": { - "description": "RenderSearchTemplate_Post_WithId 200 response" - } - }, - "x-operation-group": "render_search_template", - "x-version-added": "1.0" - } - }, - "/_resolve/index/{name}": { - "get": { - "description": "Returns information about any matching indices, aliases, and data streams.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesResolveIndex", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Comma-separated list of names or wildcard expressions.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of names or wildcard expressions.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesResolveIndex 200 response" - } - }, - "x-operation-group": "indices.resolve_index", - "x-version-added": "1.0" - } - }, - "/_script_context": { - "get": { - "description": "Returns all script contexts.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/script-apis/get-script-contexts/" - }, - "operationId": "GetScriptContext", - "responses": { - "200": { - "description": "GetScriptContext 200 response" - } - }, - "x-operation-group": "get_script_context", - "x-version-added": "1.0" - } - }, - "/_script_language": { - "get": { - "description": "Returns available script types, languages and contexts.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/script-apis/get-script-language/" - }, - "operationId": "GetScriptLanguages", - "responses": { - "200": { - "description": "GetScriptLanguages 200 response" - } - }, - "x-operation-group": "get_script_languages", - "x-version-added": "1.0" - } - }, - "/_scripts/painless/_execute": { - "get": { - "description": "Allows an arbitrary script to be executed and a result to be returned.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/" - }, - "operationId": "ScriptsPainlessExecute_Get", - "responses": { - "200": { - "description": "ScriptsPainlessExecute_Get 200 response" - } - }, - "x-operation-group": "scripts_painless_execute", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows an arbitrary script to be executed and a result to be returned.", - "operationId": "ScriptsPainlessExecute_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ScriptsPainlessExecute_BodyParams" - } - } - } - }, - "responses": { - "200": { - "description": "ScriptsPainlessExecute_Post 200 response" - } - }, - "x-operation-group": "scripts_painless_execute", - "x-version-added": "1.0" - } - }, - "/_scripts/{id}": { - "delete": { - "description": "Deletes a script.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/script-apis/delete-script/" - }, - "operationId": "DeleteScript", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Script ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Script ID." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "DeleteScript 200 response" - } - }, - "x-operation-group": "delete_script", - "x-version-added": "1.0" - }, - "get": { - "description": "Returns a script.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/script-apis/get-stored-script/" - }, - "operationId": "GetScript", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Script ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Script ID." - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "GetScript 200 response" - } - }, - "x-operation-group": "get_script", - "x-version-added": "1.0" - }, - "post": { - "description": "Creates or updates a script.", - "operationId": "PutScript_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PutScript_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Script ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Script ID." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "PutScript_Post 200 response" - } - }, - "x-operation-group": "put_script", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or updates a script.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/" - }, - "operationId": "PutScript_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PutScript_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Script ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Script ID." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "PutScript_Put 200 response" - } - }, - "x-operation-group": "put_script", - "x-version-added": "1.0" - } - }, - "/_scripts/{id}/{context}": { - "post": { - "description": "Creates or updates a script.", - "operationId": "PutScript_Post_WithContext", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PutScript_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Script ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Script ID." - }, - "required": true - }, - { - "name": "context", - "in": "path", - "description": "Script context.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Script context." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "PutScript_Post_WithContext 200 response" - } - }, - "x-operation-group": "put_script", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or updates a script.", - "operationId": "PutScript_Put_WithContext", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PutScript_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Script ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Script ID." - }, - "required": true - }, - { - "name": "context", - "in": "path", - "description": "Script context.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Script context." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "PutScript_Put_WithContext 200 response" - } - }, - "x-operation-group": "put_script", - "x-version-added": "1.0" - } - }, - "/_search": { - "get": { - "description": "Returns results matching a query.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/search/" - }, - "operationId": "Search_Get", - "parameters": [ - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "explain", - "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." - } - }, - { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true - }, - { - "name": "docvalue_fields", - "in": "query", - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit." - }, - "explode": true - }, - { - "name": "from", - "in": "query", - "description": "Starting offset.", - "schema": { - "type": "integer", - "default": 0, - "description": "Starting offset.", - "format": "int32" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchType" - } - }, - { - "name": "size", - "in": "query", - "description": "Number of hits to return.", - "schema": { - "type": "integer", - "default": 10, - "description": "Number of hits to return.", - "format": "int32" - } - }, - { - "name": "sort", - "in": "query", - "description": "Comma-separated list of : pairs.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of : pairs." - }, - "explode": true - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - }, - { - "name": "terminate_after", - "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" - } - }, - { - "name": "stats", - "in": "query", - "description": "Specific 'tag' of the request for logging and statistical purposes.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specific 'tag' of the request for logging and statistical purposes." - }, - "explode": true - }, - { - "name": "suggest_field", - "in": "query", - "description": "Specify which field to use for suggestions.", - "schema": { - "type": "string", - "description": "Specify which field to use for suggestions." - } - }, - { - "name": "suggest_mode", - "in": "query", - "description": "Specify suggest mode.", - "schema": { - "$ref": "#/components/schemas/SuggestMode" - } - }, - { - "name": "suggest_size", - "in": "query", - "description": "How many suggestions to return in response.", - "schema": { - "type": "integer", - "description": "How many suggestions to return in response.", - "format": "int32" - } - }, - { - "name": "suggest_text", - "in": "query", - "description": "The source text for which the suggestions should be returned.", - "schema": { - "type": "string", - "description": "The source text for which the suggestions should be returned." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "track_scores", - "in": "query", - "description": "Whether to calculate and return scores even if they are not used for sorting.", - "schema": { - "type": "boolean", - "description": "Whether to calculate and return scores even if they are not used for sorting." - } - }, - { - "name": "track_total_hits", - "in": "query", - "description": "Indicate if the number of documents that match the query should be tracked.", - "schema": { - "type": "boolean", - "description": "Indicate if the number of documents that match the query should be tracked." - } - }, - { - "name": "allow_partial_search_results", - "in": "query", - "description": "Indicate if an error should be returned if there is a partial search failure or timeout.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicate if an error should be returned if there is a partial search failure or timeout." - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "version", - "in": "query", - "description": "Whether to return document version as part of a hit.", - "schema": { - "type": "boolean", - "description": "Whether to return document version as part of a hit." - } - }, - { - "name": "seq_no_primary_term", - "in": "query", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit." - } - }, - { - "name": "request_cache", - "in": "query", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", - "schema": { - "type": "boolean", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting." - } - }, - { - "name": "batched_reduce_size", - "in": "query", - "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.", - "schema": { - "type": "integer", - "default": 512, - "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.", - "format": "int32" - } - }, - { - "name": "max_concurrent_shard_requests", - "in": "query", - "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.", - "schema": { - "type": "integer", - "default": 5, - "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.", - "format": "int32" - } - }, - { - "name": "pre_filter_shard_size", - "in": "query", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "schema": { - "type": "integer", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "format": "int32" - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "search_pipeline", - "in": "query", - "description": "Customizable sequence of processing stages applied to search queries.", - "schema": { - "type": "string", - "description": "Customizable sequence of processing stages applied to search queries." - } - }, - { - "name": "include_named_queries_score", - "in": "query", - "description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)" - } - } - ], - "responses": { - "200": { - "description": "Search_Get 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search_GetResponseContent" - } - } - } - } - }, - "x-operation-group": "search", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns results matching a query.", - "operationId": "Search_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search_BodyParams" - }, - "examples": { - "Search_Post_example1": { - "summary": "Examples for Post Search Operation.", - "description": "", - "value": { - "query": { - "match_all": {} - }, - "fields": [ - "*" - ] - } - } - } - } - } - }, - "parameters": [ - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "explain", - "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." - } - }, - { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true - }, - { - "name": "docvalue_fields", - "in": "query", - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit." - }, - "explode": true - }, - { - "name": "from", - "in": "query", - "description": "Starting offset.", - "schema": { - "type": "integer", - "default": 0, - "description": "Starting offset.", - "format": "int32" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - }, - "examples": { - "Search_Post_example1": { - "summary": "Examples for Post Search Operation.", - "description": "", - "value": "1d" - } - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchType" - } - }, - { - "name": "size", - "in": "query", - "description": "Number of hits to return.", - "schema": { - "type": "integer", - "default": 10, - "description": "Number of hits to return.", - "format": "int32" - } - }, - { - "name": "sort", - "in": "query", - "description": "Comma-separated list of : pairs.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of : pairs." - }, - "explode": true - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - }, - { - "name": "terminate_after", - "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" - } - }, - { - "name": "stats", - "in": "query", - "description": "Specific 'tag' of the request for logging and statistical purposes.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specific 'tag' of the request for logging and statistical purposes." - }, - "explode": true - }, - { - "name": "suggest_field", - "in": "query", - "description": "Specify which field to use for suggestions.", - "schema": { - "type": "string", - "description": "Specify which field to use for suggestions." - } - }, - { - "name": "suggest_mode", - "in": "query", - "description": "Specify suggest mode.", - "schema": { - "$ref": "#/components/schemas/SuggestMode" - } - }, - { - "name": "suggest_size", - "in": "query", - "description": "How many suggestions to return in response.", - "schema": { - "type": "integer", - "description": "How many suggestions to return in response.", - "format": "int32" - } - }, - { - "name": "suggest_text", - "in": "query", - "description": "The source text for which the suggestions should be returned.", - "schema": { - "type": "string", - "description": "The source text for which the suggestions should be returned." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "track_scores", - "in": "query", - "description": "Whether to calculate and return scores even if they are not used for sorting.", - "schema": { - "type": "boolean", - "description": "Whether to calculate and return scores even if they are not used for sorting." - } - }, - { - "name": "track_total_hits", - "in": "query", - "description": "Indicate if the number of documents that match the query should be tracked.", - "schema": { - "type": "boolean", - "description": "Indicate if the number of documents that match the query should be tracked." - } - }, - { - "name": "allow_partial_search_results", - "in": "query", - "description": "Indicate if an error should be returned if there is a partial search failure or timeout.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicate if an error should be returned if there is a partial search failure or timeout." - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "version", - "in": "query", - "description": "Whether to return document version as part of a hit.", - "schema": { - "type": "boolean", - "description": "Whether to return document version as part of a hit." - } - }, - { - "name": "seq_no_primary_term", - "in": "query", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit." - } - }, - { - "name": "request_cache", - "in": "query", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", - "schema": { - "type": "boolean", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting." - } - }, - { - "name": "batched_reduce_size", - "in": "query", - "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.", - "schema": { - "type": "integer", - "default": 512, - "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.", - "format": "int32" - } - }, - { - "name": "max_concurrent_shard_requests", - "in": "query", - "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.", - "schema": { - "type": "integer", - "default": 5, - "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.", - "format": "int32" - } - }, - { - "name": "pre_filter_shard_size", - "in": "query", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "schema": { - "type": "integer", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "format": "int32" - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "search_pipeline", - "in": "query", - "description": "Customizable sequence of processing stages applied to search queries.", - "schema": { - "type": "string", - "description": "Customizable sequence of processing stages applied to search queries." - } - }, - { - "name": "include_named_queries_score", - "in": "query", - "description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)" - } - } - ], - "responses": { - "200": { - "description": "Search_Post 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search_PostResponseContent" - }, - "examples": { - "Search_Post_example1": { - "summary": "Examples for Post Search Operation.", - "description": "", - "value": { - "timed_out": false, - "_shards": { - "total": 1, - "successful": 1, - "skipped": 0, - "failed": 0 - }, - "hits": { - "total": { - "value": 0, - "relation": "eq" - }, - "hits": [] - } - } - } - } - } - } - } - }, - "x-operation-group": "search", - "x-version-added": "1.0" - } - }, - "/_search/pipeline/{pipeline}": { - "get": { - "description": "Retrieves information about a specified search pipeline.", - "operationId": "GetSearchPipeline", - "parameters": [ - { - "name": "pipeline", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "GetSearchPipeline 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SearchPipelineMap" - } - } - } - } - }, - "x-operation-group": "search_pipeline.get", - "x-version-added": "2.9" - }, - "put": { - "description": "Creates or replaces the specified search pipeline.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/search-plugins/search-pipelines/creating-search-pipeline/" - }, - "operationId": "CreateSearchPipeline", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SearchPipelineStructure" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "pipeline", - "in": "path", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "CreateSearchPipeline 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateSearchPipelineResponseContent" - } - } - } - } - }, - "x-operation-group": "search_pipeline.create", - "x-version-added": "2.9" - } - }, - "/_search/point_in_time": { - "delete": { - "description": "Deletes one or more point in time searches based on the IDs passed.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits" - }, - "operationId": "DeletePit", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeletePit_BodyParams" - } - } - } - }, - "responses": { - "200": { - "description": "DeletePit 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeletePitResponseContent" - } - } - } - } - }, - "x-operation-group": "delete_pit", - "x-version-added": "2.4" - } - }, - "/_search/point_in_time/_all": { - "delete": { - "description": "Deletes all active point in time searches.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits" - }, - "operationId": "DeleteAllPits", - "responses": { - "200": { - "description": "DeleteAllPits 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeleteAllPitsResponseContent" - } - } - } - } - }, - "x-operation-group": "delete_all_pits", - "x-version-added": "2.4" - }, - "get": { - "description": "Lists all active point in time searches.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#list-all-pits" - }, - "operationId": "GetAllPits", - "responses": { - "200": { - "description": "GetAllPits 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetAllPitsResponseContent" - } - } - } - } - }, - "x-operation-group": "get_all_pits", - "x-version-added": "2.4" - } - }, - "/_search/scroll": { - "delete": { - "description": "Explicitly clears the search context for a scroll.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/scroll/" - }, - "operationId": "ClearScroll", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClearScroll_BodyParams" - } - } - } - }, - "responses": { - "200": { - "description": "ClearScroll 200 response" - } - }, - "x-operation-group": "clear_scroll", - "x-version-added": "1.0" - }, - "get": { - "description": "Allows to retrieve a large numbers of results from a single search request.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods" - }, - "operationId": "Scroll_Get", - "parameters": [ - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "scroll_id", - "in": "query", - "description": "Scroll ID.", - "schema": { - "type": "string", - "description": "Scroll ID." - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - } - ], - "responses": { - "200": { - "description": "Scroll_Get 200 response" - } - }, - "x-operation-group": "scroll", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to retrieve a large numbers of results from a single search request.", - "operationId": "Scroll_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Scroll_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "scroll_id", - "in": "query", - "description": "Scroll ID.", - "schema": { - "type": "string", - "description": "Scroll ID." - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - } - ], - "responses": { - "200": { - "description": "Scroll_Post 200 response" - } - }, - "x-operation-group": "scroll", - "x-version-added": "1.0" - } - }, - "/_search/scroll/{scroll_id}": { - "delete": { - "description": "Explicitly clears the search context for a scroll.", - "operationId": "ClearScroll_WithScrollId", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ClearScroll_BodyParams" - } - } - } - }, - "deprecated": true, - "parameters": [ - { - "name": "scroll_id", - "in": "path", - "description": "Comma-separated list of scroll IDs to clear.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of scroll IDs to clear.", - "deprecated": true, - "x-data-type": "array" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "ClearScroll_WithScrollId 200 response" - } - }, - "x-deprecation-message": "A scroll id can be quite large and should be specified as part of the body", - "x-operation-group": "clear_scroll", - "x-version-added": "1.0", - "x-version-deprecated": "1.0" - }, - "get": { - "description": "Allows to retrieve a large numbers of results from a single search request.", - "operationId": "Scroll_Get_WithScrollId", - "deprecated": true, - "parameters": [ - { - "name": "scroll_id", - "in": "path", - "description": "Scroll ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Scroll ID." - }, - "required": true - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "scroll_id", - "in": "query", - "description": "Scroll ID.", - "schema": { - "type": "string", - "description": "Scroll ID." - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - } - ], - "responses": { - "200": { - "description": "Scroll_Get_WithScrollId 200 response" - } - }, - "x-deprecation-message": "A scroll id can be quite large and should be specified as part of the body", - "x-operation-group": "scroll", - "x-version-added": "1.0", - "x-version-deprecated": "1.0" - }, - "post": { - "description": "Allows to retrieve a large numbers of results from a single search request.", - "operationId": "Scroll_Post_WithScrollId", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Scroll_BodyParams" - } - } - } - }, - "deprecated": true, - "parameters": [ - { - "name": "scroll_id", - "in": "path", - "description": "Scroll ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Scroll ID." - }, - "required": true - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "scroll_id", - "in": "query", - "description": "Scroll ID.", - "schema": { - "type": "string", - "description": "Scroll ID." - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - } - ], - "responses": { - "200": { - "description": "Scroll_Post_WithScrollId 200 response" - } - }, - "x-deprecation-message": "A scroll id can be quite large and should be specified as part of the body", - "x-operation-group": "scroll", - "x-version-added": "1.0", - "x-version-deprecated": "1.0" - } - }, - "/_search/template": { - "get": { - "description": "Allows to use the Mustache language to pre-render a search definition.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/search-plugins/search-template/" - }, - "operationId": "SearchTemplate_Get", - "parameters": [ - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" - } - }, - { - "name": "explain", - "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." - } - }, - { - "name": "profile", - "in": "query", - "description": "Specify whether to profile the query execution.", - "schema": { - "type": "boolean", - "description": "Specify whether to profile the query execution." - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - } - ], - "responses": { - "200": { - "description": "SearchTemplate_Get 200 response" - } - }, - "x-operation-group": "search_template", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to use the Mustache language to pre-render a search definition.", - "operationId": "SearchTemplate_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SearchTemplate_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" - } - }, - { - "name": "explain", - "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." - } - }, - { - "name": "profile", - "in": "query", - "description": "Specify whether to profile the query execution.", - "schema": { - "type": "boolean", - "description": "Specify whether to profile the query execution." - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - } - ], - "responses": { - "200": { - "description": "SearchTemplate_Post 200 response" - } - }, - "x-operation-group": "search_template", - "x-version-added": "1.0" - } - }, - "/_search_shards": { - "get": { - "description": "Returns information about the indices and shards that a search request would be executed against.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "SearchShards_Get", - "parameters": [ - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "SearchShards_Get 200 response" - } - }, - "x-operation-group": "search_shards", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns information about the indices and shards that a search request would be executed against.", - "operationId": "SearchShards_Post", - "parameters": [ - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "SearchShards_Post 200 response" - } - }, - "x-operation-group": "search_shards", - "x-version-added": "1.0" - } - }, - "/_segments": { - "get": { - "description": "Provides low-level information about segments in a Lucene index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesSegments", - "parameters": [ - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "verbose", - "in": "query", - "description": "Includes detailed memory usage by Lucene.", - "schema": { - "type": "boolean", - "default": false, - "description": "Includes detailed memory usage by Lucene." - } - } - ], - "responses": { - "200": { - "description": "IndicesSegments 200 response" - } - }, - "x-operation-group": "indices.segments", - "x-version-added": "1.0" - } - }, - "/_settings": { - "get": { - "description": "Returns settings for one or more indices.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/" - }, - "operationId": "IndicesGetSettings", - "parameters": [ - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "include_defaults", - "in": "query", - "description": "Whether to return all default setting for each of the indices.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to return all default setting for each of the indices." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetSettings 200 response" - } - }, - "x-operation-group": "indices.get_settings", - "x-version-added": "1.0" - }, - "put": { - "description": "Updates the index settings.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/" - }, - "operationId": "IndicesPutSettings", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutSettings_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "preserve_existing", - "in": "query", - "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - } - ], - "responses": { - "200": { - "description": "IndicesPutSettings 200 response" - } - }, - "x-operation-group": "indices.put_settings", - "x-version-added": "1.0" - } - }, - "/_settings/{name}": { - "get": { - "description": "Returns settings for one or more indices.", - "operationId": "IndicesGetSettings_WithName", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Comma-separated list of settings.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of settings.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "include_defaults", - "in": "query", - "description": "Whether to return all default setting for each of the indices.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to return all default setting for each of the indices." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetSettings_WithName 200 response" - } - }, - "x-operation-group": "indices.get_settings", - "x-version-added": "1.0" - } - }, - "/_shard_stores": { - "get": { - "description": "Provides store information for shard copies of indices.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesShardStores", - "parameters": [ - { - "name": "status", - "in": "query", - "description": "Comma-separated list of statuses used to filter on shards to get store information for.", - "style": "form", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Status_Member" - }, - "description": "Comma-separated list of statuses used to filter on shards to get store information for." - }, - "explode": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesShardStores 200 response" - } - }, - "x-operation-group": "indices.shard_stores", - "x-version-added": "1.0" - } - }, - "/_snapshot": { - "get": { - "description": "Returns information about a repository.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/" - }, - "operationId": "SnapshotGetRepository", - "parameters": [ - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "SnapshotGetRepository 200 response" - } - }, - "x-operation-group": "snapshot.get_repository", - "x-version-added": "1.0" - } - }, - "/_snapshot/_status": { - "get": { - "description": "Returns information about the status of a snapshot.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/" - }, - "operationId": "SnapshotStatus", - "parameters": [ - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown." - } - } - ], - "responses": { - "200": { - "description": "SnapshotStatus 200 response" - } - }, - "x-operation-group": "snapshot.status", - "x-version-added": "1.0" - } - }, - "/_snapshot/{repository}": { - "delete": { - "description": "Deletes a repository.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/" - }, - "operationId": "SnapshotDeleteRepository", - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "SnapshotDeleteRepository 200 response" - } - }, - "x-operation-group": "snapshot.delete_repository", - "x-version-added": "1.0" - }, - "get": { - "description": "Returns information about a repository.", - "operationId": "SnapshotGetRepository_WithRepository", - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Comma-separated list of repository names.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of repository names.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "SnapshotGetRepository_WithRepository 200 response" - } - }, - "x-operation-group": "snapshot.get_repository", - "x-version-added": "1.0" - }, - "post": { - "description": "Creates a repository.", - "operationId": "SnapshotCreateRepository_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotCreateRepository_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Repository name." - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "verify", - "in": "query", - "description": "Whether to verify the repository after creation.", - "schema": { - "type": "boolean", - "description": "Whether to verify the repository after creation." - } - } - ], - "responses": { - "200": { - "description": "SnapshotCreateRepository_Post 200 response" - } - }, - "x-operation-group": "snapshot.create_repository", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates a repository.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/" - }, - "operationId": "SnapshotCreateRepository_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotCreateRepository_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Repository name." - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "verify", - "in": "query", - "description": "Whether to verify the repository after creation.", - "schema": { - "type": "boolean", - "description": "Whether to verify the repository after creation." - } - } - ], - "responses": { - "200": { - "description": "SnapshotCreateRepository_Put 200 response" - } - }, - "x-operation-group": "snapshot.create_repository", - "x-version-added": "1.0" - } - }, - "/_snapshot/{repository}/_cleanup": { - "post": { - "description": "Removes stale data from repository.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "SnapshotCleanupRepository", - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Repository name." - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "SnapshotCleanupRepository 200 response" - } - }, - "x-operation-group": "snapshot.cleanup_repository", - "x-version-added": "1.0" - } - }, - "/_snapshot/{repository}/_status": { - "get": { - "description": "Returns information about the status of a snapshot.", - "operationId": "SnapshotStatus_WithRepository", - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Repository name." - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown." - } - } - ], - "responses": { - "200": { - "description": "SnapshotStatus_WithRepository 200 response" - } - }, - "x-operation-group": "snapshot.status", - "x-version-added": "1.0" - } - }, - "/_snapshot/{repository}/_verify": { - "post": { - "description": "Verifies a repository.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/" - }, - "operationId": "SnapshotVerifyRepository", - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Repository name." - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "SnapshotVerifyRepository 200 response" - } - }, - "x-operation-group": "snapshot.verify_repository", - "x-version-added": "1.0" - } - }, - "/_snapshot/{repository}/{snapshot}": { - "delete": { - "description": "Deletes a snapshot.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/" - }, - "operationId": "SnapshotDelete", - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Repository name." - }, - "required": true - }, - { - "name": "snapshot", - "in": "path", - "description": "Snapshot name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Snapshot name." - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "SnapshotDelete 200 response" - } - }, - "x-operation-group": "snapshot.delete", - "x-version-added": "1.0" - }, - "get": { - "description": "Returns information about a snapshot.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "SnapshotGet", - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Repository name." - }, - "required": true - }, - { - "name": "snapshot", - "in": "path", - "description": "Comma-separated list of snapshot names.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of snapshot names.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown." - } - }, - { - "name": "verbose", - "in": "query", - "description": "Whether to show verbose snapshot info or only show the basic info found in the repository index blob.", - "schema": { - "type": "boolean", - "description": "Whether to show verbose snapshot info or only show the basic info found in the repository index blob." - } - } - ], - "responses": { - "200": { - "description": "SnapshotGet 200 response" - } - }, - "x-operation-group": "snapshot.get", - "x-version-added": "1.0" - }, - "post": { - "description": "Creates a snapshot in a repository.", - "operationId": "SnapshotCreate_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotCreate_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Repository name." - }, - "required": true - }, - { - "name": "snapshot", - "in": "path", - "description": "Snapshot name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Snapshot name." - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": false, - "description": "Should this request wait until the operation has completed before returning." - } - } - ], - "responses": { - "200": { - "description": "SnapshotCreate_Post 200 response" - } - }, - "x-operation-group": "snapshot.create", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates a snapshot in a repository.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/" - }, - "operationId": "SnapshotCreate_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotCreate_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Repository name." - }, - "required": true - }, - { - "name": "snapshot", - "in": "path", - "description": "Snapshot name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Snapshot name." - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": false, - "description": "Should this request wait until the operation has completed before returning." - } - } - ], - "responses": { - "200": { - "description": "SnapshotCreate_Put 200 response" - } - }, - "x-operation-group": "snapshot.create", - "x-version-added": "1.0" - } - }, - "/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}": { - "put": { - "description": "Clones indices from one snapshot into another snapshot in the same repository.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "SnapshotClone", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotClone_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Repository name." - }, - "required": true - }, - { - "name": "snapshot", - "in": "path", - "description": "Snapshot name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Snapshot name." - }, - "required": true - }, - { - "name": "target_snapshot", - "in": "path", - "description": "The name of the cloned snapshot to create.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the cloned snapshot to create." - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "SnapshotClone 200 response" - } - }, - "x-operation-group": "snapshot.clone", - "x-version-added": "1.0" - } - }, - "/_snapshot/{repository}/{snapshot}/_restore": { - "post": { - "description": "Restores a snapshot.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot/" - }, - "operationId": "SnapshotRestore", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnapshotRestore_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Repository name." - }, - "required": true - }, - { - "name": "snapshot", - "in": "path", - "description": "Snapshot name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Snapshot name." - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": false, - "description": "Should this request wait until the operation has completed before returning." - } - } - ], - "responses": { - "200": { - "description": "SnapshotRestore 200 response" - } - }, - "x-operation-group": "snapshot.restore", - "x-version-added": "1.0" - } - }, - "/_snapshot/{repository}/{snapshot}/_status": { - "get": { - "description": "Returns information about the status of a snapshot.", - "operationId": "SnapshotStatus_WithRepositorySnapshot", - "parameters": [ - { - "name": "repository", - "in": "path", - "description": "Repository name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Repository name." - }, - "required": true - }, - { - "name": "snapshot", - "in": "path", - "description": "Comma-separated list of snapshot names.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of snapshot names.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown." - } - } - ], - "responses": { - "200": { - "description": "SnapshotStatus_WithRepositorySnapshot 200 response" - } - }, - "x-operation-group": "snapshot.status", - "x-version-added": "1.0" - } - }, - "/_stats": { - "get": { - "description": "Provides statistics on operations happening in an index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesStats", - "parameters": [ - { - "name": "completion_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fielddata_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "groups", - "in": "query", - "description": "Comma-separated list of search groups for `search` index metric.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of search groups for `search` index metric." - }, - "explode": true - }, - { - "name": "level", - "in": "query", - "description": "Return stats aggregated at cluster, index or shard level.", - "schema": { - "$ref": "#/components/schemas/IndiciesStatLevel" - } - }, - { - "name": "include_segment_file_sizes", - "in": "query", - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", - "schema": { - "type": "boolean", - "default": false, - "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_unloaded_segments", - "in": "query", - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory.", - "schema": { - "type": "boolean", - "default": false, - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "forbid_closed_indices", - "in": "query", - "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices.", - "schema": { - "type": "boolean", - "default": true, - "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices." - } - } - ], - "responses": { - "200": { - "description": "IndicesStats 200 response" - } - }, - "x-operation-group": "indices.stats", - "x-version-added": "1.0" - } - }, - "/_stats/{metric}": { - "get": { - "description": "Provides statistics on operations happening in an index.", - "operationId": "IndicesStats_WithMetric", - "parameters": [ - { - "name": "metric", - "in": "path", - "description": "Limit the information returned the specific metrics.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Limit the information returned the specific metrics.", - "x-enum-options": [ - "_all", - "store", - "indexing", - "get", - "search", - "merge", - "flush", - "refresh", - "query_cache", - "fielddata", - "docs", - "warmer", - "completion", - "segments", - "translog", - "suggest", - "request_cache", - "recovery" - ], - "x-data-type": "array" - }, - "required": true - }, - { - "name": "completion_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fielddata_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "groups", - "in": "query", - "description": "Comma-separated list of search groups for `search` index metric.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of search groups for `search` index metric." - }, - "explode": true - }, - { - "name": "level", - "in": "query", - "description": "Return stats aggregated at cluster, index or shard level.", - "schema": { - "$ref": "#/components/schemas/IndiciesStatLevel" - } - }, - { - "name": "include_segment_file_sizes", - "in": "query", - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", - "schema": { - "type": "boolean", - "default": false, - "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_unloaded_segments", - "in": "query", - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory.", - "schema": { - "type": "boolean", - "default": false, - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "forbid_closed_indices", - "in": "query", - "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices.", - "schema": { - "type": "boolean", - "default": true, - "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices." - } - } - ], - "responses": { - "200": { - "description": "IndicesStats_WithMetric 200 response" - } - }, - "x-operation-group": "indices.stats", - "x-version-added": "1.0" - } - }, - "/_tasks": { - "get": { - "description": "Returns a list of tasks.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/tasks/" - }, - "operationId": "TasksList", - "parameters": [ - { - "name": "nodes", - "in": "query", - "description": "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.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "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." - }, - "explode": true - }, - { - "name": "actions", - "in": "query", - "description": "Comma-separated list of actions that should be returned. Leave empty to return all.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of actions that should be returned. Leave empty to return all." - }, - "explode": true - }, - { - "name": "detailed", - "in": "query", - "description": "Return detailed task information.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return detailed task information." - } - }, - { - "name": "parent_task_id", - "in": "query", - "description": "Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.", - "schema": { - "type": "string", - "description": "Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all." - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": false, - "description": "Should this request wait until the operation has completed before returning." - } - }, - { - "name": "group_by", - "in": "query", - "description": "Group tasks by nodes or parent/child relationships.", - "schema": { - "$ref": "#/components/schemas/GroupBy" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "TasksList 200 response" - } - }, - "x-operation-group": "tasks.list", - "x-version-added": "1.0" - } - }, - "/_tasks/_cancel": { - "post": { - "description": "Cancels a task, if it can be cancelled through an API.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling" - }, - "operationId": "TasksCancel", - "parameters": [ - { - "name": "nodes", - "in": "query", - "description": "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.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "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." - }, - "explode": true - }, - { - "name": "actions", - "in": "query", - "description": "Comma-separated list of actions that should be cancelled. Leave empty to cancel all.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of actions that should be cancelled. Leave empty to cancel all." - }, - "explode": true - }, - { - "name": "parent_task_id", - "in": "query", - "description": "Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.", - "schema": { - "type": "string", - "description": "Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all." - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": false, - "description": "Should this request wait until the operation has completed before returning." - } - } - ], - "responses": { - "200": { - "description": "TasksCancel 200 response" - } - }, - "x-operation-group": "tasks.cancel", - "x-version-added": "1.0" - } - }, - "/_tasks/{task_id}": { - "get": { - "description": "Returns information about a task.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/tasks/" - }, - "operationId": "TasksGet", - "parameters": [ - { - "name": "task_id", - "in": "path", - "description": "Return the task with specified id (node_id:task_number).", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Return the task with specified id (node_id:task_number)." - }, - "required": true - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": false, - "description": "Should this request wait until the operation has completed before returning." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "TasksGet 200 response" - } - }, - "x-operation-group": "tasks.get", - "x-version-added": "1.0" - } - }, - "/_tasks/{task_id}/_cancel": { - "post": { - "description": "Cancels a task, if it can be cancelled through an API.", - "operationId": "TasksCancel_WithTaskId", - "parameters": [ - { - "name": "task_id", - "in": "path", - "description": "Cancel the task with specified task id (node_id:task_number).", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Cancel the task with specified task id (node_id:task_number)." - }, - "required": true - }, - { - "name": "nodes", - "in": "query", - "description": "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.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "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." - }, - "explode": true - }, - { - "name": "actions", - "in": "query", - "description": "Comma-separated list of actions that should be cancelled. Leave empty to cancel all.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of actions that should be cancelled. Leave empty to cancel all." - }, - "explode": true - }, - { - "name": "parent_task_id", - "in": "query", - "description": "Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.", - "schema": { - "type": "string", - "description": "Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all." - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": false, - "description": "Should this request wait until the operation has completed before returning." - } - } - ], - "responses": { - "200": { - "description": "TasksCancel_WithTaskId 200 response" - } - }, - "x-operation-group": "tasks.cancel", - "x-version-added": "1.0" - } - }, - "/_template": { - "get": { - "description": "Returns an index template.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesGetTemplate", - "parameters": [ - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetTemplate 200 response" - } - }, - "x-operation-group": "indices.get_template", - "x-version-added": "1.0" - } - }, - "/_template/{name}": { - "delete": { - "description": "Deletes an index template.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesDeleteTemplate", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the template.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the template." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesDeleteTemplate 200 response" - } - }, - "x-operation-group": "indices.delete_template", - "x-version-added": "1.0" - }, - "get": { - "description": "Returns an index template.", - "operationId": "IndicesGetTemplate_WithName", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Comma-separated names of the index templates.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated names of the index templates.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetTemplate_WithName 200 response" - } - }, - "x-operation-group": "indices.get_template", - "x-version-added": "1.0" - }, - "head": { - "description": "Returns information about whether a particular index template exists.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesExistsTemplate", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Comma-separated names of the index templates.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated names of the index templates.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "IndicesExistsTemplate 200 response" - } - }, - "x-operation-group": "indices.exists_template", - "x-version-added": "1.0" - }, - "post": { - "description": "Creates or updates an index template.", - "operationId": "IndicesPutTemplate_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutTemplate_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the template.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the template." - }, - "required": true - }, - { - "name": "order", - "in": "query", - "description": "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers).", - "schema": { - "type": "integer", - "description": "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers).", - "format": "int32" - } - }, - { - "name": "create", - "in": "query", - "description": "Whether the index template should only be added if new or can also replace an existing one.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether the index template should only be added if new or can also replace an existing one." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesPutTemplate_Post 200 response" - } - }, - "x-operation-group": "indices.put_template", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or updates an index template.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/im-plugin/index-templates/" - }, - "operationId": "IndicesPutTemplate_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutTemplate_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the template.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the template." - }, - "required": true - }, - { - "name": "order", - "in": "query", - "description": "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers).", - "schema": { - "type": "integer", - "description": "The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers).", - "format": "int32" - } - }, - { - "name": "create", - "in": "query", - "description": "Whether the index template should only be added if new or can also replace an existing one.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether the index template should only be added if new or can also replace an existing one." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesPutTemplate_Put 200 response" - } - }, - "x-operation-group": "indices.put_template", - "x-version-added": "1.0" - } - }, - "/_update_by_query/{task_id}/_rethrottle": { - "post": { - "description": "Changes the number of requests per second for a particular Update By Query operation.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "UpdateByQueryRethrottle", - "parameters": [ - { - "name": "task_id", - "in": "path", - "description": "The task id to rethrottle.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The task id to rethrottle." - }, - "required": true - }, - { - "name": "requests_per_second", - "in": "query", - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "schema": { - "type": "integer", - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "format": "int32" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "UpdateByQueryRethrottle 200 response" - } - }, - "x-operation-group": "update_by_query_rethrottle", - "x-version-added": "1.0" - } - }, - "/_upgrade": { - "get": { - "description": "The _upgrade API is no longer useful and will be removed.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesGetUpgrade", - "parameters": [ - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesGetUpgrade 200 response" - } - }, - "x-operation-group": "indices.get_upgrade", - "x-version-added": "1.0" - }, - "post": { - "description": "The _upgrade API is no longer useful and will be removed.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesUpgrade", - "parameters": [ - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": false, - "description": "Should this request wait until the operation has completed before returning." - } - }, - { - "name": "only_ancient_segments", - "in": "query", - "description": "If true, only ancient (an older Lucene major release) segments will be upgraded.", - "schema": { - "type": "boolean", - "description": "If true, only ancient (an older Lucene major release) segments will be upgraded." - } - } - ], - "responses": { - "200": { - "description": "IndicesUpgrade 200 response" - } - }, - "x-operation-group": "indices.upgrade", - "x-version-added": "1.0" - } - }, - "/_validate/query": { - "get": { - "description": "Allows a user to validate a potentially expensive query without executing it.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesValidateQuery_Get", - "parameters": [ - { - "name": "explain", - "in": "query", - "description": "Return detailed information about the error.", - "schema": { - "type": "boolean", - "description": "Return detailed information about the error." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "rewrite", - "in": "query", - "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed.", - "schema": { - "type": "boolean", - "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed." - } - }, - { - "name": "all_shards", - "in": "query", - "description": "Execute validation on all shards instead of one random shard per index.", - "schema": { - "type": "boolean", - "description": "Execute validation on all shards instead of one random shard per index." - } - } - ], - "responses": { - "200": { - "description": "IndicesValidateQuery_Get 200 response" - } - }, - "x-operation-group": "indices.validate_query", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows a user to validate a potentially expensive query without executing it.", - "operationId": "IndicesValidateQuery_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesValidateQuery_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "explain", - "in": "query", - "description": "Return detailed information about the error.", - "schema": { - "type": "boolean", - "description": "Return detailed information about the error." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "rewrite", - "in": "query", - "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed.", - "schema": { - "type": "boolean", - "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed." - } - }, - { - "name": "all_shards", - "in": "query", - "description": "Execute validation on all shards instead of one random shard per index.", - "schema": { - "type": "boolean", - "description": "Execute validation on all shards instead of one random shard per index." - } - } - ], - "responses": { - "200": { - "description": "IndicesValidateQuery_Post 200 response" - } - }, - "x-operation-group": "indices.validate_query", - "x-version-added": "1.0" - } - }, - "/{alias}/_rollover": { - "post": { - "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/" - }, - "operationId": "IndicesRollover", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesRollover_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "alias", - "in": "path", - "description": "The name of the alias to rollover.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the alias to rollover." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "dry_run", - "in": "query", - "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches.", - "schema": { - "type": "boolean", - "default": false, - "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns.", - "schema": { - "type": "string", - "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns." - } - } - ], - "responses": { - "200": { - "description": "IndicesRollover 200 response" - } - }, - "x-operation-group": "indices.rollover", - "x-version-added": "1.0" - } - }, - "/{alias}/_rollover/{new_index}": { - "post": { - "description": "Updates an alias to point to a new index when the existing index\nis considered to be too large or too old.", - "operationId": "IndicesRollover_WithNewIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesRollover_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "alias", - "in": "path", - "description": "The name of the alias to rollover.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the alias to rollover." - }, - "required": true - }, - { - "name": "new_index", - "in": "path", - "description": "The name of the rollover index.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the rollover index." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "dry_run", - "in": "query", - "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches.", - "schema": { - "type": "boolean", - "default": false, - "description": "If set to true the rollover action will only be validated but not actually performed even if a condition matches." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns.", - "schema": { - "type": "string", - "description": "Set the number of active shards to wait for on the newly created rollover index before the operation returns." - } - } - ], - "responses": { - "200": { - "description": "IndicesRollover_WithNewIndex 200 response" - } - }, - "x-operation-group": "indices.rollover", - "x-version-added": "1.0" - } - }, - "/{index}": { - "delete": { - "description": "Deletes an index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/" - }, - "operationId": "IndicesDelete", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to delete; use `_all` or `*` string to delete all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to delete; use `_all` or `*` string to delete all indices.", - "x-data-type": "array" - }, - "required": true, - "examples": { - "IndicesDelete_example1": { - "summary": "Examples for Delete Index Operation.", - "description": "", - "value": "books" - } - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "default": false, - "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": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesDelete 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesDeleteResponseContent" - }, - "examples": { - "IndicesDelete_example1": { - "summary": "Examples for Delete Index Operation.", - "description": "", - "value": { - "acknowledged": true - } - } - } - } - } - } - }, - "x-operation-group": "indices.delete", - "x-version-added": "1.0" - }, - "get": { - "description": "Returns information about one or more indices.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/get-index/" - }, - "operationId": "IndicesGet", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "default": false, - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "include_defaults", - "in": "query", - "description": "Whether to return all default setting for each of the indices.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to return all default setting for each of the indices." - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesGet 200 response" - } - }, - "x-operation-group": "indices.get", - "x-version-added": "1.0" - }, - "head": { - "description": "Returns information about whether a particular index exists.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/exists/" - }, - "operationId": "IndicesExists", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "default": false, - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "include_defaults", - "in": "query", - "description": "Whether to return all default setting for each of the indices.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to return all default setting for each of the indices." - } - } - ], - "responses": { - "200": { - "description": "IndicesExists 200 response" - } - }, - "x-operation-group": "indices.exists", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates an index with optional settings and mappings.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/create-index/" - }, - "operationId": "IndicesCreate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesCreate_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Index name." - }, - "required": true, - "examples": { - "IndicesCreate_example1": { - "summary": "Examples for Create Index Operation.", - "description": "", - "value": "books" - } - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Set the number of active shards to wait for before the operation returns.", - "schema": { - "type": "string", - "description": "Set the number of active shards to wait for before the operation returns." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesCreate 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesCreateResponseContent" - }, - "examples": { - "IndicesCreate_example1": { - "summary": "Examples for Create Index Operation.", - "description": "", - "value": { - "index": "books", - "shards_acknowledged": true, - "acknowledged": true - } - } - } - } - } - } - }, - "x-operation-group": "indices.create", - "x-version-added": "1.0" - } - }, - "/{index}/_alias": { - "get": { - "description": "Returns an alias.", - "operationId": "IndicesGetAlias_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to filter aliases.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to filter aliases.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetAlias_WithIndex 200 response" - } - }, - "x-operation-group": "indices.get_alias", - "x-version-added": "1.0" - } - }, - "/{index}/_alias/{name}": { - "delete": { - "description": "Deletes an alias.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases" - }, - "operationId": "IndicesDeleteAlias", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "name", - "in": "path", - "description": "Comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesDeleteAlias 200 response" - } - }, - "x-operation-group": "indices.delete_alias", - "x-version-added": "1.0" - }, - "get": { - "description": "Returns an alias.", - "operationId": "IndicesGetAlias_WithIndexName", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to filter aliases.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to filter aliases.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "name", - "in": "path", - "description": "Comma-separated list of alias names.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of alias names.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetAlias_WithIndexName 200 response" - } - }, - "x-operation-group": "indices.get_alias", - "x-version-added": "1.0" - }, - "head": { - "description": "Returns information about whether a particular alias exists.", - "operationId": "IndicesExistsAlias_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to filter aliases.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to filter aliases.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "name", - "in": "path", - "description": "Comma-separated list of alias names.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of alias names.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "IndicesExistsAlias_WithIndex 200 response" - } - }, - "x-operation-group": "indices.exists_alias", - "x-version-added": "1.0" - }, - "post": { - "description": "Creates or updates an alias.", - "operationId": "IndicesPutAlias_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutAlias_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "name", - "in": "path", - "description": "The name of the alias to be created or updated.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the alias to be created or updated." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesPutAlias_Post 200 response" - } - }, - "x-operation-group": "indices.put_alias", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or updates an alias.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases" - }, - "operationId": "IndicesPutAlias_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutAlias_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "name", - "in": "path", - "description": "The name of the alias to be created or updated.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the alias to be created or updated." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesPutAlias_Put 200 response" - } - }, - "x-operation-group": "indices.put_alias", - "x-version-added": "1.0" - } - }, - "/{index}/_aliases/{name}": { - "delete": { - "description": "Deletes an alias.", - "operationId": "IndicesDeleteAlias_Plural", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "name", - "in": "path", - "description": "Comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesDeleteAlias_Plural 200 response" - } - }, - "x-operation-group": "indices.delete_alias", - "x-version-added": "1.0" - }, - "post": { - "description": "Creates or updates an alias.", - "operationId": "IndicesPutAlias_Post_Plural", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutAlias_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "name", - "in": "path", - "description": "The name of the alias to be created or updated.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the alias to be created or updated." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesPutAlias_Post_Plural 200 response" - } - }, - "x-operation-group": "indices.put_alias", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or updates an alias.", - "operationId": "IndicesPutAlias_Put_Plural", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutAlias_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "name", - "in": "path", - "description": "The name of the alias to be created or updated.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the alias to be created or updated." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesPutAlias_Put_Plural 200 response" - } - }, - "x-operation-group": "indices.put_alias", - "x-version-added": "1.0" - } - }, - "/{index}/_analyze": { - "get": { - "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", - "operationId": "IndicesAnalyze_Get_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The name of the index to scope the operation.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the index to scope the operation." - }, - "required": true - }, - { - "name": "index", - "in": "query", - "description": "The name of the index to scope the operation.", - "schema": { - "type": "string", - "description": "The name of the index to scope the operation." - } - } - ], - "responses": { - "200": { - "description": "IndicesAnalyze_Get_WithIndex 200 response" - } - }, - "x-operation-group": "indices.analyze", - "x-version-added": "1.0" - }, - "post": { - "description": "Performs the analysis process on a text and return the tokens breakdown of the text.", - "operationId": "IndicesAnalyze_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesAnalyze_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The name of the index to scope the operation.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the index to scope the operation." - }, - "required": true - }, - { - "name": "index", - "in": "query", - "description": "The name of the index to scope the operation.", - "schema": { - "type": "string", - "description": "The name of the index to scope the operation." - } - } - ], - "responses": { - "200": { - "description": "IndicesAnalyze_Post_WithIndex 200 response" - } - }, - "x-operation-group": "indices.analyze", - "x-version-added": "1.0" - } - }, - "/{index}/_block/{block}": { - "put": { - "description": "Adds a block to an index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "IndicesAddBlock", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to add a block to.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to add a block to.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "block", - "in": "path", - "description": "The block to add (one of read, write, read_only or metadata).", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The block to add (one of read, write, read_only or metadata)." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesAddBlock 200 response" - } - }, - "x-operation-group": "indices.add_block", - "x-version-added": "1.0" - } - }, - "/{index}/_bulk": { - "post": { - "description": "Allows to perform multiple index/update/delete operations in a single request.", - "operationId": "Bulk_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Bulk_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Default index for items which don't provide one.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Default index for items which don't provide one." - }, - "required": true - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the 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).", - "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the 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": "refresh", - "in": "query", - "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.", - "schema": { - "$ref": "#/components/schemas/RefreshEnum" - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "type", - "in": "query", - "description": "Default document type for items which don't provide one.", - "schema": { - "type": "string", - "description": "Default document type for items which don't provide one." - } - }, - { - "name": "_source", - "in": "query", - "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.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "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." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request." - }, - "explode": true - }, - { - "name": "pipeline", - "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", - "schema": { - "type": "string", - "description": "The pipeline id to preprocess incoming documents with." - } - }, - { - "name": "require_alias", - "in": "query", - "description": "Sets require_alias for all incoming documents.", - "schema": { - "type": "boolean", - "default": false, - "description": "Sets require_alias for all incoming documents." - } - } - ], - "responses": { - "200": { - "description": "Bulk_Post_WithIndex 200 response" - } - }, - "x-operation-group": "bulk", - "x-version-added": "1.0" - }, - "put": { - "description": "Allows to perform multiple index/update/delete operations in a single request.", - "operationId": "Bulk_Put_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Bulk_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Default index for items which don't provide one.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Default index for items which don't provide one." - }, - "required": true - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the 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).", - "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the 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": "refresh", - "in": "query", - "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.", - "schema": { - "$ref": "#/components/schemas/RefreshEnum" - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "type", - "in": "query", - "description": "Default document type for items which don't provide one.", - "schema": { - "type": "string", - "description": "Default document type for items which don't provide one." - } - }, - { - "name": "_source", - "in": "query", - "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.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "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." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request." - }, - "explode": true - }, - { - "name": "pipeline", - "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", - "schema": { - "type": "string", - "description": "The pipeline id to preprocess incoming documents with." - } - }, - { - "name": "require_alias", - "in": "query", - "description": "Sets require_alias for all incoming documents.", - "schema": { - "type": "boolean", - "default": false, - "description": "Sets require_alias for all incoming documents." - } - } - ], - "responses": { - "200": { - "description": "Bulk_Put_WithIndex 200 response" - } - }, - "x-operation-group": "bulk", - "x-version-added": "1.0" - } - }, - "/{index}/_cache/clear": { - "post": { - "description": "Clears all or specific caches for one or more indices.", - "operationId": "IndicesClearCache_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "fielddata", - "in": "query", - "description": "Clear field data.", - "schema": { - "type": "boolean", - "description": "Clear field data." - } - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields to clear when using the `fielddata` parameter (default: all).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to clear when using the `fielddata` parameter (default: all)." - }, - "explode": true - }, - { - "name": "query", - "in": "query", - "description": "Clear query caches.", - "schema": { - "type": "boolean", - "description": "Clear query caches." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "index", - "in": "query", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices." - }, - "explode": true - }, - { - "name": "request", - "in": "query", - "description": "Clear request cache.", - "schema": { - "type": "boolean", - "description": "Clear request cache." - } - } - ], - "responses": { - "200": { - "description": "IndicesClearCache_WithIndex 200 response" - } - }, - "x-operation-group": "indices.clear_cache", - "x-version-added": "1.0" - } - }, - "/{index}/_clone/{target}": { - "post": { - "description": "Clones an index.", - "operationId": "IndicesClone_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesClone_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The name of the source index to clone.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the source index to clone." - }, - "required": true - }, - { - "name": "target", - "in": "path", - "description": "The name of the target index.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the target index." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Set the number of active shards to wait for on the cloned index before the operation returns.", - "schema": { - "type": "string", - "description": "Set the number of active shards to wait for on the cloned index before the operation returns." - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": true, - "description": "Should this request wait until the operation has completed before returning." - } - }, - { - "name": "task_execution_timeout", - "in": "query", - "description": "Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesClone_Post 200 response" - } - }, - "x-operation-group": "indices.clone", - "x-version-added": "1.0" - }, - "put": { - "description": "Clones an index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/clone/" - }, - "operationId": "IndicesClone_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesClone_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The name of the source index to clone.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the source index to clone." - }, - "required": true - }, - { - "name": "target", - "in": "path", - "description": "The name of the target index.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the target index." - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Set the number of active shards to wait for on the cloned index before the operation returns.", - "schema": { - "type": "string", - "description": "Set the number of active shards to wait for on the cloned index before the operation returns." - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": true, - "description": "Should this request wait until the operation has completed before returning." - } - }, - { - "name": "task_execution_timeout", - "in": "query", - "description": "Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesClone_Put 200 response" - } - }, - "x-operation-group": "indices.clone", - "x-version-added": "1.0" - } - }, - "/{index}/_close": { - "post": { - "description": "Closes an index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/close-index/" - }, - "operationId": "IndicesClose", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to close.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to close.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of active shards to wait for before the operation returns.", - "schema": { - "type": "string", - "description": "Sets the number of active shards to wait for before the operation returns." - } - } - ], - "responses": { - "200": { - "description": "IndicesClose 200 response" - } - }, - "x-operation-group": "indices.close", - "x-version-added": "1.0" - } - }, - "/{index}/_count": { - "get": { - "description": "Returns number of documents matching a query.", - "operationId": "Count_Get_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to restrict the results.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to restrict the results.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "min_score", - "in": "query", - "description": "Include only documents with a specific `_score` value in the result.", - "schema": { - "type": "integer", - "description": "Include only documents with a specific `_score` value in the result.", - "format": "int32" - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "terminate_after", - "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Count_Get_WithIndex 200 response" - } - }, - "x-operation-group": "count", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns number of documents matching a query.", - "operationId": "Count_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Count_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to restrict the results.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to restrict the results.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "min_score", - "in": "query", - "description": "Include only documents with a specific `_score` value in the result.", - "schema": { - "type": "integer", - "description": "Include only documents with a specific `_score` value in the result.", - "format": "int32" - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "terminate_after", - "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Count_Post_WithIndex 200 response" - } - }, - "x-operation-group": "count", - "x-version-added": "1.0" - } - }, - "/{index}/_create/{id}": { - "post": { - "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.", - "operationId": "Create_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Create_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Document ID." - }, - "required": true - }, - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Index name." - }, - "required": true - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the 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).", - "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the 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": "refresh", - "in": "query", - "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.", - "schema": { - "$ref": "#/components/schemas/RefreshEnum" - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - }, - { - "name": "pipeline", - "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", - "schema": { - "type": "string", - "description": "The pipeline id to preprocess incoming documents with." - } - } - ], - "responses": { - "200": { - "description": "Create_Post 200 response" - } - }, - "x-operation-group": "create", - "x-version-added": "1.0" - }, - "put": { - "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.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/document-apis/index-document/" - }, - "operationId": "Create_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Create_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Document ID." - }, - "required": true - }, - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Index name." - }, - "required": true - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the 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).", - "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the 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": "refresh", - "in": "query", - "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.", - "schema": { - "$ref": "#/components/schemas/RefreshEnum" - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - }, - { - "name": "pipeline", - "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", - "schema": { - "type": "string", - "description": "The pipeline id to preprocess incoming documents with." - } - } - ], - "responses": { - "200": { - "description": "Create_Put 200 response" - } - }, - "x-operation-group": "create", - "x-version-added": "1.0" - } - }, - "/{index}/_delete_by_query": { - "post": { - "description": "Deletes documents matching the provided query.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/" - }, - "operationId": "DeleteByQuery", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeleteByQuery_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "from", - "in": "query", - "description": "Starting offset.", - "schema": { - "type": "integer", - "default": 0, - "description": "Starting offset.", - "format": "int32" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "conflicts", - "in": "query", - "description": "What to do when the operation encounters version conflicts?.", - "schema": { - "$ref": "#/components/schemas/Conflicts" - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchType" - } - }, - { - "name": "search_timeout", - "in": "query", - "description": "Explicit timeout for each search request. Defaults to no timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Explicit timeout for each search request. Defaults to no timeout.", - "x-data-type": "time" - } - }, - { - "name": "size", - "in": "query", - "description": "Deprecated, please use `max_docs` instead.", - "schema": { - "type": "integer", - "description": "Deprecated, please use `max_docs` instead.", - "format": "int32" - } - }, - { - "name": "max_docs", - "in": "query", - "description": "Maximum number of documents to process (default: all documents).", - "schema": { - "type": "integer", - "description": "Maximum number of documents to process (default: all documents).", - "format": "int32" - } - }, - { - "name": "sort", - "in": "query", - "description": "Comma-separated list of : pairs.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of : pairs." - }, - "explode": true - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - }, - { - "name": "terminate_after", - "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" - } - }, - { - "name": "stats", - "in": "query", - "description": "Specific 'tag' of the request for logging and statistical purposes.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specific 'tag' of the request for logging and statistical purposes." - }, - "explode": true - }, - { - "name": "version", - "in": "query", - "description": "Whether to return document version as part of a hit.", - "schema": { - "type": "boolean", - "description": "Whether to return document version as part of a hit." - } - }, - { - "name": "request_cache", - "in": "query", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", - "schema": { - "type": "boolean", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting." - } - }, - { - "name": "refresh", - "in": "query", - "description": "Refresh the shard containing the document before performing the operation.", - "schema": { - "type": "boolean", - "description": "Refresh the shard containing the document before performing the operation." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Time each individual bulk request should wait for shards that are unavailable.", - "schema": { - "type": "string", - "default": "1m", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Time each individual bulk request should wait for shards that are unavailable.", - "x-data-type": "time" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the 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).", - "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the 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": "scroll_size", - "in": "query", - "description": "Size on the scroll request powering the operation.", - "schema": { - "type": "integer", - "default": 100, - "description": "Size on the scroll request powering the operation.", - "format": "int32" - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": true, - "description": "Should this request wait until the operation has completed before returning." - } - }, - { - "name": "requests_per_second", - "in": "query", - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "schema": { - "type": "integer", - "default": 0, - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "format": "int32" - } - }, - { - "name": "slices", - "in": "query", - "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`.", - "schema": { - "type": "string", - "default": "1", - "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`." - } - } - ], - "responses": { - "200": { - "description": "DeleteByQuery 200 response" - } - }, - "x-operation-group": "delete_by_query", - "x-version-added": "1.0" - } - }, - "/{index}/_doc": { - "post": { - "description": "Creates or updates a document in an index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/document-apis/index-document/" - }, - "operationId": "Index_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Index_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Index name." - }, - "required": true - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the 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).", - "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the 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": "op_type", - "in": "query", - "description": "Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create` for requests without an explicit document ID.", - "schema": { - "$ref": "#/components/schemas/OpType" - } - }, - { - "name": "refresh", - "in": "query", - "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.", - "schema": { - "$ref": "#/components/schemas/RefreshEnum" - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - }, - { - "name": "if_seq_no", - "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", - "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", - "format": "int32" - } - }, - { - "name": "if_primary_term", - "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", - "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", - "format": "int32" - } - }, - { - "name": "pipeline", - "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", - "schema": { - "type": "string", - "description": "The pipeline id to preprocess incoming documents with." - } - }, - { - "name": "require_alias", - "in": "query", - "description": "When true, requires destination to be an alias.", - "schema": { - "type": "boolean", - "default": false, - "description": "When true, requires destination to be an alias." - } - } - ], - "responses": { - "200": { - "description": "Index_Post 200 response" - } - }, - "x-operation-group": "index", - "x-version-added": "1.0" - } - }, - "/{index}/_doc/{id}": { - "delete": { - "description": "Removes a document from the index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/document-apis/delete-document/" - }, - "operationId": "Delete", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Document ID." - }, - "required": true - }, - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Index name." - }, - "required": true - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the 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).", - "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the 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": "refresh", - "in": "query", - "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.", - "schema": { - "$ref": "#/components/schemas/RefreshEnum" - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "if_seq_no", - "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", - "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", - "format": "int32" - } - }, - { - "name": "if_primary_term", - "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", - "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", - "format": "int32" - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "Delete 200 response" - } - }, - "x-operation-group": "delete", - "x-version-added": "1.0" - }, - "get": { - "description": "Returns a document.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/" - }, - "operationId": "Get", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Document ID." - }, - "required": true, - "examples": { - "Get_example1": { - "summary": "Examples for Get document doc Operation.", - "description": "", - "value": "1" - } - } - }, - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Index name." - }, - "required": true, - "examples": { - "Get_example1": { - "summary": "Examples for Get document doc Operation.", - "description": "", - "value": "books" - } - } - }, - { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specify whether to perform the operation in realtime or search mode.", - "schema": { - "type": "boolean", - "description": "Specify whether to perform the operation in realtime or search mode." - } - }, - { - "name": "refresh", - "in": "query", - "description": "Refresh the shard containing the document before performing the operation.", - "schema": { - "type": "boolean", - "description": "Refresh the shard containing the document before performing the operation." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "Get 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetResponseContent" - }, - "examples": { - "Get_example1": { - "summary": "Examples for Get document doc Operation.", - "description": "", - "value": { - "_index": "books", - "_id": "1", - "found": true - } - } - } - } - } - } - }, - "x-operation-group": "get", - "x-version-added": "1.0" - }, - "head": { - "description": "Returns information about whether a document exists in an index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/" - }, - "operationId": "Exists", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Document ID." - }, - "required": true - }, - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Index name." - }, - "required": true - }, - { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specify whether to perform the operation in realtime or search mode.", - "schema": { - "type": "boolean", - "description": "Specify whether to perform the operation in realtime or search mode." - } - }, - { - "name": "refresh", - "in": "query", - "description": "Refresh the shard containing the document before performing the operation.", - "schema": { - "type": "boolean", - "description": "Refresh the shard containing the document before performing the operation." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "Exists 200 response" - } - }, - "x-operation-group": "exists", - "x-version-added": "1.0" - }, - "post": { - "description": "Creates or updates a document in an index.", - "operationId": "Index_Post_WithId", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Index_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Document ID." - }, - "required": true - }, - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Index name." - }, - "required": true - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the 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).", - "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the 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": "op_type", - "in": "query", - "description": "Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create` for requests without an explicit document ID.", - "schema": { - "$ref": "#/components/schemas/OpType" - } - }, - { - "name": "refresh", - "in": "query", - "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.", - "schema": { - "$ref": "#/components/schemas/RefreshEnum" - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - }, - { - "name": "if_seq_no", - "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", - "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", - "format": "int32" - } - }, - { - "name": "if_primary_term", - "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", - "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", - "format": "int32" - } - }, - { - "name": "pipeline", - "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", - "schema": { - "type": "string", - "description": "The pipeline id to preprocess incoming documents with." - } - }, - { - "name": "require_alias", - "in": "query", - "description": "When true, requires destination to be an alias.", - "schema": { - "type": "boolean", - "default": false, - "description": "When true, requires destination to be an alias." - } - } - ], - "responses": { - "200": { - "description": "Index_Post_WithId 200 response" - } - }, - "x-operation-group": "index", - "x-version-added": "1.0" - }, - "put": { - "description": "Creates or updates a document in an index.", - "operationId": "Index_Put_WithId", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Index_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Document ID." - }, - "required": true - }, - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Index name." - }, - "required": true - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the 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).", - "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the 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": "op_type", - "in": "query", - "description": "Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create` for requests without an explicit document ID.", - "schema": { - "$ref": "#/components/schemas/OpType" - } - }, - { - "name": "refresh", - "in": "query", - "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.", - "schema": { - "$ref": "#/components/schemas/RefreshEnum" - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - }, - { - "name": "if_seq_no", - "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", - "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", - "format": "int32" - } - }, - { - "name": "if_primary_term", - "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", - "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", - "format": "int32" - } - }, - { - "name": "pipeline", - "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", - "schema": { - "type": "string", - "description": "The pipeline id to preprocess incoming documents with." - } - }, - { - "name": "require_alias", - "in": "query", - "description": "When true, requires destination to be an alias.", - "schema": { - "type": "boolean", - "default": false, - "description": "When true, requires destination to be an alias." - } - } - ], - "responses": { - "200": { - "description": "Index_Put_WithId 200 response" - } - }, - "x-operation-group": "index", - "x-version-added": "1.0" - } - }, - "/{index}/_explain/{id}": { - "get": { - "description": "Returns information about why a specific matches (or doesn't match) a query.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/explain/" - }, - "operationId": "Explain_Get", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Document ID." - }, - "required": true - }, - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Index name." - }, - "required": true - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcards and prefix queries in the query string query should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcards and prefix queries in the query string query should be analyzed." - } - }, - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The default field for query string query.", - "schema": { - "type": "string", - "default": "_all", - "description": "The default field for query string query." - } - }, - { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - } - ], - "responses": { - "200": { - "description": "Explain_Get 200 response" - } - }, - "x-operation-group": "explain", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns information about why a specific matches (or doesn't match) a query.", - "operationId": "Explain_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Explain_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Document ID." - }, - "required": true - }, - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Index name." - }, - "required": true - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcards and prefix queries in the query string query should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcards and prefix queries in the query string query should be analyzed." - } - }, - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The default field for query string query.", - "schema": { - "type": "string", - "default": "_all", - "description": "The default field for query string query." - } - }, - { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - } - ], - "responses": { - "200": { - "description": "Explain_Post 200 response" - } - }, - "x-operation-group": "explain", - "x-version-added": "1.0" - } - }, - "/{index}/_field_caps": { - "get": { - "description": "Returns the information about the capabilities of fields among multiple indices.", - "operationId": "FieldCaps_Get_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of field names.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of field names." - }, - "explode": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "include_unmapped", - "in": "query", - "description": "Indicates whether unmapped fields should be included in the response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether unmapped fields should be included in the response." - } - } - ], - "responses": { - "200": { - "description": "FieldCaps_Get_WithIndex 200 response" - } - }, - "x-operation-group": "field_caps", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns the information about the capabilities of fields among multiple indices.", - "operationId": "FieldCaps_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FieldCaps_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of field names.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of field names." - }, - "explode": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "include_unmapped", - "in": "query", - "description": "Indicates whether unmapped fields should be included in the response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether unmapped fields should be included in the response." - } - } - ], - "responses": { - "200": { - "description": "FieldCaps_Post_WithIndex 200 response" - } - }, - "x-operation-group": "field_caps", - "x-version-added": "1.0" - } - }, - "/{index}/_flush": { - "get": { - "description": "Performs the flush operation on one or more indices.", - "operationId": "IndicesFlush_Get_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "force", - "in": "query", - "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).", - "schema": { - "type": "boolean", - "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": "wait_if_ongoing", - "in": "query", - "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running.", - "schema": { - "type": "boolean", - "default": true, - "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesFlush_Get_WithIndex 200 response" - } - }, - "x-operation-group": "indices.flush", - "x-version-added": "1.0" - }, - "post": { - "description": "Performs the flush operation on one or more indices.", - "operationId": "IndicesFlush_Post_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "force", - "in": "query", - "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).", - "schema": { - "type": "boolean", - "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": "wait_if_ongoing", - "in": "query", - "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running.", - "schema": { - "type": "boolean", - "default": true, - "description": "If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesFlush_Post_WithIndex 200 response" - } - }, - "x-operation-group": "indices.flush", - "x-version-added": "1.0" - } - }, - "/{index}/_forcemerge": { - "post": { - "description": "Performs the force merge operation on one or more indices.", - "operationId": "IndicesForcemerge_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "flush", - "in": "query", - "description": "Specify whether the index should be flushed after performing the operation.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specify whether the index should be flushed after performing the operation." - } - }, - { - "name": "primary_only", - "in": "query", - "description": "Specify whether the operation should only perform on primary shards. Defaults to false.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether the operation should only perform on primary shards. Defaults to false." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "max_num_segments", - "in": "query", - "description": "The number of segments the index should be merged into (default: dynamic).", - "schema": { - "type": "integer", - "description": "The number of segments the index should be merged into (default: dynamic).", - "format": "int32" - } - }, - { - "name": "only_expunge_deletes", - "in": "query", - "description": "Specify whether the operation should only expunge deleted documents.", - "schema": { - "type": "boolean", - "description": "Specify whether the operation should only expunge deleted documents." - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": true, - "description": "Should this request wait until the operation has completed before returning." - } - } - ], - "responses": { - "200": { - "description": "IndicesForcemerge_WithIndex 200 response" - } - }, - "x-operation-group": "indices.forcemerge", - "x-version-added": "1.0" - } - }, - "/{index}/_mapping": { - "get": { - "description": "Returns mappings for one or more indices.", - "operationId": "IndicesGetMapping_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "x-version-deprecated": "1.0", - "x-deprecation-message": "This parameter is a no-op and field mappings are always retrieved locally.", - "deprecated": true - } - } - ], - "responses": { - "200": { - "description": "IndicesGetMapping_WithIndex 200 response" - } - }, - "x-operation-group": "indices.get_mapping", - "x-version-added": "1.0" - }, - "post": { - "description": "Updates the index mappings.", - "operationId": "IndicesPutMapping_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutMapping_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "write_index_only", - "in": "query", - "description": "When true, applies mappings only to the write index of an alias or data stream.", - "schema": { - "type": "boolean", - "default": false, - "description": "When true, applies mappings only to the write index of an alias or data stream." - } - } - ], - "responses": { - "200": { - "description": "IndicesPutMapping_Post 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutMapping_PostResponseContent" - } - } - } - } - }, - "x-operation-group": "indices.put_mapping", - "x-version-added": "1.0" - }, - "put": { - "description": "Updates the index mappings.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/" - }, - "operationId": "IndicesPutMapping_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutMapping_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "write_index_only", - "in": "query", - "description": "When true, applies mappings only to the write index of an alias or data stream.", - "schema": { - "type": "boolean", - "default": false, - "description": "When true, applies mappings only to the write index of an alias or data stream." - } - } - ], - "responses": { - "200": { - "description": "IndicesPutMapping_Put 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutMapping_PutResponseContent" - } - } - } - } - }, - "x-operation-group": "indices.put_mapping", - "x-version-added": "1.0" - } - }, - "/{index}/_mapping/field/{fields}": { - "get": { - "description": "Returns mapping for one or more fields.", - "operationId": "IndicesGetFieldMapping_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "fields", - "in": "path", - "description": "Comma-separated list of fields.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of fields.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "include_defaults", - "in": "query", - "description": "Whether the default mapping values should be returned as well.", - "schema": { - "type": "boolean", - "description": "Whether the default mapping values should be returned as well." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetFieldMapping_WithIndex 200 response" - } - }, - "x-operation-group": "indices.get_field_mapping", - "x-version-added": "1.0" - } - }, - "/{index}/_mget": { - "get": { - "description": "Allows to get multiple documents in one request.", - "operationId": "Mget_Get_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Index name." - }, - "required": true - }, - { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specify whether to perform the operation in realtime or search mode.", - "schema": { - "type": "boolean", - "description": "Specify whether to perform the operation in realtime or search mode." - } - }, - { - "name": "refresh", - "in": "query", - "description": "Refresh the shard containing the document before performing the operation.", - "schema": { - "type": "boolean", - "description": "Refresh the shard containing the document before performing the operation." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - } - ], - "responses": { - "200": { - "description": "Mget_Get_WithIndex 200 response" - } - }, - "x-operation-group": "mget", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to get multiple documents in one request.", - "operationId": "Mget_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Mget_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Index name." - }, - "required": true - }, - { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specify whether to perform the operation in realtime or search mode.", - "schema": { - "type": "boolean", - "description": "Specify whether to perform the operation in realtime or search mode." - } - }, - { - "name": "refresh", - "in": "query", - "description": "Refresh the shard containing the document before performing the operation.", - "schema": { - "type": "boolean", - "description": "Refresh the shard containing the document before performing the operation." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - } - ], - "responses": { - "200": { - "description": "Mget_Post_WithIndex 200 response" - } - }, - "x-operation-group": "mget", - "x-version-added": "1.0" - } - }, - "/{index}/_msearch": { - "get": { - "description": "Allows to execute several search operations in one request.", - "operationId": "Msearch_Get_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to use as default.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to use as default.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" - } - }, - { - "name": "max_concurrent_searches", - "in": "query", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "schema": { - "type": "integer", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "format": "int32" - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "pre_filter_shard_size", - "in": "query", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "schema": { - "type": "integer", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "format": "int32" - } - }, - { - "name": "max_concurrent_shard_requests", - "in": "query", - "description": "The number of concurrent shard requests each sub search executes concurrently per node. 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.", - "schema": { - "type": "integer", - "default": 5, - "description": "The number of concurrent shard requests each sub search executes concurrently per node. 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.", - "format": "int32" - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - } - ], - "responses": { - "200": { - "description": "Msearch_Get_WithIndex 200 response" - } - }, - "x-operation-group": "msearch", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to execute several search operations in one request.", - "operationId": "Msearch_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Msearch_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to use as default.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to use as default.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" - } - }, - { - "name": "max_concurrent_searches", - "in": "query", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "schema": { - "type": "integer", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "format": "int32" - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "pre_filter_shard_size", - "in": "query", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "schema": { - "type": "integer", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "format": "int32" - } - }, - { - "name": "max_concurrent_shard_requests", - "in": "query", - "description": "The number of concurrent shard requests each sub search executes concurrently per node. 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.", - "schema": { - "type": "integer", - "default": 5, - "description": "The number of concurrent shard requests each sub search executes concurrently per node. 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.", - "format": "int32" - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - } - ], - "responses": { - "200": { - "description": "Msearch_Post_WithIndex 200 response" - } - }, - "x-operation-group": "msearch", - "x-version-added": "1.0" - } - }, - "/{index}/_msearch/template": { - "get": { - "description": "Allows to execute several search template operations in one request.", - "operationId": "MsearchTemplate_Get_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to use as default.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to use as default.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "max_concurrent_searches", - "in": "query", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "schema": { - "type": "integer", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "format": "int32" - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - } - ], - "responses": { - "200": { - "description": "MsearchTemplate_Get_WithIndex 200 response" - } - }, - "x-operation-group": "msearch_template", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to execute several search template operations in one request.", - "operationId": "MsearchTemplate_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MsearchTemplate_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to use as default.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to use as default.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "max_concurrent_searches", - "in": "query", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "schema": { - "type": "integer", - "description": "Controls the maximum number of concurrent searches the multi search api will execute.", - "format": "int32" - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - } - ], - "responses": { - "200": { - "description": "MsearchTemplate_Post_WithIndex 200 response" - } - }, - "x-operation-group": "msearch_template", - "x-version-added": "1.0" - } - }, - "/{index}/_mtermvectors": { - "get": { - "description": "Returns multiple termvectors in one request.", - "operationId": "Mtermvectors_Get_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The index in which the document resides.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The index in which the document resides." - }, - "required": true - }, - { - "name": "ids", - "in": "query", - "description": "Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body." - }, - "explode": true - }, - { - "name": "term_statistics", - "in": "query", - "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'.", - "schema": { - "type": "boolean", - "default": false, - "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": "field_statistics", - "in": "query", - "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'.", - "schema": { - "type": "boolean", - "default": true, - "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": "fields", - "in": "query", - "description": "Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - }, - "explode": true - }, - { - "name": "offsets", - "in": "query", - "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "positions", - "in": "query", - "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "payloads", - "in": "query", - "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "string", - "description": "Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specifies if requests are real-time as opposed to near-real-time.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if requests are real-time as opposed to near-real-time." - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "Mtermvectors_Get_WithIndex 200 response" - } - }, - "x-operation-group": "mtermvectors", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns multiple termvectors in one request.", - "operationId": "Mtermvectors_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Mtermvectors_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The index in which the document resides.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The index in which the document resides." - }, - "required": true - }, - { - "name": "ids", - "in": "query", - "description": "Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body." - }, - "explode": true - }, - { - "name": "term_statistics", - "in": "query", - "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'.", - "schema": { - "type": "boolean", - "default": false, - "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": "field_statistics", - "in": "query", - "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'.", - "schema": { - "type": "boolean", - "default": true, - "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": "fields", - "in": "query", - "description": "Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - }, - "explode": true - }, - { - "name": "offsets", - "in": "query", - "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "positions", - "in": "query", - "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "payloads", - "in": "query", - "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.", - "schema": { - "type": "string", - "description": "Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specifies if requests are real-time as opposed to near-real-time.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if requests are real-time as opposed to near-real-time." - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "Mtermvectors_Post_WithIndex 200 response" - } - }, - "x-operation-group": "mtermvectors", - "x-version-added": "1.0" - } - }, - "/{index}/_open": { - "post": { - "description": "Opens an index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/open-index/" - }, - "operationId": "IndicesOpen", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices to open.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices to open.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of active shards to wait for before the operation returns.", - "schema": { - "type": "string", - "description": "Sets the number of active shards to wait for before the operation returns." - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": true, - "description": "Should this request wait until the operation has completed before returning." - } - }, - { - "name": "task_execution_timeout", - "in": "query", - "description": "Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesOpen 200 response" - } - }, - "x-operation-group": "indices.open", - "x-version-added": "1.0" - } - }, - "/{index}/_rank_eval": { - "get": { - "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries.", - "operationId": "RankEval_Get_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchType" - } - } - ], - "responses": { - "200": { - "description": "RankEval_Get_WithIndex 200 response" - } - }, - "x-operation-group": "rank_eval", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to evaluate the quality of ranked search results over a set of typical search queries.", - "operationId": "RankEval_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RankEval_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchType" - } - } - ], - "responses": { - "200": { - "description": "RankEval_Post_WithIndex 200 response" - } - }, - "x-operation-group": "rank_eval", - "x-version-added": "1.0" - } - }, - "/{index}/_recovery": { - "get": { - "description": "Returns information about ongoing index shard recoveries.", - "operationId": "IndicesRecovery_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "detailed", - "in": "query", - "description": "Whether to display detailed information about shard recovery.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to display detailed information about shard recovery." - } - }, - { - "name": "active_only", - "in": "query", - "description": "Display only those recoveries that are currently on-going.", - "schema": { - "type": "boolean", - "default": false, - "description": "Display only those recoveries that are currently on-going." - } - } - ], - "responses": { - "200": { - "description": "IndicesRecovery_WithIndex 200 response" - } - }, - "x-operation-group": "indices.recovery", - "x-version-added": "1.0" - } - }, - "/{index}/_refresh": { - "get": { - "description": "Performs the refresh operation in one or more indices.", - "operationId": "IndicesRefresh_Get_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesRefresh_Get_WithIndex 200 response" - } - }, - "x-operation-group": "indices.refresh", - "x-version-added": "1.0" - }, - "post": { - "description": "Performs the refresh operation in one or more indices.", - "operationId": "IndicesRefresh_Post_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesRefresh_Post_WithIndex 200 response" - } - }, - "x-operation-group": "indices.refresh", - "x-version-added": "1.0" - } - }, - "/{index}/_search": { - "get": { - "description": "Returns results matching a query.", - "operationId": "Search_Get_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "explain", - "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." - } - }, - { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true - }, - { - "name": "docvalue_fields", - "in": "query", - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit." - }, - "explode": true - }, - { - "name": "from", - "in": "query", - "description": "Starting offset.", - "schema": { - "type": "integer", - "default": 0, - "description": "Starting offset.", - "format": "int32" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchType" - } - }, - { - "name": "size", - "in": "query", - "description": "Number of hits to return.", - "schema": { - "type": "integer", - "default": 10, - "description": "Number of hits to return.", - "format": "int32" - } - }, - { - "name": "sort", - "in": "query", - "description": "Comma-separated list of : pairs.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of : pairs." - }, - "explode": true - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - }, - { - "name": "terminate_after", - "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" - } - }, - { - "name": "stats", - "in": "query", - "description": "Specific 'tag' of the request for logging and statistical purposes.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specific 'tag' of the request for logging and statistical purposes." - }, - "explode": true - }, - { - "name": "suggest_field", - "in": "query", - "description": "Specify which field to use for suggestions.", - "schema": { - "type": "string", - "description": "Specify which field to use for suggestions." - } - }, - { - "name": "suggest_mode", - "in": "query", - "description": "Specify suggest mode.", - "schema": { - "$ref": "#/components/schemas/SuggestMode" - } - }, - { - "name": "suggest_size", - "in": "query", - "description": "How many suggestions to return in response.", - "schema": { - "type": "integer", - "description": "How many suggestions to return in response.", - "format": "int32" - } - }, - { - "name": "suggest_text", - "in": "query", - "description": "The source text for which the suggestions should be returned.", - "schema": { - "type": "string", - "description": "The source text for which the suggestions should be returned." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "track_scores", - "in": "query", - "description": "Whether to calculate and return scores even if they are not used for sorting.", - "schema": { - "type": "boolean", - "description": "Whether to calculate and return scores even if they are not used for sorting." - } - }, - { - "name": "track_total_hits", - "in": "query", - "description": "Indicate if the number of documents that match the query should be tracked.", - "schema": { - "type": "boolean", - "description": "Indicate if the number of documents that match the query should be tracked." - } - }, - { - "name": "allow_partial_search_results", - "in": "query", - "description": "Indicate if an error should be returned if there is a partial search failure or timeout.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicate if an error should be returned if there is a partial search failure or timeout." - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "version", - "in": "query", - "description": "Whether to return document version as part of a hit.", - "schema": { - "type": "boolean", - "description": "Whether to return document version as part of a hit." - } - }, - { - "name": "seq_no_primary_term", - "in": "query", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit." - } - }, - { - "name": "request_cache", - "in": "query", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", - "schema": { - "type": "boolean", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting." - } - }, - { - "name": "batched_reduce_size", - "in": "query", - "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.", - "schema": { - "type": "integer", - "default": 512, - "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.", - "format": "int32" - } - }, - { - "name": "max_concurrent_shard_requests", - "in": "query", - "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.", - "schema": { - "type": "integer", - "default": 5, - "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.", - "format": "int32" - } - }, - { - "name": "pre_filter_shard_size", - "in": "query", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "schema": { - "type": "integer", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "format": "int32" - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "search_pipeline", - "in": "query", - "description": "Customizable sequence of processing stages applied to search queries.", - "schema": { - "type": "string", - "description": "Customizable sequence of processing stages applied to search queries." - } - }, - { - "name": "include_named_queries_score", - "in": "query", - "description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)" - } - } - ], - "responses": { - "200": { - "description": "Search_Get_WithIndex 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search_Get_WithIndexResponseContent" - } - } - } - } - }, - "x-operation-group": "search", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns results matching a query.", - "operationId": "Search_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search_BodyParams" - }, - "examples": { - "Search_Post_WithIndex_example1": { - "summary": "Examples for Post Search With Index Operation.", - "description": "", - "value": { - "query": { - "match_all": {} - }, - "fields": [ - "*" - ] - } - } - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true, - "examples": { - "Search_Post_WithIndex_example1": { - "summary": "Examples for Post Search With Index Operation.", - "description": "", - "value": "books" - } - } - }, - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "explain", - "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." - } - }, - { - "name": "stored_fields", - "in": "query", - "description": "Comma-separated list of stored fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of stored fields to return." - }, - "explode": true - }, - { - "name": "docvalue_fields", - "in": "query", - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return as the docvalue representation of a field for each hit." - }, - "explode": true - }, - { - "name": "from", - "in": "query", - "description": "Starting offset.", - "schema": { - "type": "integer", - "default": 0, - "description": "Starting offset.", - "format": "int32" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - }, - "examples": { - "Search_Post_WithIndex_example1": { - "summary": "Examples for Post Search With Index Operation.", - "description": "", - "value": "1d" - } - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchType" - } - }, - { - "name": "size", - "in": "query", - "description": "Number of hits to return.", - "schema": { - "type": "integer", - "default": 10, - "description": "Number of hits to return.", - "format": "int32" - } - }, - { - "name": "sort", - "in": "query", - "description": "Comma-separated list of : pairs.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of : pairs." - }, - "explode": true - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - }, - { - "name": "terminate_after", - "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" - } - }, - { - "name": "stats", - "in": "query", - "description": "Specific 'tag' of the request for logging and statistical purposes.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specific 'tag' of the request for logging and statistical purposes." - }, - "explode": true - }, - { - "name": "suggest_field", - "in": "query", - "description": "Specify which field to use for suggestions.", - "schema": { - "type": "string", - "description": "Specify which field to use for suggestions." - } - }, - { - "name": "suggest_mode", - "in": "query", - "description": "Specify suggest mode.", - "schema": { - "$ref": "#/components/schemas/SuggestMode" - } - }, - { - "name": "suggest_size", - "in": "query", - "description": "How many suggestions to return in response.", - "schema": { - "type": "integer", - "description": "How many suggestions to return in response.", - "format": "int32" - } - }, - { - "name": "suggest_text", - "in": "query", - "description": "The source text for which the suggestions should be returned.", - "schema": { - "type": "string", - "description": "The source text for which the suggestions should be returned." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "track_scores", - "in": "query", - "description": "Whether to calculate and return scores even if they are not used for sorting.", - "schema": { - "type": "boolean", - "description": "Whether to calculate and return scores even if they are not used for sorting." - } - }, - { - "name": "track_total_hits", - "in": "query", - "description": "Indicate if the number of documents that match the query should be tracked.", - "schema": { - "type": "boolean", - "description": "Indicate if the number of documents that match the query should be tracked." - } - }, - { - "name": "allow_partial_search_results", - "in": "query", - "description": "Indicate if an error should be returned if there is a partial search failure or timeout.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicate if an error should be returned if there is a partial search failure or timeout." - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "version", - "in": "query", - "description": "Whether to return document version as part of a hit.", - "schema": { - "type": "boolean", - "description": "Whether to return document version as part of a hit." - } - }, - { - "name": "seq_no_primary_term", - "in": "query", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return sequence number and primary term of the last modification of each hit." - } - }, - { - "name": "request_cache", - "in": "query", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", - "schema": { - "type": "boolean", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting." - } - }, - { - "name": "batched_reduce_size", - "in": "query", - "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.", - "schema": { - "type": "integer", - "default": 512, - "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.", - "format": "int32" - } - }, - { - "name": "max_concurrent_shard_requests", - "in": "query", - "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.", - "schema": { - "type": "integer", - "default": 5, - "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.", - "format": "int32" - } - }, - { - "name": "pre_filter_shard_size", - "in": "query", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "schema": { - "type": "integer", - "description": "Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.", - "format": "int32" - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "search_pipeline", - "in": "query", - "description": "Customizable sequence of processing stages applied to search queries.", - "schema": { - "type": "string", - "description": "Customizable sequence of processing stages applied to search queries." - } - }, - { - "name": "include_named_queries_score", - "in": "query", - "description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)" - } - } - ], - "responses": { - "200": { - "description": "Search_Post_WithIndex 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Search_Post_WithIndexResponseContent" - }, - "examples": { - "Search_Post_WithIndex_example1": { - "summary": "Examples for Post Search With Index Operation.", - "description": "", - "value": { - "timed_out": false, - "_shards": { - "total": 1, - "successful": 1, - "skipped": 0, - "failed": 0 - }, - "hits": { - "total": { - "value": 0, - "relation": "eq" - }, - "hits": [] - } - } - } - } - } - } - } - }, - "x-operation-group": "search", - "x-version-added": "1.0" - } - }, - "/{index}/_search/point_in_time": { - "post": { - "description": "Creates point in time context.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#create-a-pit" - }, - "operationId": "CreatePit", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "allow_partial_pit_creation", - "in": "query", - "description": "Allow if point in time can be created with partial failures.", - "schema": { - "type": "boolean", - "description": "Allow if point in time can be created with partial failures." - } - }, - { - "name": "keep_alive", - "in": "query", - "description": "Specify the keep alive for point in time.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify the keep alive for point in time.", - "x-data-type": "time" - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "CreatePit 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreatePitResponseContent" - } - } - } - } - }, - "x-operation-group": "create_pit", - "x-version-added": "2.4" - } - }, - "/{index}/_search/template": { - "get": { - "description": "Allows to use the Mustache language to pre-render a search definition.", - "operationId": "SearchTemplate_Get_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" - } - }, - { - "name": "explain", - "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." - } - }, - { - "name": "profile", - "in": "query", - "description": "Specify whether to profile the query execution.", - "schema": { - "type": "boolean", - "description": "Specify whether to profile the query execution." - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - } - ], - "responses": { - "200": { - "description": "SearchTemplate_Get_WithIndex 200 response" - } - }, - "x-operation-group": "search_template", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows to use the Mustache language to pre-render a search definition.", - "operationId": "SearchTemplate_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SearchTemplate_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "ignore_throttled", - "in": "query", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled.", - "schema": { - "type": "boolean", - "description": "Whether specified concrete, expanded or aliased indices should be ignored when throttled." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchTypeMulti" - } - }, - { - "name": "explain", - "in": "query", - "description": "Specify whether to return detailed information about score computation as part of a hit.", - "schema": { - "type": "boolean", - "description": "Specify whether to return detailed information about score computation as part of a hit." - } - }, - { - "name": "profile", - "in": "query", - "description": "Specify whether to profile the query execution.", - "schema": { - "type": "boolean", - "description": "Specify whether to profile the query execution." - } - }, - { - "name": "typed_keys", - "in": "query", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response.", - "schema": { - "type": "boolean", - "description": "Specify whether aggregation and suggester names should be prefixed by their respective types in the response." - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response.", - "schema": { - "type": "boolean", - "default": false, - "description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response." - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.", - "schema": { - "type": "boolean", - "default": true, - "description": "Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution." - } - } - ], - "responses": { - "200": { - "description": "SearchTemplate_Post_WithIndex 200 response" - } - }, - "x-operation-group": "search_template", - "x-version-added": "1.0" - } - }, - "/{index}/_search_shards": { - "get": { - "description": "Returns information about the indices and shards that a search request would be executed against.", - "operationId": "SearchShards_Get_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "SearchShards_Get_WithIndex 200 response" - } - }, - "x-operation-group": "search_shards", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns information about the indices and shards that a search request would be executed against.", - "operationId": "SearchShards_Post_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "SearchShards_Post_WithIndex 200 response" - } - }, - "x-operation-group": "search_shards", - "x-version-added": "1.0" - } - }, - "/{index}/_segments": { - "get": { - "description": "Provides low-level information about segments in a Lucene index.", - "operationId": "IndicesSegments_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "verbose", - "in": "query", - "description": "Includes detailed memory usage by Lucene.", - "schema": { - "type": "boolean", - "default": false, - "description": "Includes detailed memory usage by Lucene." - } - } - ], - "responses": { - "200": { - "description": "IndicesSegments_WithIndex 200 response" - } - }, - "x-operation-group": "indices.segments", - "x-version-added": "1.0" - } - }, - "/{index}/_settings": { - "get": { - "description": "Returns settings for one or more indices.", - "operationId": "IndicesGetSettings_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true, - "examples": { - "IndicesGetSettings_WithIndex_example1": { - "summary": "Examples for Get settings Index Operation.", - "description": "", - "value": "books" - } - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "include_defaults", - "in": "query", - "description": "Whether to return all default setting for each of the indices.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to return all default setting for each of the indices." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetSettings_WithIndex 200 response" - } - }, - "x-operation-group": "indices.get_settings", - "x-version-added": "1.0" - }, - "put": { - "description": "Updates the index settings.", - "operationId": "IndicesPutSettings_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesPutSettings_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "preserve_existing", - "in": "query", - "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to update existing settings. If set to `true` existing settings on an index remain unchanged." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - } - ], - "responses": { - "200": { - "description": "IndicesPutSettings_WithIndex 200 response" - } - }, - "x-operation-group": "indices.put_settings", - "x-version-added": "1.0" - } - }, - "/{index}/_settings/{name}": { - "get": { - "description": "Returns settings for one or more indices.", - "operationId": "IndicesGetSettings_WithIndexName", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true, - "examples": { - "IndicesGetSettings_WithIndexName_example1": { - "summary": "Examples for Get settings Index-setting Operation.", - "description": "", - "value": "books" - } - } - }, - { - "name": "name", - "in": "path", - "description": "Comma-separated list of settings.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of settings.", - "x-data-type": "array" - }, - "required": true, - "examples": { - "IndicesGetSettings_WithIndexName_example1": { - "summary": "Examples for Get settings Index-setting Operation.", - "description": "", - "value": "index" - } - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "flat_settings", - "in": "query", - "description": "Return settings in flat format.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return settings in flat format." - } - }, - { - "name": "local", - "in": "query", - "description": "Return local information, do not retrieve the state from cluster-manager node.", - "schema": { - "type": "boolean", - "default": false, - "description": "Return local information, do not retrieve the state from cluster-manager node." - } - }, - { - "name": "include_defaults", - "in": "query", - "description": "Whether to return all default setting for each of the indices.", - "schema": { - "type": "boolean", - "default": false, - "description": "Whether to return all default setting for each of the indices." - } - } - ], - "responses": { - "200": { - "description": "IndicesGetSettings_WithIndexName 200 response" - } - }, - "x-operation-group": "indices.get_settings", - "x-version-added": "1.0" - } - }, - "/{index}/_shard_stores": { - "get": { - "description": "Provides store information for shard copies of indices.", - "operationId": "IndicesShardStores_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "status", - "in": "query", - "description": "Comma-separated list of statuses used to filter on shards to get store information for.", - "style": "form", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Status_Member" - }, - "description": "Comma-separated list of statuses used to filter on shards to get store information for." - }, - "explode": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesShardStores_WithIndex 200 response" - } - }, - "x-operation-group": "indices.shard_stores", - "x-version-added": "1.0" - } - }, - "/{index}/_shrink/{target}": { - "post": { - "description": "Allow to shrink an existing index into a new index with fewer primary shards.", - "operationId": "IndicesShrink_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesShrink_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The name of the source index to shrink.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the source index to shrink." - }, - "required": true - }, - { - "name": "target", - "in": "path", - "description": "The name of the target index.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the target index." - }, - "required": true - }, - { - "name": "copy_settings", - "in": "query", - "description": "whether or not to copy settings from the source index.", - "schema": { - "type": "boolean", - "default": false, - "description": "whether or not to copy settings from the source index." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Set the number of active shards to wait for on the shrunken index before the operation returns.", - "schema": { - "type": "string", - "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": true, - "description": "Should this request wait until the operation has completed before returning." - } - }, - { - "name": "task_execution_timeout", - "in": "query", - "description": "Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesShrink_Post 200 response" - } - }, - "x-operation-group": "indices.shrink", - "x-version-added": "1.0" - }, - "put": { - "description": "Allow to shrink an existing index into a new index with fewer primary shards.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/" - }, - "operationId": "IndicesShrink_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesShrink_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The name of the source index to shrink.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the source index to shrink." - }, - "required": true - }, - { - "name": "target", - "in": "path", - "description": "The name of the target index.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the target index." - }, - "required": true - }, - { - "name": "copy_settings", - "in": "query", - "description": "whether or not to copy settings from the source index.", - "schema": { - "type": "boolean", - "default": false, - "description": "whether or not to copy settings from the source index." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Set the number of active shards to wait for on the shrunken index before the operation returns.", - "schema": { - "type": "string", - "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": true, - "description": "Should this request wait until the operation has completed before returning." - } - }, - { - "name": "task_execution_timeout", - "in": "query", - "description": "Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesShrink_Put 200 response" - } - }, - "x-operation-group": "indices.shrink", - "x-version-added": "1.0" - } - }, - "/{index}/_source/{id}": { - "get": { - "description": "Returns the source of a document.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/" - }, - "operationId": "GetSource", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Document ID." - }, - "required": true, - "examples": { - "GetSource_example1": { - "summary": "Examples for Get document source Operation.", - "description": "", - "value": "1" - } - } - }, - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Index name." - }, - "required": true, - "examples": { - "GetSource_example1": { - "summary": "Examples for Get document source Operation.", - "description": "", - "value": "books" - } - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specify whether to perform the operation in realtime or search mode.", - "schema": { - "type": "boolean", - "description": "Specify whether to perform the operation in realtime or search mode." - } - }, - { - "name": "refresh", - "in": "query", - "description": "Refresh the shard containing the document before performing the operation.", - "schema": { - "type": "boolean", - "description": "Refresh the shard containing the document before performing the operation." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "GetSource 200 response" - } - }, - "x-operation-group": "get_source", - "x-version-added": "1.0" - }, - "head": { - "description": "Returns information about whether a document source exists in an index.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/" - }, - "operationId": "ExistsSource", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Document ID." - }, - "required": true - }, - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Index name." - }, - "required": true - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specify whether to perform the operation in realtime or search mode.", - "schema": { - "type": "boolean", - "description": "Specify whether to perform the operation in realtime or search mode." - } - }, - { - "name": "refresh", - "in": "query", - "description": "Refresh the shard containing the document before performing the operation.", - "schema": { - "type": "boolean", - "description": "Refresh the shard containing the document before performing the operation." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "ExistsSource 200 response" - } - }, - "x-operation-group": "exists_source", - "x-version-added": "1.0" - } - }, - "/{index}/_split/{target}": { - "post": { - "description": "Allows you to split an existing index into a new index with more primary shards.", - "operationId": "IndicesSplit_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesSplit_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The name of the source index to split.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the source index to split." - }, - "required": true - }, - { - "name": "target", - "in": "path", - "description": "The name of the target index.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the target index." - }, - "required": true - }, - { - "name": "copy_settings", - "in": "query", - "description": "whether or not to copy settings from the source index.", - "schema": { - "type": "boolean", - "default": false, - "description": "whether or not to copy settings from the source index." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Set the number of active shards to wait for on the shrunken index before the operation returns.", - "schema": { - "type": "string", - "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": true, - "description": "Should this request wait until the operation has completed before returning." - } - }, - { - "name": "task_execution_timeout", - "in": "query", - "description": "Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesSplit_Post 200 response" - } - }, - "x-operation-group": "indices.split", - "x-version-added": "1.0" - }, - "put": { - "description": "Allows you to split an existing index into a new index with more primary shards.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/index-apis/split/" - }, - "operationId": "IndicesSplit_Put", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesSplit_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The name of the source index to split.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the source index to split." - }, - "required": true - }, - { - "name": "target", - "in": "path", - "description": "The name of the target index.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The name of the target index." - }, - "required": true - }, - { - "name": "copy_settings", - "in": "query", - "description": "whether or not to copy settings from the source index.", - "schema": { - "type": "boolean", - "default": false, - "description": "whether or not to copy settings from the source index." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "master_timeout", - "in": "query", - "description": "Operation timeout for connection to master node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to master node.", - "x-version-deprecated": "2.0.0", - "x-data-type": "time", - "x-deprecation-message": "To promote inclusive language, use 'cluster_manager_timeout' instead.", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "description": "Operation timeout for connection to cluster-manager node.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout for connection to cluster-manager node.", - "x-version-added": "2.0.0", - "x-data-type": "time" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Set the number of active shards to wait for on the shrunken index before the operation returns.", - "schema": { - "type": "string", - "description": "Set the number of active shards to wait for on the shrunken index before the operation returns." - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": true, - "description": "Should this request wait until the operation has completed before returning." - } - }, - { - "name": "task_execution_timeout", - "in": "query", - "description": "Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.", - "x-data-type": "time" - } - } - ], - "responses": { - "200": { - "description": "IndicesSplit_Put 200 response" - } - }, - "x-operation-group": "indices.split", - "x-version-added": "1.0" - } - }, - "/{index}/_stats": { - "get": { - "description": "Provides statistics on operations happening in an index.", - "operationId": "IndicesStats_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "completion_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fielddata_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "groups", - "in": "query", - "description": "Comma-separated list of search groups for `search` index metric.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of search groups for `search` index metric." - }, - "explode": true - }, - { - "name": "level", - "in": "query", - "description": "Return stats aggregated at cluster, index or shard level.", - "schema": { - "$ref": "#/components/schemas/IndiciesStatLevel" - } - }, - { - "name": "include_segment_file_sizes", - "in": "query", - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", - "schema": { - "type": "boolean", - "default": false, - "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_unloaded_segments", - "in": "query", - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory.", - "schema": { - "type": "boolean", - "default": false, - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "forbid_closed_indices", - "in": "query", - "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices.", - "schema": { - "type": "boolean", - "default": true, - "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices." - } - } - ], - "responses": { - "200": { - "description": "IndicesStats_WithIndex 200 response" - } - }, - "x-operation-group": "indices.stats", - "x-version-added": "1.0" - } - }, - "/{index}/_stats/{metric}": { - "get": { - "description": "Provides statistics on operations happening in an index.", - "operationId": "IndicesStats_WithIndexMetric", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "metric", - "in": "path", - "description": "Limit the information returned the specific metrics.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Limit the information returned the specific metrics.", - "x-enum-options": [ - "_all", - "store", - "indexing", - "get", - "search", - "merge", - "flush", - "refresh", - "query_cache", - "fielddata", - "docs", - "warmer", - "completion", - "segments", - "translog", - "suggest", - "request_cache", - "recovery" - ], - "x-data-type": "array" - }, - "required": true - }, - { - "name": "completion_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fielddata_fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)." - }, - "explode": true - }, - { - "name": "groups", - "in": "query", - "description": "Comma-separated list of search groups for `search` index metric.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of search groups for `search` index metric." - }, - "explode": true - }, - { - "name": "level", - "in": "query", - "description": "Return stats aggregated at cluster, index or shard level.", - "schema": { - "$ref": "#/components/schemas/IndiciesStatLevel" - } - }, - { - "name": "include_segment_file_sizes", - "in": "query", - "description": "Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).", - "schema": { - "type": "boolean", - "default": false, - "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_unloaded_segments", - "in": "query", - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory.", - "schema": { - "type": "boolean", - "default": false, - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory." - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "forbid_closed_indices", - "in": "query", - "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices.", - "schema": { - "type": "boolean", - "default": true, - "description": "If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices." - } - } - ], - "responses": { - "200": { - "description": "IndicesStats_WithIndexMetric 200 response" - } - }, - "x-operation-group": "indices.stats", - "x-version-added": "1.0" - } - }, - "/{index}/_termvectors": { - "get": { - "description": "Returns information and statistics about terms in the fields of a particular document.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest" - }, - "operationId": "Termvectors_Get", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The index in which the document resides.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The index in which the document resides." - }, - "required": true - }, - { - "name": "term_statistics", - "in": "query", - "description": "Specifies if total term frequency and document frequency should be returned.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specifies if total term frequency and document frequency should be returned." - } - }, - { - "name": "field_statistics", - "in": "query", - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned." - } - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return." - }, - "explode": true - }, - { - "name": "offsets", - "in": "query", - "description": "Specifies if term offsets should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term offsets should be returned." - } - }, - { - "name": "positions", - "in": "query", - "description": "Specifies if term positions should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term positions should be returned." - } - }, - { - "name": "payloads", - "in": "query", - "description": "Specifies if term payloads should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term payloads should be returned." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specifies if request is real-time as opposed to near-real-time.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if request is real-time as opposed to near-real-time." - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "Termvectors_Get 200 response" - } - }, - "x-operation-group": "termvectors", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns information and statistics about terms in the fields of a particular document.", - "operationId": "Termvectors_Post", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Termvectors_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The index in which the document resides.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The index in which the document resides." - }, - "required": true - }, - { - "name": "term_statistics", - "in": "query", - "description": "Specifies if total term frequency and document frequency should be returned.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specifies if total term frequency and document frequency should be returned." - } - }, - { - "name": "field_statistics", - "in": "query", - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned." - } - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return." - }, - "explode": true - }, - { - "name": "offsets", - "in": "query", - "description": "Specifies if term offsets should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term offsets should be returned." - } - }, - { - "name": "positions", - "in": "query", - "description": "Specifies if term positions should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term positions should be returned." - } - }, - { - "name": "payloads", - "in": "query", - "description": "Specifies if term payloads should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term payloads should be returned." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specifies if request is real-time as opposed to near-real-time.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if request is real-time as opposed to near-real-time." - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "Termvectors_Post 200 response" - } - }, - "x-operation-group": "termvectors", - "x-version-added": "1.0" - } - }, - "/{index}/_termvectors/{id}": { - "get": { - "description": "Returns information and statistics about terms in the fields of a particular document.", - "operationId": "Termvectors_Get_WithId", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The index in which the document resides.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The index in which the document resides." - }, - "required": true - }, - { - "name": "id", - "in": "path", - "description": "Document ID. When not specified a doc param should be supplied.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Document ID. When not specified a doc param should be supplied." - }, - "required": true - }, - { - "name": "term_statistics", - "in": "query", - "description": "Specifies if total term frequency and document frequency should be returned.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specifies if total term frequency and document frequency should be returned." - } - }, - { - "name": "field_statistics", - "in": "query", - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned." - } - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return." - }, - "explode": true - }, - { - "name": "offsets", - "in": "query", - "description": "Specifies if term offsets should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term offsets should be returned." - } - }, - { - "name": "positions", - "in": "query", - "description": "Specifies if term positions should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term positions should be returned." - } - }, - { - "name": "payloads", - "in": "query", - "description": "Specifies if term payloads should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term payloads should be returned." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specifies if request is real-time as opposed to near-real-time.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if request is real-time as opposed to near-real-time." - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "Termvectors_Get_WithId 200 response" - } - }, - "x-operation-group": "termvectors", - "x-version-added": "1.0" - }, - "post": { - "description": "Returns information and statistics about terms in the fields of a particular document.", - "operationId": "Termvectors_Post_WithId", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Termvectors_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "The index in which the document resides.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "The index in which the document resides." - }, - "required": true - }, - { - "name": "id", - "in": "path", - "description": "Document ID. When not specified a doc param should be supplied.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Document ID. When not specified a doc param should be supplied." - }, - "required": true - }, - { - "name": "term_statistics", - "in": "query", - "description": "Specifies if total term frequency and document frequency should be returned.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specifies if total term frequency and document frequency should be returned." - } - }, - { - "name": "field_statistics", - "in": "query", - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned." - } - }, - { - "name": "fields", - "in": "query", - "description": "Comma-separated list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of fields to return." - }, - "explode": true - }, - { - "name": "offsets", - "in": "query", - "description": "Specifies if term offsets should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term offsets should be returned." - } - }, - { - "name": "positions", - "in": "query", - "description": "Specifies if term positions should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term positions should be returned." - } - }, - { - "name": "payloads", - "in": "query", - "description": "Specifies if term payloads should be returned.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if term payloads should be returned." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "realtime", - "in": "query", - "description": "Specifies if request is real-time as opposed to near-real-time.", - "schema": { - "type": "boolean", - "default": true, - "description": "Specifies if request is real-time as opposed to near-real-time." - } - }, - { - "name": "version", - "in": "query", - "description": "Explicit version number for concurrency control.", - "schema": { - "type": "integer", - "description": "Explicit version number for concurrency control.", - "format": "int32" - } - }, - { - "name": "version_type", - "in": "query", - "description": "Specific version type.", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "Termvectors_Post_WithId 200 response" - } - }, - "x-operation-group": "termvectors", - "x-version-added": "1.0" - } - }, - "/{index}/_update/{id}": { - "post": { - "description": "Updates a document with a script or partial document.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/document-apis/update-document/" - }, - "operationId": "Update", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Update_BodyParams" - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Document ID.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Document ID." - }, - "required": true - }, - { - "name": "index", - "in": "path", - "description": "Index name.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Index name." - }, - "required": true - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the 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).", - "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the 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": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - }, - { - "name": "lang", - "in": "query", - "description": "The script language.", - "schema": { - "type": "string", - "default": "painless", - "description": "The script language." - } - }, - { - "name": "refresh", - "in": "query", - "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.", - "schema": { - "$ref": "#/components/schemas/RefreshEnum" - } - }, - { - "name": "retry_on_conflict", - "in": "query", - "description": "Specify how many times should the operation be retried when a conflict occurs.", - "schema": { - "type": "integer", - "default": 0, - "description": "Specify how many times should the operation be retried when a conflict occurs.", - "format": "int32" - } - }, - { - "name": "routing", - "in": "query", - "description": "Routing value.", - "schema": { - "type": "string", - "description": "Routing value." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Operation timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Operation timeout.", - "x-data-type": "time" - } - }, - { - "name": "if_seq_no", - "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", - "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified sequence number.", - "format": "int32" - } - }, - { - "name": "if_primary_term", - "in": "query", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", - "schema": { - "type": "integer", - "description": "only perform the operation if the last operation that has changed the document has the specified primary term.", - "format": "int32" - } - }, - { - "name": "require_alias", - "in": "query", - "description": "When true, requires destination to be an alias.", - "schema": { - "type": "boolean", - "default": false, - "description": "When true, requires destination to be an alias." - } - } - ], - "responses": { - "200": { - "description": "Update 200 response" - } - }, - "x-operation-group": "update", - "x-version-added": "1.0" - } - }, - "/{index}/_update_by_query": { - "post": { - "description": "Performs an update on every document in the index without changing the source,\nfor example to pick up a mapping change.", - "externalDocs": { - "description": "API Reference", - "url": "https://opensearch.org/docs/latest/api-reference/document-apis/update-by-query/" - }, - "operationId": "UpdateByQuery", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateByQuery_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "from", - "in": "query", - "description": "Starting offset.", - "schema": { - "type": "integer", - "default": 0, - "description": "Starting offset.", - "format": "int32" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "conflicts", - "in": "query", - "description": "What to do when the operation encounters version conflicts?.", - "schema": { - "$ref": "#/components/schemas/Conflicts" - } - }, - { - "name": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "pipeline", - "in": "query", - "description": "The pipeline id to preprocess incoming documents with.", - "schema": { - "type": "string", - "description": "The pipeline id to preprocess incoming documents with." - } - }, - { - "name": "preference", - "in": "query", - "description": "Specify the node or shard the operation should be performed on.", - "schema": { - "type": "string", - "default": "random", - "description": "Specify the node or shard the operation should be performed on." - } - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "routing", - "in": "query", - "description": "Comma-separated list of specific routing values.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of specific routing values." - }, - "explode": true - }, - { - "name": "scroll", - "in": "query", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Specify how long a consistent view of the index should be maintained for scrolled search.", - "x-data-type": "time" - } - }, - { - "name": "search_type", - "in": "query", - "description": "Search operation type.", - "schema": { - "$ref": "#/components/schemas/SearchType" - } - }, - { - "name": "search_timeout", - "in": "query", - "description": "Explicit timeout for each search request. Defaults to no timeout.", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Explicit timeout for each search request. Defaults to no timeout.", - "x-data-type": "time" - } - }, - { - "name": "size", - "in": "query", - "description": "Deprecated, please use `max_docs` instead.", - "schema": { - "type": "integer", - "description": "Deprecated, please use `max_docs` instead.", - "format": "int32" - } - }, - { - "name": "max_docs", - "in": "query", - "description": "Maximum number of documents to process (default: all documents).", - "schema": { - "type": "integer", - "description": "Maximum number of documents to process (default: all documents).", - "format": "int32" - } - }, - { - "name": "sort", - "in": "query", - "description": "Comma-separated list of : pairs.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Comma-separated list of : pairs." - }, - "explode": true - }, - { - "name": "_source", - "in": "query", - "description": "True or false to return the _source field or not, or a list of fields to return.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "True or false to return the _source field or not, or a list of fields to return." - }, - "explode": true - }, - { - "name": "_source_excludes", - "in": "query", - "description": "List of fields to exclude from the returned _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to exclude from the returned _source field." - }, - "explode": true - }, - { - "name": "_source_includes", - "in": "query", - "description": "List of fields to extract and return from the _source field.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields to extract and return from the _source field." - }, - "explode": true - }, - { - "name": "terminate_after", - "in": "query", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "schema": { - "type": "integer", - "description": "The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.", - "format": "int32" - } - }, - { - "name": "stats", - "in": "query", - "description": "Specific 'tag' of the request for logging and statistical purposes.", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specific 'tag' of the request for logging and statistical purposes." - }, - "explode": true - }, - { - "name": "version", - "in": "query", - "description": "Whether to return document version as part of a hit.", - "schema": { - "type": "boolean", - "description": "Whether to return document version as part of a hit." - } - }, - { - "name": "request_cache", - "in": "query", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting.", - "schema": { - "type": "boolean", - "description": "Specify if request cache should be used for this request or not, defaults to index level setting." - } - }, - { - "name": "refresh", - "in": "query", - "description": "Should the affected indexes be refreshed?.", - "schema": { - "type": "boolean", - "description": "Should the affected indexes be refreshed?." - } - }, - { - "name": "timeout", - "in": "query", - "description": "Time each individual bulk request should wait for shards that are unavailable.", - "schema": { - "type": "string", - "default": "1m", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "description": "Time each individual bulk request should wait for shards that are unavailable.", - "x-data-type": "time" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "description": "Sets the number of shard copies that must be active before proceeding with the 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).", - "schema": { - "type": "string", - "default": "1", - "description": "Sets the number of shard copies that must be active before proceeding with the 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": "scroll_size", - "in": "query", - "description": "Size on the scroll request powering the operation.", - "schema": { - "type": "integer", - "default": 100, - "description": "Size on the scroll request powering the operation.", - "format": "int32" - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": true, - "description": "Should this request wait until the operation has completed before returning." - } - }, - { - "name": "requests_per_second", - "in": "query", - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "schema": { - "type": "integer", - "default": 0, - "description": "The throttle for this request in sub-requests per second. -1 means no throttle.", - "format": "int32" - } - }, - { - "name": "slices", - "in": "query", - "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`.", - "schema": { - "type": "string", - "default": "1", - "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`." - } - } - ], - "responses": { - "200": { - "description": "UpdateByQuery 200 response" - } - }, - "x-operation-group": "update_by_query", - "x-version-added": "1.0" - } - }, - "/{index}/_upgrade": { - "get": { - "description": "The _upgrade API is no longer useful and will be removed.", - "operationId": "IndicesGetUpgrade_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - } - ], - "responses": { - "200": { - "description": "IndicesGetUpgrade_WithIndex 200 response" - } - }, - "x-operation-group": "indices.get_upgrade", - "x-version-added": "1.0" - }, - "post": { - "description": "The _upgrade API is no longer useful and will be removed.", - "operationId": "IndicesUpgrade_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "wait_for_completion", - "in": "query", - "description": "Should this request wait until the operation has completed before returning.", - "schema": { - "type": "boolean", - "default": false, - "description": "Should this request wait until the operation has completed before returning." - } - }, - { - "name": "only_ancient_segments", - "in": "query", - "description": "If true, only ancient (an older Lucene major release) segments will be upgraded.", - "schema": { - "type": "boolean", - "description": "If true, only ancient (an older Lucene major release) segments will be upgraded." - } - } - ], - "responses": { - "200": { - "description": "IndicesUpgrade_WithIndex 200 response" - } - }, - "x-operation-group": "indices.upgrade", - "x-version-added": "1.0" - } - }, - "/{index}/_validate/query": { - "get": { - "description": "Allows a user to validate a potentially expensive query without executing it.", - "operationId": "IndicesValidateQuery_Get_WithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "explain", - "in": "query", - "description": "Return detailed information about the error.", - "schema": { - "type": "boolean", - "description": "Return detailed information about the error." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "rewrite", - "in": "query", - "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed.", - "schema": { - "type": "boolean", - "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed." - } - }, - { - "name": "all_shards", - "in": "query", - "description": "Execute validation on all shards instead of one random shard per index.", - "schema": { - "type": "boolean", - "description": "Execute validation on all shards instead of one random shard per index." - } - } - ], - "responses": { - "200": { - "description": "IndicesValidateQuery_Get_WithIndex 200 response" - } - }, - "x-operation-group": "indices.validate_query", - "x-version-added": "1.0" - }, - "post": { - "description": "Allows a user to validate a potentially expensive query without executing it.", - "operationId": "IndicesValidateQuery_Post_WithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IndicesValidateQuery_BodyParams" - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "schema": { - "type": "string", - "pattern": "^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$", - "description": "Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.", - "x-data-type": "array" - }, - "required": true - }, - { - "name": "explain", - "in": "query", - "description": "Return detailed information about the error.", - "schema": { - "type": "boolean", - "description": "Return detailed information about the error." - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed).", - "schema": { - "type": "boolean", - "description": "Whether specified concrete indices should be ignored when unavailable (missing or closed)." - } - }, - { - "name": "allow_no_indices", - "in": "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).", - "schema": { - "type": "boolean", - "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": "expand_wildcards", - "in": "query", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "q", - "in": "query", - "description": "Query in the Lucene query string syntax.", - "schema": { - "type": "string", - "description": "Query in the Lucene query string syntax." - } - }, - { - "name": "analyzer", - "in": "query", - "description": "The analyzer to use for the query string.", - "schema": { - "type": "string", - "description": "The analyzer to use for the query string." - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "description": "Specify whether wildcard and prefix queries should be analyzed.", - "schema": { - "type": "boolean", - "default": false, - "description": "Specify whether wildcard and prefix queries should be analyzed." - } - }, - { - "name": "default_operator", - "in": "query", - "description": "The default operator for query string query (AND or OR).", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "description": "The field to use as default where no field prefix is given in the query string.", - "schema": { - "type": "string", - "description": "The field to use as default where no field prefix is given in the query string." - } - }, - { - "name": "lenient", - "in": "query", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.", - "schema": { - "type": "boolean", - "description": "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored." - } - }, - { - "name": "rewrite", - "in": "query", - "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed.", - "schema": { - "type": "boolean", - "description": "Provide a more detailed explanation showing the actual Lucene query that will be executed." - } - }, - { - "name": "all_shards", - "in": "query", - "description": "Execute validation on all shards instead of one random shard per index.", - "schema": { - "type": "boolean", - "description": "Execute validation on all shards instead of one random shard per index." - } - } - ], - "responses": { - "200": { - "description": "IndicesValidateQuery_Post_WithIndex 200 response" - } - }, - "x-operation-group": "indices.validate_query", - "x-version-added": "1.0" - } - } - }, - "components": { - "schemas": { - "AccountDetails": { - "type": "object", - "properties": { - "user_name": { - "type": "string" - }, - "is_reserved": { - "type": "boolean" - }, - "is_hidden": { - "type": "boolean" - }, - "is_internal_user": { - "type": "boolean" - }, - "user_requested_tenant": { - "type": "string" - }, - "backend_roles": { - "type": "array", - "items": { - "type": "string" - } - }, - "custom_attribute_names": { - "type": "array", - "items": { - "type": "string" - } - }, - "tenants": { - "$ref": "#/components/schemas/UserTenants" - }, - "roles": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ActionGroupsMap": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/Action_Group" - } - }, - "ActionObjectStructure": { - "type": "object", - "properties": { - "add": { - "$ref": "#/components/schemas/UserDefinedStructure" - }, - "remove": { - "$ref": "#/components/schemas/UserDefinedStructure" - }, - "remove_index": { - "$ref": "#/components/schemas/UserDefinedStructure" - } - } - }, - "Action_Group": { - "type": "object", - "properties": { - "reserved": { - "type": "boolean" - }, - "hidden": { - "type": "boolean" - }, - "allowed_actions": { - "type": "array", - "items": { - "type": "string" - } - }, - "type": { - "type": "string" - }, - "description": { - "type": "string" - }, - "static": { - "type": "boolean" - } - } - }, - "AuditConfig": { - "type": "object", - "properties": { - "compliance": { - "$ref": "#/components/schemas/ComplianceConfig" - }, - "enabled": { - "type": "boolean" - }, - "audit": { - "$ref": "#/components/schemas/AuditLogsConfig" - } - } - }, - "AuditConfigWithReadOnly": { - "type": "object", - "properties": { - "_readonly": { - "type": "array", - "items": { - "type": "string" - } - }, - "config": { - "$ref": "#/components/schemas/AuditConfig" - } - } - }, - "AuditLogsConfig": { - "type": "object", - "properties": { - "ignore_users": { - "type": "array", - "items": { - "type": "string" - } - }, - "ignore_requests": { - "type": "array", - "items": { - "type": "string" - } - }, - "disabled_rest_categories": { - "type": "array", - "items": { - "type": "string" - } - }, - "disabled_transport_categories": { - "type": "array", - "items": { - "type": "string" - } - }, - "log_request_body": { - "type": "boolean" - }, - "resolve_indices": { - "type": "boolean" - }, - "resolve_bulk_requests": { - "type": "boolean" - }, - "exclude_sensitive_headers": { - "type": "boolean" - }, - "enable_transport": { - "type": "boolean" - }, - "enable_rest": { - "type": "boolean" - } - } - }, - "Bulk_BodyParams": { - "type": "object", - "description": "The operation definition and data (action-data pairs), separated by newlines", - "x-serialize": "bulk" - }, - "Bytes": { - "type": "string", - "description": "The unit in which to display byte values.", - "enum": [ - "b", - "k", - "kb", - "m", - "mb", - "g", - "gb", - "t", - "tb", - "p", - "pb" - ] - }, - "CatAllPitSegmentsOutputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CatPitSegmentsRecord" - } - }, - "CatPitSegmentsOutputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CatPitSegmentsRecord" - } - }, - "CatPitSegmentsRecord": { - "type": "object", - "properties": { - "index": { - "type": "string" - }, - "shard": { - "type": "string" - }, - "prirep": { - "type": "string" - }, - "ip": { - "type": "string" - }, - "segment": { - "type": "string" - }, - "generation": { - "type": "string" - }, - "docs.count": { - "type": "string" - }, - "docs.deleted": { - "type": "string" - }, - "size": { - "type": "string" - }, - "size.memory": { - "type": "string" - }, - "committed": { - "type": "string" - }, - "searchable": { - "type": "string" - }, - "version": { - "type": "string" - }, - "compound": { - "type": "string" - } - } - }, - "CatPitSegments_BodyParams": { - "type": "object", - "properties": { - "pit_id": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "pit_id" - ] - }, - "CatSegmentReplicationOutputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CatSegmentReplicationRecord" - } - }, - "CatSegmentReplicationRecord": { - "type": "object", - "properties": { - "shardId": { - "type": "string" - }, - "target_node": { - "type": "string" - }, - "target_host": { - "type": "string" - }, - "checkpoints_behind": { - "type": "string" - }, - "bytes_behind": { - "type": "string" - }, - "current_lag": { - "type": "string" - }, - "last_completed_lag": { - "type": "string" - }, - "rejected_requests": { - "type": "string" - }, - "stage": { - "type": "string" - }, - "time": { - "type": "string" - }, - "files_fetched": { - "type": "string" - }, - "files_percent": { - "type": "string" - }, - "bytes_fetched": { - "type": "string" - }, - "bytes_percent": { - "type": "string" - }, - "start_time": { - "type": "string" - }, - "stop_time": { - "type": "string" - }, - "files": { - "type": "string" - }, - "files_total": { - "type": "string" - }, - "bytes": { - "type": "string" - }, - "bytes_total": { - "type": "string" - }, - "replicating_stage_time_taken": { - "type": "string" - }, - "get_checkpoint_info_stage_time_taken": { - "type": "string" - }, - "file_diff_stage_time_taken": { - "type": "string" - }, - "get_files_stage_time_taken": { - "type": "string" - }, - "finalize_replication_stage_time_taken": { - "type": "string" - } - } - }, - "CatSegmentReplication_WithIndexOutputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CatSegmentReplicationRecord" - } - }, - "CertificatesDetail": { - "type": "object", - "properties": { - "issuer_dn": { - "type": "string" - }, - "subject_dn": { - "type": "string" - }, - "san": { - "type": "string" - }, - "not_before": { - "type": "string" - }, - "not_after": { - "type": "string" - } - } - }, - "ChangePasswordRequestContent": { - "type": "object", - "properties": { - "current_password": { - "type": "string", - "description": "The current password" - }, - "password": { - "type": "string", - "description": "The new password to set" - } - }, - "required": [ - "current_password", - "password" - ] - }, - "ChangePasswordResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "Chime": { - "type": "object", - "properties": { - "url": { - "type": "string" - } - }, - "required": [ - "url" - ] - }, - "ClearScroll_BodyParams": { - "type": "object", - "description": "Comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter" - }, - "ClusterAllocationExplain_BodyParams": { - "type": "object", - "description": "The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'" - }, - "ClusterGetSettingsResponseContent": { - "type": "object", - "properties": { - "persistent": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "transient": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "defaults": { - "$ref": "#/components/schemas/UserDefinedValueMap" - } - } - }, - "ClusterHealthLevel": { - "type": "string", - "description": "Specify the level of detail for returned information.", - "enum": [ - "cluster", - "indices", - "shards", - "awareness_attributes" - ] - }, - "ClusterPutComponentTemplate_BodyParams": { - "type": "object", - "description": "The template definition" - }, - "ClusterPutSettingsResponseContent": { - "type": "object", - "properties": { - "acknowledged": { - "type": "boolean" - }, - "persistent": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "transient": { - "$ref": "#/components/schemas/UserDefinedValueMap" - } - } - }, - "ClusterPutSettings_BodyParams": { - "type": "object", - "description": "The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart).", - "properties": { - "persistent": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "transient": { - "$ref": "#/components/schemas/UserDefinedValueMap" - } - } - }, - "ClusterRerouteMetric_Member": { - "type": "string", - "enum": [ - "_all", - "blocks", - "metadata", - "nodes", - "routing_table", - "master_node", - "cluster_manager_node", - "version" - ] - }, - "ClusterReroute_BodyParams": { - "type": "object", - "description": "The definition of `commands` to perform (`move`, `cancel`, `allocate`)" - }, - "ComplianceConfig": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean" - }, - "write_log_diffs": { - "type": "boolean" - }, - "read_watched_fields": {}, - "read_ignore_users": { - "type": "array", - "items": { - "type": "string" - } - }, - "write_watched_indices": { - "type": "array", - "items": { - "type": "string" - } - }, - "write_ignore_users": { - "type": "array", - "items": { - "type": "string" - } - }, - "read_metadata_only": { - "type": "boolean" - }, - "write_metadata_only": { - "type": "boolean" - }, - "external_config": { - "type": "boolean" - }, - "internal_config": { - "type": "boolean" - } - } - }, - "Conflicts": { - "type": "string", - "description": "What to do when the operation encounters version conflicts?.", - "enum": [ - "abort", - "proceed" - ] - }, - "Count_BodyParams": { - "type": "object", - "description": "Query to restrict the results specified with the Query DSL (optional)" - }, - "CreateActionGroupResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "CreatePitResponseContent": { - "type": "object", - "properties": { - "pit_id": { - "type": "string" - }, - "_shards": { - "$ref": "#/components/schemas/ShardStatistics" - }, - "creation_time": { - "type": "integer", - "format": "int64" - } - } - }, - "CreateRoleMappingResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "CreateRoleResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "CreateSearchPipelineResponseContent": { - "type": "object", - "properties": { - "acknowledged": { - "type": "boolean" - } - } - }, - "CreateTenantParams": { - "type": "object", - "properties": { - "description": { - "type": "string" - } - } - }, - "CreateTenantResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "CreateUserResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "Create_BodyParams": { - "type": "object", - "description": "The document" - }, - "DataStream": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "timestamp_field": { - "$ref": "#/components/schemas/DataStreamTimestampField" - }, - "indices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DataStreamIndex" - } - }, - "generation": { - "type": "integer", - "format": "int64" - }, - "status": { - "$ref": "#/components/schemas/DataStreamStatus" - }, - "template": { - "type": "string" - } - } - }, - "DataStreamIndex": { - "type": "object", - "properties": { - "index_name": { - "type": "string" - }, - "index_uuid": { - "type": "string" - } - } - }, - "DataStreamStatus": { - "type": "string", - "enum": [ - "green", - "yellow", - "red" - ] - }, - "DataStreamTimestampField": { - "type": "object", - "properties": { - "name": { - "type": "string" - } - } - }, - "DefaultOperator": { - "type": "string", - "description": "The default operator for query string query (AND or OR).", - "enum": [ - "AND", - "OR" - ] - }, - "DeleteActionGroupResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "DeleteAllPitsResponseContent": { - "type": "object", - "properties": { - "pits": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PitsDetailsDeleteAll" - } - } - } - }, - "DeleteByQuery_BodyParams": { - "type": "object", - "description": "The search definition using the Query DSL" - }, - "DeleteDistinguishedNamesResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "DeletePitResponseContent": { - "type": "object", - "properties": { - "pits": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeletedPit" - } - } - } - }, - "DeletePit_BodyParams": { - "type": "object", - "description": "The point-in-time ids to be deleted", - "properties": { - "pit_id": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "pit_id" - ] - }, - "DeleteResponseList": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/RestStatus" - } - }, - "DeleteRoleMappingResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "DeleteRoleResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "DeleteTenantResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "DeleteUserResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "DeletedPit": { - "type": "object", - "properties": { - "successful": { - "type": "boolean" - }, - "pit_id": { - "type": "string" - } - } - }, - "DeliveryStatus": { - "type": "object", - "properties": { - "status_code": { - "type": "string" - }, - "status_text": { - "type": "string" - } - } - }, - "DistinguishedNames": { - "type": "object", - "properties": { - "nodes_dn": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "DistinguishedNamesMap": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/DistinguishedNames" - } - }, - "DynamicConfig": { - "type": "object", - "properties": { - "dynamic": { - "$ref": "#/components/schemas/DynamicOptions" - } - } - }, - "DynamicOptions": { - "type": "object", - "properties": { - "filteredAliasMode": { - "type": "string" - }, - "disableRestAuth": { - "type": "boolean" - }, - "disableIntertransportAuth": { - "type": "boolean" - }, - "respectRequestIndicesOptions": { - "type": "boolean" - }, - "kibana": {}, - "http": {}, - "authc": {}, - "authz": {}, - "authFailureListeners": {}, - "doNotFailOnForbidden": { - "type": "boolean" - }, - "multiRolespanEnabled": { - "type": "boolean" - }, - "hostsResolverMode": { - "type": "string" - }, - "doNotFailOnForbiddenEmpty": { - "type": "boolean" - } - } - }, - "Email": { - "type": "object", - "properties": { - "email_account_id": { - "type": "string" - }, - "recipient_list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RecipientListItem" - } - } - }, - "required": [ - "email_account_id" - ] - }, - "EmailEncryptionMethod": { - "type": "string", - "enum": [ - "ssl", - "start_tls", - "none" - ] - }, - "EmailGroup": { - "type": "object", - "properties": { - "recipient_list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RecipientListItem" - } - }, - "email_group_id_list": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "recipient_list" - ] - }, - "EmailRecipientStatus": { - "type": "object", - "properties": { - "recipient": { - "type": "string" - }, - "delivery_status": { - "$ref": "#/components/schemas/DeliveryStatus" - } - } - }, - "EventSource": { - "type": "object", - "properties": { - "title": { - "type": "string" - }, - "reference_id": { - "type": "string" - }, - "severity": { - "$ref": "#/components/schemas/SeverityType" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "EventStatus": { - "type": "object", - "properties": { - "config_id": { - "type": "string" - }, - "config_name": { - "type": "string" - }, - "config_type": { - "$ref": "#/components/schemas/NotificationConfigType" - }, - "email_recipient_status": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EmailRecipientStatus" - } - }, - "delivery_status": { - "$ref": "#/components/schemas/DeliveryStatus" - } - } - }, - "ExpandWildcards": { - "type": "string", - "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both.", - "enum": [ - "all", - "open", - "closed", - "hidden", - "none" - ] - }, - "Explain_BodyParams": { - "type": "object", - "description": "The query definition using the Query DSL" - }, - "FieldCaps_BodyParams": { - "type": "object", - "description": "An index filter specified with the Query DSL" - }, - "FilterQueryRequestProcessor": { - "type": "object", - "properties": { - "tag": { - "type": "string" - }, - "description": { - "type": "string" - }, - "ignore_failure": { - "type": "boolean" - }, - "query": { - "$ref": "#/components/schemas/UserDefinedObjectStructure" - } - } - }, - "FlushCacheResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "GetAllPitsResponseContent": { - "type": "object", - "properties": { - "pits": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PitDetail" - } - } - } - }, - "GetCertificatesResponseContent": { - "type": "object", - "properties": { - "http_certificates_list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CertificatesDetail" - } - }, - "transport_certificates_list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CertificatesDetail" - } - } - } - }, - "GetResponseContent": { - "type": "object", - "properties": { - "_index": { - "type": "string" - }, - "_type": { - "type": "string" - }, - "_id": { - "type": "string" - }, - "version": { - "type": "integer", - "format": "int32" - }, - "seq_no": { - "type": "integer", - "format": "int64" - }, - "primary_term": { - "type": "integer", - "format": "int64" - }, - "found": { - "type": "boolean" - }, - "_routing": { - "type": "string" - }, - "_source": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "_fields": { - "$ref": "#/components/schemas/UserDefinedValueMap" - } - }, - "required": [ - "_id", - "_index", - "found" - ] - }, - "GroupBy": { - "type": "string", - "description": "Group tasks by nodes or parent/child relationships.", - "enum": [ - "nodes", - "parents", - "none" - ] - }, - "HeaderParamsMap": { - "type": "object", - "additionalProperties": { - "type": "integer", - "format": "int32" - } - }, - "Health": { - "type": "string", - "description": "Health status ('green', 'yellow', or 'red') to filter only indices matching the specified health status.", - "enum": [ - "green", - "yellow", - "red" - ] - }, - "Hits": { - "type": "object", - "properties": { - "_index": { - "type": "string" - }, - "_type": { - "type": "string" - }, - "_id": { - "type": "string" - }, - "_score": { - "type": "number", - "format": "float" - }, - "_source": {}, - "fields": {} - } - }, - "HitsMetadata": { - "type": "object", - "properties": { - "total": { - "$ref": "#/components/schemas/Total" - }, - "max_score": { - "type": "number", - "format": "double" - }, - "hits": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Hits" - } - } - } - }, - "HttpMethodType": { - "type": "string", - "enum": [ - "POST", - "PUT", - "PATCH" - ] - }, - "IndexPermission": { - "type": "object", - "properties": { - "index_patterns": { - "type": "array", - "items": { - "type": "string" - } - }, - "dls": { - "type": "string" - }, - "fls": { - "type": "array", - "items": { - "type": "string" - } - }, - "masked_fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "allowed_actions": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "Index_BodyParams": { - "type": "object", - "description": "The document" - }, - "IndicesAnalyze_BodyParams": { - "type": "object", - "description": "Define analyzer/tokenizer parameters and the text on which the analysis should be performed" - }, - "IndicesClone_BodyParams": { - "type": "object", - "description": "The configuration for the target index (`settings` and `aliases`)" - }, - "IndicesCreateDataStreamResponseContent": { - "type": "object", - "properties": { - "acknowledged": { - "type": "boolean" - } - } - }, - "IndicesCreateDataStream_BodyParams": { - "type": "object", - "description": "The data stream definition" - }, - "IndicesCreateResponseContent": { - "type": "object", - "properties": { - "index": { - "type": "string" - }, - "shards_acknowledged": { - "type": "boolean" - }, - "acknowledged": { - "type": "boolean" - } - }, - "required": [ - "acknowledged", - "index", - "shards_acknowledged" - ] - }, - "IndicesCreate_BodyParams": { - "type": "object", - "description": "The configuration for the index (`settings` and `mappings`)", - "properties": { - "aliases": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "mapping": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "settings": { - "$ref": "#/components/schemas/UserDefinedValueMap" - } - } - }, - "IndicesDeleteDataStreamResponseContent": { - "type": "object", - "properties": { - "acknowledged": { - "type": "boolean" - } - } - }, - "IndicesDeleteResponseContent": { - "type": "object", - "properties": { - "acknowledged": { - "type": "boolean" - } - } - }, - "IndicesGetDataStreamResponseContent": { - "type": "object", - "properties": { - "data_streams": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DataStream" - } - } - } - }, - "IndicesGetDataStream_WithNameResponseContent": { - "type": "object", - "properties": { - "data_streams": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DataStream" - } - } - } - }, - "IndicesPutAlias_BodyParams": { - "type": "object", - "description": "The settings for the alias, such as `routing` or `filter`" - }, - "IndicesPutIndexTemplate_BodyParams": { - "type": "object", - "description": "The template definition" - }, - "IndicesPutMapping_BodyParams": { - "type": "object", - "description": "The mapping definition" - }, - "IndicesPutMapping_PostResponseContent": { - "type": "object", - "properties": { - "acknowledged": { - "type": "boolean" - } - } - }, - "IndicesPutMapping_PutResponseContent": { - "type": "object", - "properties": { - "acknowledged": { - "type": "boolean" - } - } - }, - "IndicesPutSettings_BodyParams": { - "type": "object", - "description": "The index settings to be updated" - }, - "IndicesPutTemplate_BodyParams": { - "type": "object", - "description": "The template definition" - }, - "IndicesRollover_BodyParams": { - "type": "object", - "description": "The conditions that needs to be met for executing rollover" - }, - "IndicesShrink_BodyParams": { - "type": "object", - "description": "The configuration for the target index (`settings` and `aliases`)" - }, - "IndicesSimulateIndexTemplate_BodyParams": { - "type": "object", - "description": "New index template definition, which will be included in the simulation, as if it already exists in the system" - }, - "IndicesSimulateTemplate_BodyParams": { - "type": "object", - "description": "New index template definition to be simulated, if no index template name is specified" - }, - "IndicesSplit_BodyParams": { - "type": "object", - "description": "The configuration for the target index (`settings` and `aliases`)" - }, - "IndicesUpdateAliasesResponseContent": { - "type": "object", - "properties": { - "acknowledged": { - "type": "boolean" - } - }, - "required": [ - "acknowledged" - ] - }, - "IndicesUpdateAliases_BodyParams": { - "type": "object", - "description": "The definition of `actions` to perform", - "properties": { - "actions": { - "$ref": "#/components/schemas/ActionObjectStructure" - } - } - }, - "IndicesValidateQuery_BodyParams": { - "type": "object", - "description": "The query definition specified with the Query DSL" - }, - "IndiciesStatLevel": { - "type": "string", - "description": "Return stats aggregated at cluster, index or shard level.", - "enum": [ - "cluster", - "indices", - "shards" - ] - }, - "InfoResponseContent": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "cluster_name": { - "type": "string" - }, - "cluster_uuid": { - "type": "string" - }, - "version": { - "$ref": "#/components/schemas/InfoVersion" - }, - "tagline": { - "type": "string" - } - } - }, - "InfoVersion": { - "type": "object", - "properties": { - "distribution": { - "type": "string" - }, - "number": { - "type": "string" - }, - "build_type": { - "type": "string" - }, - "build_hash": { - "type": "string" - }, - "build_date": { - "type": "string" - }, - "build_snapshot": { - "type": "boolean" - }, - "lucene_version": { - "type": "string" - }, - "minimum_wire_compatibility_version": { - "type": "string" - }, - "minimum_index_compatibility_version": { - "type": "string" - } - } - }, - "IngestPutPipeline_BodyParams": { - "type": "object", - "description": "The ingest definition" - }, - "IngestSimulate_BodyParams": { - "type": "object", - "description": "The simulate definition" - }, - "KNNSearchModels_BodyParams": { - "type": "object" - }, - "KNNTrainModel_BodyParams": { - "type": "object", - "properties": { - "training_index": { - "type": "string" - }, - "training_field": { - "type": "string" - }, - "dimension": { - "type": "integer", - "format": "int32" - }, - "max_training_vector_count": { - "type": "integer", - "format": "int32" - }, - "search_size": { - "type": "integer", - "format": "int32" - }, - "description": { - "type": "string" - }, - "method": { - "type": "string" - } - }, - "required": [ - "dimension", - "method", - "training_field", - "training_index" - ] - }, - "Mget_BodyParams": { - "type": "object", - "description": "Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL." - }, - "MicrosoftTeamsItem": { - "type": "object", - "properties": { - "url": { - "type": "string" - } - }, - "required": [ - "url" - ] - }, - "MsearchTemplate_BodyParams": { - "type": "object", - "description": "The request definitions (metadata-search request definition pairs), separated by newlines", - "x-serialize": "bulk" - }, - "Msearch_BodyParams": { - "type": "object", - "description": "The request definitions (metadata-search request definition pairs), separated by newlines", - "x-serialize": "bulk" - }, - "Mtermvectors_BodyParams": { - "type": "object", - "description": "Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation." - }, - "NeuralFieldMap": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "NeuralQueryEnricherRequestProcessor": { - "type": "object", - "properties": { - "tag": { - "type": "string" - }, - "description": { - "type": "string" - }, - "default_model_id": { - "type": "string" - }, - "neural_field_default_id": { - "$ref": "#/components/schemas/NeuralFieldMap" - } - } - }, - "NodesReloadSecureSettings_BodyParams": { - "type": "object", - "description": "An object containing the password for the opensearch keystore" - }, - "NodesStatLevel": { - "type": "string", - "description": "Return indices stats aggregated at index, node or shard level.", - "enum": [ - "indices", - "node", - "shards" - ] - }, - "NormalizationPhaseResultsProcessor": { - "type": "object", - "properties": { - "tag": { - "type": "string" - }, - "description": { - "type": "string" - }, - "ignore_failure": { - "type": "boolean" - }, - "normalization": { - "$ref": "#/components/schemas/ScoreNormalization" - }, - "combination": { - "$ref": "#/components/schemas/ScoreCombination" - } - } - }, - "NotificationConfigType": { - "type": "string", - "description": "Type of notification configuration.", - "enum": [ - "slack", - "chime", - "microsoft_teams", - "webhook", - "email", - "sns", - "ses_account", - "smtp_account", - "email_group" - ] - }, - "NotificationsConfig": { - "type": "object", - "properties": { - "config_id": { - "type": "string" - }, - "config": { - "$ref": "#/components/schemas/NotificationsConfigItem" - } - }, - "required": [ - "config" - ] - }, - "NotificationsConfigItem": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "config_type": { - "$ref": "#/components/schemas/NotificationConfigType" - }, - "is_enabled": { - "type": "boolean" - }, - "sns": { - "$ref": "#/components/schemas/SnsItem" - }, - "slack": { - "$ref": "#/components/schemas/SlackItem" - }, - "chime": { - "$ref": "#/components/schemas/Chime" - }, - "webhook": { - "$ref": "#/components/schemas/Webhook" - }, - "smtp_account": { - "$ref": "#/components/schemas/SmtpAccount" - }, - "ses_account": { - "$ref": "#/components/schemas/SesAccount" - }, - "email_group": { - "$ref": "#/components/schemas/EmailGroup" - }, - "email": { - "$ref": "#/components/schemas/Email" - }, - "microsoft_teams": { - "$ref": "#/components/schemas/MicrosoftTeamsItem" - } - }, - "required": [ - "config_type", - "name" - ] - }, - "NotificationsConfigsItem_GetResponseContent": { - "type": "object", - "properties": { - "start_index": { - "type": "integer", - "format": "int64" - }, - "total_hits": { - "type": "integer", - "format": "int64" - }, - "total_hit_relation": { - "$ref": "#/components/schemas/TotalHitRelation" - }, - "config_list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NotificationsConfigsOutputItem" - } - } - } - }, - "NotificationsConfigsOutputItem": { - "type": "object", - "properties": { - "config_id": { - "type": "string" - }, - "last_updated_time_ms": { - "type": "integer", - "format": "int64" - }, - "created_time_ms": { - "type": "integer", - "format": "int64" - }, - "config": { - "$ref": "#/components/schemas/NotificationsConfigItem" - } - } - }, - "NotificationsConfigs_Delete_WithPathParamsResponseContent": { - "type": "object", - "properties": { - "delete_response_list": { - "$ref": "#/components/schemas/DeleteResponseList" - } - } - }, - "NotificationsConfigs_Delete_WithQueryParamsResponseContent": { - "type": "object", - "properties": { - "delete_response_list": { - "$ref": "#/components/schemas/DeleteResponseList" - } - } - }, - "NotificationsConfigs_GetRequestContent": { - "type": "object", - "properties": { - "config_id_list": { - "type": "array", - "items": { - "type": "string" - } - }, - "sort_field": { - "type": "string" - }, - "sort_order": { - "type": "string" - }, - "from_index": { - "type": "integer", - "format": "int32" - }, - "max_items": { - "type": "integer", - "format": "int32" - } - } - }, - "NotificationsConfigs_GetResponseContent": { - "type": "object", - "properties": { - "start_index": { - "type": "integer", - "format": "int64" - }, - "total_hits": { - "type": "integer", - "format": "int64" - }, - "total_hit_relation": { - "$ref": "#/components/schemas/TotalHitRelation" - }, - "config_list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NotificationsConfigsOutputItem" - } - } - } - }, - "NotificationsConfigs_PostResponseContent": { - "type": "object", - "properties": { - "config_id": { - "type": "string" - } - } - }, - "NotificationsConfigs_PutResponseContent": { - "type": "object", - "properties": { - "config_id": { - "type": "string" - } - } - }, - "NotificationsFeatureTest_GetResponseContent": { - "type": "object", - "properties": { - "event_source": { - "$ref": "#/components/schemas/EventSource" - }, - "status_list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EventStatus" - } - } - } - }, - "NotificationsFeatureTest_PostResponseContent": { - "type": "object", - "properties": { - "event_source": { - "$ref": "#/components/schemas/EventSource" - }, - "status_list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EventStatus" - } - } - } - }, - "NotificationsFeatures_GetResponseContent": { - "type": "object", - "properties": { - "allowed_config_type_list": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NotificationConfigType" - } - }, - "plugin_features": { - "$ref": "#/components/schemas/NotificationsPluginFeaturesMap" - } - } - }, - "NotificationsPluginFeaturesMap": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "OpType": { - "type": "string", - "description": "Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create` for requests without an explicit document ID.", - "enum": [ - "index", - "create" - ] - }, - "OversampleRequestProcessor": { - "type": "object", - "properties": { - "tag": { - "type": "string" - }, - "description": { - "type": "string" - }, - "ignore_failure": { - "type": "boolean" - }, - "sample_factor": { - "type": "number", - "format": "float" - }, - "content_prefix": { - "type": "string" - } - }, - "required": [ - "sample_factor" - ] - }, - "PatchActionGroupInputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PatchOperation" - } - }, - "PatchActionGroupResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "PatchActionGroupsInputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PatchOperation" - } - }, - "PatchActionGroupsResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "PatchAuditConfigurationInputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PatchOperation" - } - }, - "PatchConfigurationInputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PatchOperation" - } - }, - "PatchConfigurationResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "PatchDistinguishedNamesInputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PatchOperation" - } - }, - "PatchDistinguishedNamesResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "PatchOperation": { - "type": "object", - "properties": { - "op": { - "type": "string", - "description": "The operation to perform. Possible values: remove,add, replace, move, copy, test." - }, - "path": { - "type": "string", - "description": "The path to the resource." - }, - "value": { - "description": "The new values used for the update." - } - }, - "required": [ - "op", - "path" - ] - }, - "PatchRoleInputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PatchOperation" - } - }, - "PatchRoleMappingInputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PatchOperation" - } - }, - "PatchRoleMappingResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "PatchRoleMappingsInputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PatchOperation" - } - }, - "PatchRoleMappingsResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "PatchRoleResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "PatchRolesInputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PatchOperation" - } - }, - "PatchRolesResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "PatchTenantInputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PatchOperation" - } - }, - "PatchTenantResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "PatchTenantsInputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PatchOperation" - } - }, - "PatchTenantsResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "PatchUserInputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PatchOperation" - } - }, - "PatchUserResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "PatchUsersInputPayload": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PatchOperation" - } - }, - "PatchUsersResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "PhaseResultsProcessor": { - "oneOf": [ - { - "type": "object", - "title": "normalization-processor", - "properties": { - "normalization-processor": { - "$ref": "#/components/schemas/NormalizationPhaseResultsProcessor" - } - }, - "required": [ - "normalization-processor" - ] - } - ] - }, - "PitDetail": { - "type": "object", - "properties": { - "pit_id": { - "type": "string" - }, - "creation_time": { - "type": "integer", - "format": "int64" - }, - "keep_alive": { - "type": "integer", - "format": "int64" - } - } - }, - "PitsDetailsDeleteAll": { - "type": "object", - "properties": { - "successful": { - "type": "boolean" - }, - "pit_id": { - "type": "string" - } - } - }, - "PutScript_BodyParams": { - "type": "object", - "description": "The document" - }, - "RankEval_BodyParams": { - "type": "object", - "description": "The ranking evaluation search definition, including search requests, document ratings and ranking metric definition." - }, - "RecipientListItem": { - "type": "object", - "properties": { - "recipient": { - "type": "string" - } - } - }, - "RefreshEnum": { - "type": "string", - "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.", - "enum": [ - "true", - "false", - "wait_for" - ] - }, - "Reindex_BodyParams": { - "type": "object", - "description": "The search definition using the Query DSL and the prototype for the index request." - }, - "Relation": { - "type": "string", - "enum": [ - "eq", - "gte" - ] - }, - "ReloadHttpCertificatesResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "ReloadTransportCertificatesResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "RemoteStoreRestoreInfo": { - "type": "object", - "properties": { - "snapshot": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "string" - } - }, - "shards": { - "$ref": "#/components/schemas/RemoteStoreRestoreShardsInfo" - } - } - }, - "RemoteStoreRestoreResponseContent": { - "type": "object", - "properties": { - "accepted": { - "type": "boolean" - }, - "remote_store": { - "$ref": "#/components/schemas/RemoteStoreRestoreInfo" - } - } - }, - "RemoteStoreRestoreShardsInfo": { - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int32" - }, - "failed": { - "type": "integer", - "format": "int32" - }, - "successful": { - "type": "integer", - "format": "int32" - } - } - }, - "RemoteStoreRestore_BodyParams": { - "type": "object", - "description": "Comma-separated list of index IDs", - "properties": { - "indices": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "indices" - ] - }, - "RenderSearchTemplate_BodyParams": { - "type": "object", - "description": "The search definition template and its params" - }, - "RequestProcessor": { - "oneOf": [ - { - "type": "object", - "title": "filter_query", - "properties": { - "filter_query": { - "$ref": "#/components/schemas/FilterQueryRequestProcessor" - } - }, - "required": [ - "filter_query" - ] - }, - { - "type": "object", - "title": "neural_query_enricher", - "properties": { - "neural_query_enricher": { - "$ref": "#/components/schemas/NeuralQueryEnricherRequestProcessor" - } - }, - "required": [ - "neural_query_enricher" - ] - }, - { - "type": "object", - "title": "script", - "properties": { - "script": { - "$ref": "#/components/schemas/SearchScriptRequestProcessor" - } - }, - "required": [ - "script" - ] - }, - { - "type": "object", - "title": "oversample", - "properties": { - "oversample": { - "$ref": "#/components/schemas/OversampleRequestProcessor" - } - }, - "required": [ - "oversample" - ] - } - ] - }, - "RestStatus": { - "type": "string", - "enum": [ - "continue", - "switching_protocols", - "ok", - "created", - "accepted", - "non_authoritative_information", - "no_content", - "reset_content", - "partial_content", - "multi_status", - "multiple_choices", - "moved_permanently", - "found", - "see_other", - "not_modified", - "use_proxy", - "temporary_redirect" - ] - }, - "Role": { - "type": "object", - "properties": { - "reserved": { - "type": "boolean" - }, - "hidden": { - "type": "boolean" - }, - "description": { - "type": "string" - }, - "cluster_permissions": { - "type": "array", - "items": { - "type": "string" - } - }, - "index_permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IndexPermission" - } - }, - "tenant_permissions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TenantPermission" - } - }, - "static": { - "type": "boolean" - } - } - }, - "RoleMapping": { - "type": "object", - "properties": { - "hosts": { - "type": "array", - "items": { - "type": "string" - } - }, - "users": { - "type": "array", - "items": { - "type": "string" - } - }, - "reserved": { - "type": "boolean" - }, - "hidden": { - "type": "boolean" - }, - "backend_roles": { - "type": "array", - "items": { - "type": "string" - } - }, - "and_backend_roles": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "type": "string" - } - } - }, - "RoleMappings": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/RoleMapping" - } - }, - "RolesMap": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/Role" - } - }, - "SampleType": { - "type": "string", - "description": "The type to sample.", - "enum": [ - "cpu", - "wait", - "block" - ] - }, - "ScoreCombination": { - "type": "object", - "properties": { - "technique": { - "$ref": "#/components/schemas/ScoreCombinationTechnique" - }, - "parameters": { - "type": "array", - "items": { - "type": "number", - "format": "float" - } - } - } - }, - "ScoreCombinationTechnique": { - "type": "string", - "enum": [ - "arithmetic_mean", - "geometric_mean", - "harmonic_mean" - ] - }, - "ScoreNormalization": { - "type": "object", - "properties": { - "technique": { - "$ref": "#/components/schemas/ScoreNormalizationTechnique" - } - } - }, - "ScoreNormalizationTechnique": { - "type": "string", - "enum": [ - "min_max", - "l2" - ] - }, - "ScriptsPainlessExecute_BodyParams": { - "type": "object", - "description": "The script to execute" - }, - "Scroll_BodyParams": { - "type": "object", - "description": "The scroll ID if not passed by URL or query parameter." - }, - "SearchPipelineMap": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/SearchPipelineStructure" - } - }, - "SearchPipelineStructure": { - "type": "object", - "properties": { - "version": { - "type": "integer", - "format": "int32" - }, - "request_processors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RequestProcessor" - } - }, - "response_processors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RequestProcessor" - } - }, - "phase_results_processors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PhaseResultsProcessor" - } - } - } - }, - "SearchScriptRequestProcessor": { - "type": "object", - "properties": { - "tag": { - "type": "string" - }, - "description": { - "type": "string" - }, - "ignore_failure": { - "type": "boolean" - }, - "source": { - "type": "string" - }, - "lang": { - "type": "string" - } - }, - "required": [ - "source" - ] - }, - "SearchTemplate_BodyParams": { - "type": "object", - "description": "The search definition template and its params" - }, - "SearchType": { - "type": "string", - "description": "Search operation type.", - "enum": [ - "query_then_fetch", - "dfs_query_then_fetch" - ] - }, - "SearchTypeMulti": { - "type": "string", - "description": "Search operation type.", - "enum": [ - "query_then_fetch", - "query_and_fetch", - "dfs_query_then_fetch", - "dfs_query_and_fetch" - ] - }, - "Search_BodyParams": { - "type": "object", - "description": "The search definition using the Query DSL", - "properties": { - "docvalue_fields": { - "type": "string" - }, - "explain": { - "type": "boolean" - }, - "from": { - "type": "integer", - "format": "int32" - }, - "seq_no_primary_term": { - "type": "boolean" - }, - "size": { - "type": "integer", - "format": "int32" - }, - "source": { - "type": "string" - }, - "stats": { - "type": "string" - }, - "terminate_after": { - "type": "integer", - "format": "int32" - }, - "timeout": { - "$ref": "#/components/schemas/Time" - }, - "version": { - "type": "boolean" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "min_score": { - "type": "integer", - "format": "int32" - }, - "indices_boost": { - "type": "array", - "items": {} - }, - "query": { - "$ref": "#/components/schemas/UserDefinedObjectStructure" - } - } - }, - "Search_GetResponseContent": { - "type": "object", - "properties": { - "_scroll_id": { - "type": "string" - }, - "took": { - "type": "integer", - "format": "int64" - }, - "timed_out": { - "type": "boolean" - }, - "_shards": { - "$ref": "#/components/schemas/ShardStatistics" - }, - "hits": { - "$ref": "#/components/schemas/HitsMetadata" - } - } - }, - "Search_Get_WithIndexResponseContent": { - "type": "object", - "properties": { - "_scroll_id": { - "type": "string" - }, - "took": { - "type": "integer", - "format": "int64" - }, - "timed_out": { - "type": "boolean" - }, - "_shards": { - "$ref": "#/components/schemas/ShardStatistics" - }, - "hits": { - "$ref": "#/components/schemas/HitsMetadata" - } - } - }, - "Search_PostResponseContent": { - "type": "object", - "properties": { - "_scroll_id": { - "type": "string" - }, - "took": { - "type": "integer", - "format": "int64" - }, - "timed_out": { - "type": "boolean" - }, - "_shards": { - "$ref": "#/components/schemas/ShardStatistics" - }, - "hits": { - "$ref": "#/components/schemas/HitsMetadata" - } - } - }, - "Search_Post_WithIndexResponseContent": { - "type": "object", - "properties": { - "_scroll_id": { - "type": "string" - }, - "took": { - "type": "integer", - "format": "int64" - }, - "timed_out": { - "type": "boolean" - }, - "_shards": { - "$ref": "#/components/schemas/ShardStatistics" - }, - "hits": { - "$ref": "#/components/schemas/HitsMetadata" - } - } - }, - "SecurityHealthResponseContent": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "mode": { - "type": "string" - }, - "status": { - "type": "string" - } - } - }, - "SesAccount": { - "type": "object", - "properties": { - "region": { - "type": "string" - }, - "role_arn": { - "type": "string" - }, - "from_addess": { - "type": "string" - } - }, - "required": [ - "from_addess", - "region" - ] - }, - "SeverityType": { - "type": "string", - "enum": [ - "high", - "info", - "critical" - ] - }, - "ShardStatistics": { - "type": "object", - "properties": { - "total": { - "type": "integer", - "format": "int32" - }, - "successful": { - "type": "integer", - "format": "int32" - }, - "skipped": { - "type": "integer", - "format": "int32" - }, - "failed": { - "type": "integer", - "format": "int32" - } - } - }, - "SlackItem": { - "type": "object", - "properties": { - "url": { - "type": "string" - } - }, - "required": [ - "url" - ] - }, - "SmtpAccount": { - "type": "object", - "properties": { - "host": { - "type": "string" - }, - "port": { - "type": "integer", - "format": "int32" - }, - "method": { - "$ref": "#/components/schemas/EmailEncryptionMethod" - }, - "from_addess": { - "type": "string" - } - }, - "required": [ - "from_addess", - "host", - "method", - "port" - ] - }, - "SnapshotClone_BodyParams": { - "type": "object", - "description": "The snapshot clone definition" - }, - "SnapshotCreateRepository_BodyParams": { - "type": "object", - "description": "The repository definition" - }, - "SnapshotCreate_BodyParams": { - "type": "object", - "description": "The snapshot definition" - }, - "SnapshotRestore_BodyParams": { - "type": "object", - "description": "Details of what to restore" - }, - "SnsItem": { - "type": "object", - "properties": { - "topic_arn": { - "type": "string" - }, - "role_arn": { - "type": "string" - } - }, - "required": [ - "topic_arn" - ] - }, - "Status_Member": { - "type": "string", - "enum": [ - "green", - "yellow", - "red", - "all" - ] - }, - "SuggestMode": { - "type": "string", - "description": "Specify suggest mode.", - "enum": [ - "missing", - "popular", - "always" - ] - }, - "Tenant": { - "type": "object", - "properties": { - "reserved": { - "type": "boolean" - }, - "hidden": { - "type": "boolean" - }, - "description": { - "type": "string" - }, - "static": { - "type": "boolean" - } - } - }, - "TenantPermission": { - "type": "object", - "properties": { - "tenant_patterns": { - "type": "array", - "items": { - "type": "string" - } - }, - "allowed_actions": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "TenantsMap": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/Tenant" - } - }, - "Termvectors_BodyParams": { - "type": "object", - "description": "Define parameters and or supply a document to get termvectors for. See documentation." - }, - "Time": { - "type": "string", - "description": "The unit in which to display time values.", - "enum": [ - "d", - "h", - "m", - "s", - "ms", - "micros", - "nanos" - ] - }, - "Total": { - "type": "object", - "properties": { - "value": { - "type": "integer", - "format": "int32" - }, - "relation": { - "$ref": "#/components/schemas/Relation" - } - } - }, - "TotalHitRelation": { - "type": "string", - "enum": [ - "eq", - "gte" - ] - }, - "UpdateAuditConfigurationResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "UpdateByQuery_BodyParams": { - "type": "object", - "description": "The search definition using the Query DSL" - }, - "UpdateConfigurationResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "UpdateDistinguishedNamesResponseContent": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Security Operation Status" - }, - "message": { - "type": "string", - "description": "Security Operation Message" - } - } - }, - "Update_BodyParams": { - "type": "object", - "description": "The request definition requires either `script` or partial `doc`" - }, - "User": { - "type": "object", - "properties": { - "hash": { - "type": "string" - }, - "reserved": { - "type": "boolean" - }, - "hidden": { - "type": "boolean" - }, - "backend_roles": { - "type": "array", - "items": { - "type": "string" - } - }, - "attributes": { - "$ref": "#/components/schemas/UserAttributes" - }, - "description": { - "type": "string" - }, - "opendistro_security_roles": { - "type": "array", - "items": { - "type": "string" - } - }, - "static": { - "type": "boolean" - } - } - }, - "UserAttributes": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "UserDefinedObjectStructure": { - "type": "object", - "properties": { - "bool": {}, - "boosting": {}, - "combined_fields": {}, - "constant_score": {}, - "dis_max": {}, - "distance_feature": {}, - "exists": {}, - "function_score": {}, - "fuzzy": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "geo_bounding_box": {}, - "geo_distance": {}, - "geo_polygon": {}, - "geo_shape": {}, - "has_child": {}, - "has_parent": {}, - "ids": {}, - "intervals": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "knn": {}, - "match": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "match_all": {}, - "match_bool_prefix": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "match_none": {}, - "match_phrase": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "match_phrase_prefix": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "more_like_this": {}, - "multi_match": {}, - "nested": {}, - "parent_id": {}, - "percolate": {}, - "pinned": {}, - "prefix": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "query_string": {}, - "range": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "rank_feature": {}, - "regexp": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "script": {}, - "script_score": {}, - "shape": {}, - "simple_query_string": {}, - "span_containing": {}, - "field_masking_span": {}, - "span_first": {}, - "span_multi": {}, - "span_near": {}, - "span_not": {}, - "span_or": {}, - "span_term": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "span_within": {}, - "term": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "terms": {}, - "terms_set": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "wildcard": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "wrapper": {} - } - }, - "UserDefinedStructure": { - "type": "object", - "properties": { - "alias": { - "type": "string" - }, - "aliases": { - "type": "array", - "items": { - "type": "string" - } - }, - "filter": {}, - "index": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "string" - } - }, - "index_routing": { - "type": "string" - }, - "is_hidden": { - "type": "boolean" - }, - "is_write_index": { - "type": "boolean" - }, - "must_exist": { - "type": "string" - }, - "routing": { - "type": "string" - }, - "search_routing": { - "type": "string" - } - } - }, - "UserDefinedValueMap": { - "type": "object", - "additionalProperties": {} - }, - "UserTenants": { - "type": "object", - "properties": { - "global_tenant": { - "type": "boolean" - }, - "admin_tenant": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - } - }, - "UsersMap": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/User" - } - }, - "VersionType": { - "type": "string", - "description": "Specific version type.", - "enum": [ - "internal", - "external", - "external_gte", - "force" - ] - }, - "WaitForEvents": { - "type": "string", - "description": "Wait until all currently queued events with the given priority are processed.", - "enum": [ - "immediate", - "urgent", - "high", - "normal", - "low", - "languid" - ] - }, - "WaitForStatus": { - "type": "string", - "description": "Wait until cluster is in a specific state.", - "enum": [ - "green", - "yellow", - "red" - ] - }, - "Webhook": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "method": { - "$ref": "#/components/schemas/HttpMethodType" - }, - "header_params": { - "$ref": "#/components/schemas/HeaderParamsMap" - } - }, - "required": [ - "url" - ] - } - }, - "securitySchemes": { - "smithy.api.httpBasicAuth": { - "type": "http", - "description": "HTTP Basic authentication", - "scheme": "Basic" - } - } - }, - "security": [ - { - "smithy.api.httpBasicAuth": [] - } - ] -} diff --git a/PUBLISHING_SPECS.md b/PUBLISHING_SPECS.md index 153ce4bf..dad62006 100644 --- a/PUBLISHING_SPECS.md +++ b/PUBLISHING_SPECS.md @@ -2,5 +2,5 @@ ## Publishing OpenSearch API Specs -* The [build-openapi-specs](.github/workflows/build-openapi-specs.yml) workflow raises a PR for the changes to the [OpenAPI specs](OpenSearch.openapi.json) whenever a change is made to the Smithy models. +* The [build-single-file-specs](.github/workflows/build-single-file-specs.yml) workflow raises a PR for the changes to the [./build/OpenSearch.latest.yaml](builds/OpenSearch.latest.yaml) whenever a change is made to the [spec folder](./spec). * The updated OpenAPI specs are hosted on GitHub pages at https://opensearch-project.github.io/opensearch-api-specification/. diff --git a/README.md b/README.md index ef2f8222..fbc654b9 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ ## Welcome! `opensearch-api-specification` is an open source, community-driven collection of API model specifications for -[OpenSearch](https://github.com/opensearch-project/OpenSearch) APIs. The API models are created using the [Smithy](https://awslabs.github.io/smithy/) Interface Definition Language (IDL). Smithy is an open source IDL which is protocol agnostic, extensible and supports code generation. +[OpenSearch](https://github.com/opensearch-project/OpenSearch) APIs. The API models are written in OpenAPI format and are used to generate client libraries and documentation. To contribute to this project or to track the developments head over to [Projects](https://github.com/opensearch-project/opensearch-api-specification/projects) board. Follow the [Developer guide](DEVELOPER_GUIDE.md) and [Contributing guidelines](CONTRIBUTING.md) for instructions diff --git a/build.gradle.kts b/build.gradle.kts deleted file mode 100644 index 39f83f66..00000000 --- a/build.gradle.kts +++ /dev/null @@ -1,42 +0,0 @@ -/* - * SPDX-License-Identifier: Apache-2.0 - * - * The OpenSearch Contributors require contributions made to - * this file be licensed under the Apache-2.0 license or a - * compatible open source license. - */ - -plugins { - id("software.amazon.smithy").version("0.7.0") - id("com.diffplug.spotless").version("6.11.0") -} - -repositories { - mavenCentral() -} - -buildscript { - dependencies { - classpath("software.amazon.smithy:smithy-openapi:$smithyVersion") - classpath("software.amazon.smithy:smithy-openapi-traits:$smithyVersion") - classpath("software.amazon.smithy:smithy-aws-traits:$smithyVersion") - classpath("software.amazon.smithy:smithy-cli:$smithyVersion") - } -} - -dependencies { - implementation("software.amazon.smithy:smithy-model:$smithyVersion") - implementation("software.amazon.smithy:smithy-linters:$smithyVersion") - implementation("software.amazon.smithy:smithy-aws-traits:$smithyVersion") - implementation("software.amazon.smithy:smithy-openapi-traits:$smithyVersion") -} - -spotless { - kotlinGradle { - target("**/*.kts", "*.md", "**/*.smithy", ".gitignore") - - indentWithSpaces() - endWithNewline() - trimTrailingWhitespace() - } -} diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts deleted file mode 100644 index 7c756884..00000000 --- a/buildSrc/build.gradle.kts +++ /dev/null @@ -1,8 +0,0 @@ -repositories { - mavenCentral() -} - -plugins { - `kotlin-dsl` - id("com.diffplug.spotless").version("6.11.0") -} diff --git a/buildSrc/src/main/kotlin/versions.kt b/buildSrc/src/main/kotlin/versions.kt deleted file mode 100644 index 23d76284..00000000 --- a/buildSrc/src/main/kotlin/versions.kt +++ /dev/null @@ -1 +0,0 @@ -const val smithyVersion = "1.37.0" diff --git a/builds/OpenSearch.latest.yaml b/builds/OpenSearch.latest.yaml new file mode 100644 index 00000000..b1be75f7 --- /dev/null +++ b/builds/OpenSearch.latest.yaml @@ -0,0 +1,41374 @@ +openapi: 3.1.0 +info: + title: OpenSearch API + description: OpenSearch API + version: 1.0.0 +paths: + /: + get: + operationId: info.0 + x-operation-group: info + x-version-added: '1.0' + description: Returns basic information about the cluster. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: [] + responses: + '200': + $ref: '#/components/responses/info@200' + head: + operationId: ping.0 + x-operation-group: ping + x-version-added: '1.0' + description: Returns whether the cluster is running. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: [] + responses: + '200': + $ref: '#/components/responses/ping@200' + /_alias: + get: + operationId: indices.get_alias.0 + x-operation-group: indices.get_alias + x-version-added: '1.0' + description: Returns an alias. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-alias/ + parameters: + - $ref: '#/components/parameters/indices.get_alias::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_alias::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_alias::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_alias::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_alias@200' + /_alias/{name}: + get: + operationId: indices.get_alias.1 + x-operation-group: indices.get_alias + x-version-added: '1.0' + description: Returns an alias. + parameters: + - $ref: '#/components/parameters/indices.get_alias::path.name' + - $ref: '#/components/parameters/indices.get_alias::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_alias::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_alias::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_alias::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_alias@200' + head: + operationId: indices.exists_alias.0 + x-operation-group: indices.exists_alias + x-version-added: '1.0' + description: Returns information about whether a particular alias exists. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.exists_alias::path.name' + - $ref: '#/components/parameters/indices.exists_alias::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.exists_alias::query.allow_no_indices' + - $ref: '#/components/parameters/indices.exists_alias::query.expand_wildcards' + - $ref: '#/components/parameters/indices.exists_alias::query.local' + responses: + '200': + $ref: '#/components/responses/indices.exists_alias@200' + /_aliases: + post: + operationId: indices.update_aliases.0 + x-operation-group: indices.update_aliases + x-version-added: '1.0' + description: Updates index aliases. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/alias/ + parameters: + - $ref: '#/components/parameters/indices.update_aliases::query.timeout' + - $ref: '#/components/parameters/indices.update_aliases::query.master_timeout' + - $ref: '#/components/parameters/indices.update_aliases::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.update_aliases' + responses: + '200': + $ref: '#/components/responses/indices.update_aliases@200' + /_analyze: + get: + operationId: indices.analyze.0 + x-operation-group: indices.analyze + x-version-added: '1.0' + description: Performs the analysis process on a text and return the tokens breakdown of the text. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/ + parameters: + - $ref: '#/components/parameters/indices.analyze::query.index' + requestBody: + $ref: '#/components/requestBodies/indices.analyze' + responses: + '200': + $ref: '#/components/responses/indices.analyze@200' + post: + operationId: indices.analyze.1 + x-operation-group: indices.analyze + x-version-added: '1.0' + description: Performs the analysis process on a text and return the tokens breakdown of the text. + parameters: + - $ref: '#/components/parameters/indices.analyze::query.index' + requestBody: + $ref: '#/components/requestBodies/indices.analyze' + responses: + '200': + $ref: '#/components/responses/indices.analyze@200' + /_bulk: + post: + operationId: bulk.0 + x-operation-group: bulk + x-version-added: '1.0' + description: Allows to perform multiple index/update/delete operations in a single request. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ + parameters: + - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' + - $ref: '#/components/parameters/bulk::query.refresh' + - $ref: '#/components/parameters/bulk::query.routing' + - $ref: '#/components/parameters/bulk::query.timeout' + - $ref: '#/components/parameters/bulk::query.type' + - $ref: '#/components/parameters/bulk::query._source' + - $ref: '#/components/parameters/bulk::query._source_excludes' + - $ref: '#/components/parameters/bulk::query._source_includes' + - $ref: '#/components/parameters/bulk::query.pipeline' + - $ref: '#/components/parameters/bulk::query.require_alias' + requestBody: + $ref: '#/components/requestBodies/bulk' + responses: + '200': + $ref: '#/components/responses/bulk@200' + put: + operationId: bulk.1 + x-operation-group: bulk + x-version-added: '1.0' + description: Allows to perform multiple index/update/delete operations in a single request. + parameters: + - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' + - $ref: '#/components/parameters/bulk::query.refresh' + - $ref: '#/components/parameters/bulk::query.routing' + - $ref: '#/components/parameters/bulk::query.timeout' + - $ref: '#/components/parameters/bulk::query.type' + - $ref: '#/components/parameters/bulk::query._source' + - $ref: '#/components/parameters/bulk::query._source_excludes' + - $ref: '#/components/parameters/bulk::query._source_includes' + - $ref: '#/components/parameters/bulk::query.pipeline' + - $ref: '#/components/parameters/bulk::query.require_alias' + requestBody: + $ref: '#/components/requestBodies/bulk' + responses: + '200': + $ref: '#/components/responses/bulk@200' + /_cache/clear: + post: + operationId: indices.clear_cache.0 + x-operation-group: indices.clear_cache + x-version-added: '1.0' + description: Clears all or specific caches for one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/ + parameters: + - $ref: '#/components/parameters/indices.clear_cache::query.fielddata' + - $ref: '#/components/parameters/indices.clear_cache::query.fields' + - $ref: '#/components/parameters/indices.clear_cache::query.query' + - $ref: '#/components/parameters/indices.clear_cache::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.clear_cache::query.allow_no_indices' + - $ref: '#/components/parameters/indices.clear_cache::query.expand_wildcards' + - $ref: '#/components/parameters/indices.clear_cache::query.index' + - $ref: '#/components/parameters/indices.clear_cache::query.request' + responses: + '200': + $ref: '#/components/responses/indices.clear_cache@200' + /_cat: + get: + operationId: cat.help.0 + x-operation-group: cat.help + x-version-added: '1.0' + description: Returns help for the Cat APIs. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/index/ + parameters: + - $ref: '#/components/parameters/cat.help::query.help' + - $ref: '#/components/parameters/cat.help::query.s' + responses: + '200': + $ref: '#/components/responses/cat.help@200' + /_cat/aliases: + get: + operationId: cat.aliases.0 + x-operation-group: cat.aliases + x-version-added: '1.0' + description: Shows information about currently configured aliases to indices including filter and routing infos. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/ + parameters: + - $ref: '#/components/parameters/cat.aliases::query.format' + - $ref: '#/components/parameters/cat.aliases::query.local' + - $ref: '#/components/parameters/cat.aliases::query.h' + - $ref: '#/components/parameters/cat.aliases::query.help' + - $ref: '#/components/parameters/cat.aliases::query.s' + - $ref: '#/components/parameters/cat.aliases::query.v' + - $ref: '#/components/parameters/cat.aliases::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/cat.aliases@200' + /_cat/aliases/{name}: + get: + operationId: cat.aliases.1 + x-operation-group: cat.aliases + x-version-added: '1.0' + description: Shows information about currently configured aliases to indices including filter and routing infos. + parameters: + - $ref: '#/components/parameters/cat.aliases::path.name' + - $ref: '#/components/parameters/cat.aliases::query.format' + - $ref: '#/components/parameters/cat.aliases::query.local' + - $ref: '#/components/parameters/cat.aliases::query.h' + - $ref: '#/components/parameters/cat.aliases::query.help' + - $ref: '#/components/parameters/cat.aliases::query.s' + - $ref: '#/components/parameters/cat.aliases::query.v' + - $ref: '#/components/parameters/cat.aliases::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/cat.aliases@200' + /_cat/allocation: + get: + operationId: cat.allocation.0 + x-operation-group: cat.allocation + x-version-added: '1.0' + description: Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/ + parameters: + - $ref: '#/components/parameters/cat.allocation::query.format' + - $ref: '#/components/parameters/cat.allocation::query.bytes' + - $ref: '#/components/parameters/cat.allocation::query.local' + - $ref: '#/components/parameters/cat.allocation::query.master_timeout' + - $ref: '#/components/parameters/cat.allocation::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.allocation::query.h' + - $ref: '#/components/parameters/cat.allocation::query.help' + - $ref: '#/components/parameters/cat.allocation::query.s' + - $ref: '#/components/parameters/cat.allocation::query.v' + responses: + '200': + $ref: '#/components/responses/cat.allocation@200' + /_cat/allocation/{node_id}: + get: + operationId: cat.allocation.1 + x-operation-group: cat.allocation + x-version-added: '1.0' + description: Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. + parameters: + - $ref: '#/components/parameters/cat.allocation::path.node_id' + - $ref: '#/components/parameters/cat.allocation::query.format' + - $ref: '#/components/parameters/cat.allocation::query.bytes' + - $ref: '#/components/parameters/cat.allocation::query.local' + - $ref: '#/components/parameters/cat.allocation::query.master_timeout' + - $ref: '#/components/parameters/cat.allocation::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.allocation::query.h' + - $ref: '#/components/parameters/cat.allocation::query.help' + - $ref: '#/components/parameters/cat.allocation::query.s' + - $ref: '#/components/parameters/cat.allocation::query.v' + responses: + '200': + $ref: '#/components/responses/cat.allocation@200' + /_cat/cluster_manager: + get: + operationId: cat.cluster_manager.0 + x-operation-group: cat.cluster_manager + x-version-added: '2.0' + description: Returns information about the cluster-manager node. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ + parameters: + - $ref: '#/components/parameters/cat.cluster_manager::query.format' + - $ref: '#/components/parameters/cat.cluster_manager::query.local' + - $ref: '#/components/parameters/cat.cluster_manager::query.master_timeout' + - $ref: '#/components/parameters/cat.cluster_manager::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.cluster_manager::query.h' + - $ref: '#/components/parameters/cat.cluster_manager::query.help' + - $ref: '#/components/parameters/cat.cluster_manager::query.s' + - $ref: '#/components/parameters/cat.cluster_manager::query.v' + responses: + '200': + $ref: '#/components/responses/cat.cluster_manager@200' + /_cat/count: + get: + operationId: cat.count.0 + x-operation-group: cat.count + x-version-added: '1.0' + description: Provides quick access to the document count of the entire cluster, or individual indices. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-count/ + parameters: + - $ref: '#/components/parameters/cat.count::query.format' + - $ref: '#/components/parameters/cat.count::query.h' + - $ref: '#/components/parameters/cat.count::query.help' + - $ref: '#/components/parameters/cat.count::query.s' + - $ref: '#/components/parameters/cat.count::query.v' + responses: + '200': + $ref: '#/components/responses/cat.count@200' + /_cat/count/{index}: + get: + operationId: cat.count.1 + x-operation-group: cat.count + x-version-added: '1.0' + description: Provides quick access to the document count of the entire cluster, or individual indices. + parameters: + - $ref: '#/components/parameters/cat.count::path.index' + - $ref: '#/components/parameters/cat.count::query.format' + - $ref: '#/components/parameters/cat.count::query.h' + - $ref: '#/components/parameters/cat.count::query.help' + - $ref: '#/components/parameters/cat.count::query.s' + - $ref: '#/components/parameters/cat.count::query.v' + responses: + '200': + $ref: '#/components/responses/cat.count@200' + /_cat/fielddata: + get: + operationId: cat.fielddata.0 + x-operation-group: cat.fielddata + x-version-added: '1.0' + description: Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/ + parameters: + - $ref: '#/components/parameters/cat.fielddata::query.format' + - $ref: '#/components/parameters/cat.fielddata::query.bytes' + - $ref: '#/components/parameters/cat.fielddata::query.h' + - $ref: '#/components/parameters/cat.fielddata::query.help' + - $ref: '#/components/parameters/cat.fielddata::query.s' + - $ref: '#/components/parameters/cat.fielddata::query.v' + - $ref: '#/components/parameters/cat.fielddata::query.fields' + responses: + '200': + $ref: '#/components/responses/cat.fielddata@200' + /_cat/fielddata/{fields}: + get: + operationId: cat.fielddata.1 + x-operation-group: cat.fielddata + x-version-added: '1.0' + description: Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + parameters: + - $ref: '#/components/parameters/cat.fielddata::path.fields' + - $ref: '#/components/parameters/cat.fielddata::query.format' + - $ref: '#/components/parameters/cat.fielddata::query.bytes' + - $ref: '#/components/parameters/cat.fielddata::query.h' + - $ref: '#/components/parameters/cat.fielddata::query.help' + - $ref: '#/components/parameters/cat.fielddata::query.s' + - $ref: '#/components/parameters/cat.fielddata::query.v' + - $ref: '#/components/parameters/cat.fielddata::query.fields' + responses: + '200': + $ref: '#/components/responses/cat.fielddata@200' + /_cat/health: + get: + operationId: cat.health.0 + x-operation-group: cat.health + x-version-added: '1.0' + description: Returns a concise representation of the cluster health. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-health/ + parameters: + - $ref: '#/components/parameters/cat.health::query.format' + - $ref: '#/components/parameters/cat.health::query.h' + - $ref: '#/components/parameters/cat.health::query.help' + - $ref: '#/components/parameters/cat.health::query.s' + - $ref: '#/components/parameters/cat.health::query.time' + - $ref: '#/components/parameters/cat.health::query.ts' + - $ref: '#/components/parameters/cat.health::query.v' + responses: + '200': + $ref: '#/components/responses/cat.health@200' + /_cat/indices: + get: + operationId: cat.indices.0 + x-operation-group: cat.indices + x-version-added: '1.0' + description: 'Returns information about indices: number of primaries and replicas, document counts, disk size, ...' + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ + parameters: + - $ref: '#/components/parameters/cat.indices::query.format' + - $ref: '#/components/parameters/cat.indices::query.bytes' + - $ref: '#/components/parameters/cat.indices::query.local' + - $ref: '#/components/parameters/cat.indices::query.master_timeout' + - $ref: '#/components/parameters/cat.indices::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.indices::query.h' + - $ref: '#/components/parameters/cat.indices::query.health' + - $ref: '#/components/parameters/cat.indices::query.help' + - $ref: '#/components/parameters/cat.indices::query.pri' + - $ref: '#/components/parameters/cat.indices::query.s' + - $ref: '#/components/parameters/cat.indices::query.time' + - $ref: '#/components/parameters/cat.indices::query.v' + - $ref: '#/components/parameters/cat.indices::query.include_unloaded_segments' + - $ref: '#/components/parameters/cat.indices::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/cat.indices@200' + /_cat/indices/{index}: + get: + operationId: cat.indices.1 + x-operation-group: cat.indices + x-version-added: '1.0' + description: 'Returns information about indices: number of primaries and replicas, document counts, disk size, ...' + parameters: + - $ref: '#/components/parameters/cat.indices::path.index' + - $ref: '#/components/parameters/cat.indices::query.format' + - $ref: '#/components/parameters/cat.indices::query.bytes' + - $ref: '#/components/parameters/cat.indices::query.local' + - $ref: '#/components/parameters/cat.indices::query.master_timeout' + - $ref: '#/components/parameters/cat.indices::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.indices::query.h' + - $ref: '#/components/parameters/cat.indices::query.health' + - $ref: '#/components/parameters/cat.indices::query.help' + - $ref: '#/components/parameters/cat.indices::query.pri' + - $ref: '#/components/parameters/cat.indices::query.s' + - $ref: '#/components/parameters/cat.indices::query.time' + - $ref: '#/components/parameters/cat.indices::query.v' + - $ref: '#/components/parameters/cat.indices::query.include_unloaded_segments' + - $ref: '#/components/parameters/cat.indices::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/cat.indices@200' + /_cat/master: + get: + operationId: cat.master.0 + x-operation-group: cat.master + deprecated: true + x-deprecation-message: To promote inclusive language, please use '/_cat/cluster_manager' instead. + x-version-added: '1.0' + x-version-deprecated: '2.0' + description: Returns information about the cluster-manager node. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ + parameters: + - $ref: '#/components/parameters/cat.master::query.format' + - $ref: '#/components/parameters/cat.master::query.local' + - $ref: '#/components/parameters/cat.master::query.master_timeout' + - $ref: '#/components/parameters/cat.master::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.master::query.h' + - $ref: '#/components/parameters/cat.master::query.help' + - $ref: '#/components/parameters/cat.master::query.s' + - $ref: '#/components/parameters/cat.master::query.v' + responses: + '200': + $ref: '#/components/responses/cat.master@200' + /_cat/nodeattrs: + get: + operationId: cat.nodeattrs.0 + x-operation-group: cat.nodeattrs + x-version-added: '1.0' + description: Returns information about custom node attributes. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/ + parameters: + - $ref: '#/components/parameters/cat.nodeattrs::query.format' + - $ref: '#/components/parameters/cat.nodeattrs::query.local' + - $ref: '#/components/parameters/cat.nodeattrs::query.master_timeout' + - $ref: '#/components/parameters/cat.nodeattrs::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.nodeattrs::query.h' + - $ref: '#/components/parameters/cat.nodeattrs::query.help' + - $ref: '#/components/parameters/cat.nodeattrs::query.s' + - $ref: '#/components/parameters/cat.nodeattrs::query.v' + responses: + '200': + $ref: '#/components/responses/cat.nodeattrs@200' + /_cat/nodes: + get: + operationId: cat.nodes.0 + x-operation-group: cat.nodes + x-version-added: '1.0' + description: Returns basic statistics about performance of cluster nodes. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/ + parameters: + - $ref: '#/components/parameters/cat.nodes::query.bytes' + - $ref: '#/components/parameters/cat.nodes::query.format' + - $ref: '#/components/parameters/cat.nodes::query.full_id' + - $ref: '#/components/parameters/cat.nodes::query.local' + - $ref: '#/components/parameters/cat.nodes::query.master_timeout' + - $ref: '#/components/parameters/cat.nodes::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.nodes::query.h' + - $ref: '#/components/parameters/cat.nodes::query.help' + - $ref: '#/components/parameters/cat.nodes::query.s' + - $ref: '#/components/parameters/cat.nodes::query.time' + - $ref: '#/components/parameters/cat.nodes::query.v' + responses: + '200': + $ref: '#/components/responses/cat.nodes@200' + /_cat/pending_tasks: + get: + operationId: cat.pending_tasks.0 + x-operation-group: cat.pending_tasks + x-version-added: '1.0' + description: Returns a concise representation of the cluster pending tasks. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/ + parameters: + - $ref: '#/components/parameters/cat.pending_tasks::query.format' + - $ref: '#/components/parameters/cat.pending_tasks::query.local' + - $ref: '#/components/parameters/cat.pending_tasks::query.master_timeout' + - $ref: '#/components/parameters/cat.pending_tasks::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.pending_tasks::query.h' + - $ref: '#/components/parameters/cat.pending_tasks::query.help' + - $ref: '#/components/parameters/cat.pending_tasks::query.s' + - $ref: '#/components/parameters/cat.pending_tasks::query.time' + - $ref: '#/components/parameters/cat.pending_tasks::query.v' + responses: + '200': + $ref: '#/components/responses/cat.pending_tasks@200' + /_cat/pit_segments: + get: + operationId: cat.pit_segments.0 + x-operation-group: cat.pit_segments + x-version-added: '2.4' + description: List segments for one or several PITs. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ + parameters: + - $ref: '#/components/parameters/cat.pit_segments::query.format' + - $ref: '#/components/parameters/cat.pit_segments::query.h' + - $ref: '#/components/parameters/cat.pit_segments::query.help' + - $ref: '#/components/parameters/cat.pit_segments::query.s' + - $ref: '#/components/parameters/cat.pit_segments::query.v' + - $ref: '#/components/parameters/cat.pit_segments::query.bytes' + requestBody: + $ref: '#/components/requestBodies/cat.pit_segments' + responses: + '200': + $ref: '#/components/responses/cat.pit_segments@200' + /_cat/pit_segments/_all: + get: + operationId: cat.all_pit_segments.0 + x-operation-group: cat.all_pit_segments + x-version-added: '2.4' + description: Lists all active point-in-time segments. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ + parameters: + - $ref: '#/components/parameters/cat.all_pit_segments::query.format' + - $ref: '#/components/parameters/cat.all_pit_segments::query.h' + - $ref: '#/components/parameters/cat.all_pit_segments::query.help' + - $ref: '#/components/parameters/cat.all_pit_segments::query.s' + - $ref: '#/components/parameters/cat.all_pit_segments::query.v' + - $ref: '#/components/parameters/cat.all_pit_segments::query.bytes' + responses: + '200': + $ref: '#/components/responses/cat.all_pit_segments@200' + /_cat/plugins: + get: + operationId: cat.plugins.0 + x-operation-group: cat.plugins + x-version-added: '1.0' + description: Returns information about installed plugins across nodes node. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ + parameters: + - $ref: '#/components/parameters/cat.plugins::query.format' + - $ref: '#/components/parameters/cat.plugins::query.local' + - $ref: '#/components/parameters/cat.plugins::query.master_timeout' + - $ref: '#/components/parameters/cat.plugins::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.plugins::query.h' + - $ref: '#/components/parameters/cat.plugins::query.help' + - $ref: '#/components/parameters/cat.plugins::query.s' + - $ref: '#/components/parameters/cat.plugins::query.v' + responses: + '200': + $ref: '#/components/responses/cat.plugins@200' + /_cat/recovery: + get: + operationId: cat.recovery.0 + x-operation-group: cat.recovery + x-version-added: '1.0' + description: Returns information about index shard recoveries, both on-going completed. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ + parameters: + - $ref: '#/components/parameters/cat.recovery::query.format' + - $ref: '#/components/parameters/cat.recovery::query.active_only' + - $ref: '#/components/parameters/cat.recovery::query.bytes' + - $ref: '#/components/parameters/cat.recovery::query.detailed' + - $ref: '#/components/parameters/cat.recovery::query.h' + - $ref: '#/components/parameters/cat.recovery::query.help' + - $ref: '#/components/parameters/cat.recovery::query.index' + - $ref: '#/components/parameters/cat.recovery::query.s' + - $ref: '#/components/parameters/cat.recovery::query.time' + - $ref: '#/components/parameters/cat.recovery::query.v' + responses: + '200': + $ref: '#/components/responses/cat.recovery@200' + /_cat/recovery/{index}: + get: + operationId: cat.recovery.1 + x-operation-group: cat.recovery + x-version-added: '1.0' + description: Returns information about index shard recoveries, both on-going completed. + parameters: + - $ref: '#/components/parameters/cat.recovery::path.index' + - $ref: '#/components/parameters/cat.recovery::query.format' + - $ref: '#/components/parameters/cat.recovery::query.active_only' + - $ref: '#/components/parameters/cat.recovery::query.bytes' + - $ref: '#/components/parameters/cat.recovery::query.detailed' + - $ref: '#/components/parameters/cat.recovery::query.h' + - $ref: '#/components/parameters/cat.recovery::query.help' + - $ref: '#/components/parameters/cat.recovery::query.index' + - $ref: '#/components/parameters/cat.recovery::query.s' + - $ref: '#/components/parameters/cat.recovery::query.time' + - $ref: '#/components/parameters/cat.recovery::query.v' + responses: + '200': + $ref: '#/components/responses/cat.recovery@200' + /_cat/repositories: + get: + operationId: cat.repositories.0 + x-operation-group: cat.repositories + x-version-added: '1.0' + description: Returns information about snapshot repositories registered in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/ + parameters: + - $ref: '#/components/parameters/cat.repositories::query.format' + - $ref: '#/components/parameters/cat.repositories::query.local' + - $ref: '#/components/parameters/cat.repositories::query.master_timeout' + - $ref: '#/components/parameters/cat.repositories::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.repositories::query.h' + - $ref: '#/components/parameters/cat.repositories::query.help' + - $ref: '#/components/parameters/cat.repositories::query.s' + - $ref: '#/components/parameters/cat.repositories::query.v' + responses: + '200': + $ref: '#/components/responses/cat.repositories@200' + /_cat/segment_replication: + get: + operationId: cat.segment_replication.0 + x-operation-group: cat.segment_replication + x-version-added: 2.6.0 + description: Returns information about both on-going and latest completed Segment Replication events. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/ + parameters: + - $ref: '#/components/parameters/cat.segment_replication::query.format' + - $ref: '#/components/parameters/cat.segment_replication::query.h' + - $ref: '#/components/parameters/cat.segment_replication::query.help' + - $ref: '#/components/parameters/cat.segment_replication::query.s' + - $ref: '#/components/parameters/cat.segment_replication::query.v' + - $ref: '#/components/parameters/cat.segment_replication::query.allow_no_indices' + - $ref: '#/components/parameters/cat.segment_replication::query.expand_wildcards' + - $ref: '#/components/parameters/cat.segment_replication::query.ignore_throttled' + - $ref: '#/components/parameters/cat.segment_replication::query.ignore_unavailable' + - $ref: '#/components/parameters/cat.segment_replication::query.active_only' + - $ref: '#/components/parameters/cat.segment_replication::query.completed_only' + - $ref: '#/components/parameters/cat.segment_replication::query.bytes' + - $ref: '#/components/parameters/cat.segment_replication::query.detailed' + - $ref: '#/components/parameters/cat.segment_replication::query.shards' + - $ref: '#/components/parameters/cat.segment_replication::query.index' + - $ref: '#/components/parameters/cat.segment_replication::query.time' + - $ref: '#/components/parameters/cat.segment_replication::query.timeout' + responses: + '200': + $ref: '#/components/responses/cat.segment_replication@200' + /_cat/segment_replication/{index}: + get: + operationId: cat.segment_replication.1 + x-operation-group: cat.segment_replication + x-version-added: 2.6.0 + description: Returns information about both on-going and latest completed Segment Replication events. + parameters: + - $ref: '#/components/parameters/cat.segment_replication::path.index' + - $ref: '#/components/parameters/cat.segment_replication::query.format' + - $ref: '#/components/parameters/cat.segment_replication::query.h' + - $ref: '#/components/parameters/cat.segment_replication::query.help' + - $ref: '#/components/parameters/cat.segment_replication::query.s' + - $ref: '#/components/parameters/cat.segment_replication::query.v' + - $ref: '#/components/parameters/cat.segment_replication::query.allow_no_indices' + - $ref: '#/components/parameters/cat.segment_replication::query.expand_wildcards' + - $ref: '#/components/parameters/cat.segment_replication::query.ignore_throttled' + - $ref: '#/components/parameters/cat.segment_replication::query.ignore_unavailable' + - $ref: '#/components/parameters/cat.segment_replication::query.active_only' + - $ref: '#/components/parameters/cat.segment_replication::query.completed_only' + - $ref: '#/components/parameters/cat.segment_replication::query.bytes' + - $ref: '#/components/parameters/cat.segment_replication::query.detailed' + - $ref: '#/components/parameters/cat.segment_replication::query.shards' + - $ref: '#/components/parameters/cat.segment_replication::query.index' + - $ref: '#/components/parameters/cat.segment_replication::query.time' + - $ref: '#/components/parameters/cat.segment_replication::query.timeout' + responses: + '200': + $ref: '#/components/responses/cat.segment_replication@200' + /_cat/segments: + get: + operationId: cat.segments.0 + x-operation-group: cat.segments + x-version-added: '1.0' + description: Provides low-level information about the segments in the shards of an index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-segments/ + parameters: + - $ref: '#/components/parameters/cat.segments::query.format' + - $ref: '#/components/parameters/cat.segments::query.bytes' + - $ref: '#/components/parameters/cat.segments::query.master_timeout' + - $ref: '#/components/parameters/cat.segments::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.segments::query.h' + - $ref: '#/components/parameters/cat.segments::query.help' + - $ref: '#/components/parameters/cat.segments::query.s' + - $ref: '#/components/parameters/cat.segments::query.v' + responses: + '200': + $ref: '#/components/responses/cat.segments@200' + /_cat/segments/{index}: + get: + operationId: cat.segments.1 + x-operation-group: cat.segments + x-version-added: '1.0' + description: Provides low-level information about the segments in the shards of an index. + parameters: + - $ref: '#/components/parameters/cat.segments::path.index' + - $ref: '#/components/parameters/cat.segments::query.format' + - $ref: '#/components/parameters/cat.segments::query.bytes' + - $ref: '#/components/parameters/cat.segments::query.master_timeout' + - $ref: '#/components/parameters/cat.segments::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.segments::query.h' + - $ref: '#/components/parameters/cat.segments::query.help' + - $ref: '#/components/parameters/cat.segments::query.s' + - $ref: '#/components/parameters/cat.segments::query.v' + responses: + '200': + $ref: '#/components/responses/cat.segments@200' + /_cat/shards: + get: + operationId: cat.shards.0 + x-operation-group: cat.shards + x-version-added: '1.0' + description: Provides a detailed view of shard allocation on nodes. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-shards/ + parameters: + - $ref: '#/components/parameters/cat.shards::query.format' + - $ref: '#/components/parameters/cat.shards::query.bytes' + - $ref: '#/components/parameters/cat.shards::query.local' + - $ref: '#/components/parameters/cat.shards::query.master_timeout' + - $ref: '#/components/parameters/cat.shards::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.shards::query.h' + - $ref: '#/components/parameters/cat.shards::query.help' + - $ref: '#/components/parameters/cat.shards::query.s' + - $ref: '#/components/parameters/cat.shards::query.time' + - $ref: '#/components/parameters/cat.shards::query.v' + responses: + '200': + $ref: '#/components/responses/cat.shards@200' + /_cat/shards/{index}: + get: + operationId: cat.shards.1 + x-operation-group: cat.shards + x-version-added: '1.0' + description: Provides a detailed view of shard allocation on nodes. + parameters: + - $ref: '#/components/parameters/cat.shards::path.index' + - $ref: '#/components/parameters/cat.shards::query.format' + - $ref: '#/components/parameters/cat.shards::query.bytes' + - $ref: '#/components/parameters/cat.shards::query.local' + - $ref: '#/components/parameters/cat.shards::query.master_timeout' + - $ref: '#/components/parameters/cat.shards::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.shards::query.h' + - $ref: '#/components/parameters/cat.shards::query.help' + - $ref: '#/components/parameters/cat.shards::query.s' + - $ref: '#/components/parameters/cat.shards::query.time' + - $ref: '#/components/parameters/cat.shards::query.v' + responses: + '200': + $ref: '#/components/responses/cat.shards@200' + /_cat/snapshots: + get: + operationId: cat.snapshots.0 + x-operation-group: cat.snapshots + x-version-added: '1.0' + description: Returns all snapshots in a specific repository. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ + parameters: + - $ref: '#/components/parameters/cat.snapshots::query.format' + - $ref: '#/components/parameters/cat.snapshots::query.ignore_unavailable' + - $ref: '#/components/parameters/cat.snapshots::query.master_timeout' + - $ref: '#/components/parameters/cat.snapshots::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.snapshots::query.h' + - $ref: '#/components/parameters/cat.snapshots::query.help' + - $ref: '#/components/parameters/cat.snapshots::query.s' + - $ref: '#/components/parameters/cat.snapshots::query.time' + - $ref: '#/components/parameters/cat.snapshots::query.v' + responses: + '200': + $ref: '#/components/responses/cat.snapshots@200' + /_cat/snapshots/{repository}: + get: + operationId: cat.snapshots.1 + x-operation-group: cat.snapshots + x-version-added: '1.0' + description: Returns all snapshots in a specific repository. + parameters: + - $ref: '#/components/parameters/cat.snapshots::path.repository' + - $ref: '#/components/parameters/cat.snapshots::query.format' + - $ref: '#/components/parameters/cat.snapshots::query.ignore_unavailable' + - $ref: '#/components/parameters/cat.snapshots::query.master_timeout' + - $ref: '#/components/parameters/cat.snapshots::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.snapshots::query.h' + - $ref: '#/components/parameters/cat.snapshots::query.help' + - $ref: '#/components/parameters/cat.snapshots::query.s' + - $ref: '#/components/parameters/cat.snapshots::query.time' + - $ref: '#/components/parameters/cat.snapshots::query.v' + responses: + '200': + $ref: '#/components/responses/cat.snapshots@200' + /_cat/tasks: + get: + operationId: cat.tasks.0 + x-operation-group: cat.tasks + x-version-added: '1.0' + description: Returns information about the tasks currently executing on one or more nodes in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/ + parameters: + - $ref: '#/components/parameters/cat.tasks::query.format' + - $ref: '#/components/parameters/cat.tasks::query.nodes' + - $ref: '#/components/parameters/cat.tasks::query.actions' + - $ref: '#/components/parameters/cat.tasks::query.detailed' + - $ref: '#/components/parameters/cat.tasks::query.parent_task_id' + - $ref: '#/components/parameters/cat.tasks::query.h' + - $ref: '#/components/parameters/cat.tasks::query.help' + - $ref: '#/components/parameters/cat.tasks::query.s' + - $ref: '#/components/parameters/cat.tasks::query.time' + - $ref: '#/components/parameters/cat.tasks::query.v' + responses: + '200': + $ref: '#/components/responses/cat.tasks@200' + /_cat/templates: + get: + operationId: cat.templates.0 + x-operation-group: cat.templates + x-version-added: '1.0' + description: Returns information about existing templates. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-templates/ + parameters: + - $ref: '#/components/parameters/cat.templates::query.format' + - $ref: '#/components/parameters/cat.templates::query.local' + - $ref: '#/components/parameters/cat.templates::query.master_timeout' + - $ref: '#/components/parameters/cat.templates::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.templates::query.h' + - $ref: '#/components/parameters/cat.templates::query.help' + - $ref: '#/components/parameters/cat.templates::query.s' + - $ref: '#/components/parameters/cat.templates::query.v' + responses: + '200': + $ref: '#/components/responses/cat.templates@200' + /_cat/templates/{name}: + get: + operationId: cat.templates.1 + x-operation-group: cat.templates + x-version-added: '1.0' + description: Returns information about existing templates. + parameters: + - $ref: '#/components/parameters/cat.templates::path.name' + - $ref: '#/components/parameters/cat.templates::query.format' + - $ref: '#/components/parameters/cat.templates::query.local' + - $ref: '#/components/parameters/cat.templates::query.master_timeout' + - $ref: '#/components/parameters/cat.templates::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.templates::query.h' + - $ref: '#/components/parameters/cat.templates::query.help' + - $ref: '#/components/parameters/cat.templates::query.s' + - $ref: '#/components/parameters/cat.templates::query.v' + responses: + '200': + $ref: '#/components/responses/cat.templates@200' + /_cat/thread_pool: + get: + operationId: cat.thread_pool.0 + x-operation-group: cat.thread_pool + x-version-added: '1.0' + description: |- + Returns cluster-wide thread pool statistics per node. + By default the active, queue and rejected statistics are returned for all thread pools. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/ + parameters: + - $ref: '#/components/parameters/cat.thread_pool::query.format' + - $ref: '#/components/parameters/cat.thread_pool::query.size' + - $ref: '#/components/parameters/cat.thread_pool::query.local' + - $ref: '#/components/parameters/cat.thread_pool::query.master_timeout' + - $ref: '#/components/parameters/cat.thread_pool::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.thread_pool::query.h' + - $ref: '#/components/parameters/cat.thread_pool::query.help' + - $ref: '#/components/parameters/cat.thread_pool::query.s' + - $ref: '#/components/parameters/cat.thread_pool::query.v' + responses: + '200': + $ref: '#/components/responses/cat.thread_pool@200' + /_cat/thread_pool/{thread_pool_patterns}: + get: + operationId: cat.thread_pool.1 + x-operation-group: cat.thread_pool + x-version-added: '1.0' + description: |- + Returns cluster-wide thread pool statistics per node. + By default the active, queue and rejected statistics are returned for all thread pools. + parameters: + - $ref: '#/components/parameters/cat.thread_pool::path.thread_pool_patterns' + - $ref: '#/components/parameters/cat.thread_pool::query.format' + - $ref: '#/components/parameters/cat.thread_pool::query.size' + - $ref: '#/components/parameters/cat.thread_pool::query.local' + - $ref: '#/components/parameters/cat.thread_pool::query.master_timeout' + - $ref: '#/components/parameters/cat.thread_pool::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.thread_pool::query.h' + - $ref: '#/components/parameters/cat.thread_pool::query.help' + - $ref: '#/components/parameters/cat.thread_pool::query.s' + - $ref: '#/components/parameters/cat.thread_pool::query.v' + responses: + '200': + $ref: '#/components/responses/cat.thread_pool@200' + /_cluster/allocation/explain: + get: + operationId: cluster.allocation_explain.0 + x-operation-group: cluster.allocation_explain + x-version-added: '1.0' + description: Provides explanations for shard allocations in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/ + parameters: + - $ref: '#/components/parameters/cluster.allocation_explain::query.include_yes_decisions' + - $ref: '#/components/parameters/cluster.allocation_explain::query.include_disk_info' + requestBody: + $ref: '#/components/requestBodies/cluster.allocation_explain' + responses: + '200': + $ref: '#/components/responses/cluster.allocation_explain@200' + post: + operationId: cluster.allocation_explain.1 + x-operation-group: cluster.allocation_explain + x-version-added: '1.0' + description: Provides explanations for shard allocations in the cluster. + parameters: + - $ref: '#/components/parameters/cluster.allocation_explain::query.include_yes_decisions' + - $ref: '#/components/parameters/cluster.allocation_explain::query.include_disk_info' + requestBody: + $ref: '#/components/requestBodies/cluster.allocation_explain' + responses: + '200': + $ref: '#/components/responses/cluster.allocation_explain@200' + /_cluster/decommission/awareness: + delete: + operationId: cluster.delete_decommission_awareness.0 + x-operation-group: cluster.delete_decommission_awareness + x-version-added: '1.0' + description: Delete any existing decommission. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone + responses: + '200': + $ref: '#/components/responses/cluster.delete_decommission_awareness@200' + /_cluster/decommission/awareness/{awareness_attribute_name}/_status: + get: + operationId: cluster.get_decommission_awareness.0 + x-operation-group: cluster.get_decommission_awareness + x-version-added: '1.0' + description: Get details and status of decommissioned attribute. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-getting-zone-decommission-status + parameters: + - $ref: '#/components/parameters/cluster.get_decommission_awareness::path.awareness_attribute_name' + responses: + '200': + $ref: '#/components/responses/cluster.get_decommission_awareness@200' + /_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}: + put: + operationId: cluster.put_decommission_awareness.0 + x-operation-group: cluster.put_decommission_awareness + x-version-added: '1.0' + description: Decommissions an awareness attribute. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone + parameters: + - $ref: '#/components/parameters/cluster.put_decommission_awareness::path.awareness_attribute_name' + - $ref: '#/components/parameters/cluster.put_decommission_awareness::path.awareness_attribute_value' + responses: + '200': + $ref: '#/components/responses/cluster.put_decommission_awareness@200' + /_cluster/health: + get: + operationId: cluster.health.0 + x-operation-group: cluster.health + x-version-added: '1.0' + description: Returns basic information about the health of the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/ + parameters: + - $ref: '#/components/parameters/cluster.health::query.expand_wildcards' + - $ref: '#/components/parameters/cluster.health::query.level' + - $ref: '#/components/parameters/cluster.health::query.local' + - $ref: '#/components/parameters/cluster.health::query.master_timeout' + - $ref: '#/components/parameters/cluster.health::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.health::query.timeout' + - $ref: '#/components/parameters/cluster.health::query.wait_for_active_shards' + - $ref: '#/components/parameters/cluster.health::query.wait_for_nodes' + - $ref: '#/components/parameters/cluster.health::query.wait_for_events' + - $ref: '#/components/parameters/cluster.health::query.wait_for_no_relocating_shards' + - $ref: '#/components/parameters/cluster.health::query.wait_for_no_initializing_shards' + - $ref: '#/components/parameters/cluster.health::query.wait_for_status' + - $ref: '#/components/parameters/cluster.health::query.awareness_attribute' + responses: + '200': + $ref: '#/components/responses/cluster.health@200' + /_cluster/health/{index}: + get: + operationId: cluster.health.1 + x-operation-group: cluster.health + x-version-added: '1.0' + description: Returns basic information about the health of the cluster. + parameters: + - $ref: '#/components/parameters/cluster.health::path.index' + - $ref: '#/components/parameters/cluster.health::query.expand_wildcards' + - $ref: '#/components/parameters/cluster.health::query.level' + - $ref: '#/components/parameters/cluster.health::query.local' + - $ref: '#/components/parameters/cluster.health::query.master_timeout' + - $ref: '#/components/parameters/cluster.health::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.health::query.timeout' + - $ref: '#/components/parameters/cluster.health::query.wait_for_active_shards' + - $ref: '#/components/parameters/cluster.health::query.wait_for_nodes' + - $ref: '#/components/parameters/cluster.health::query.wait_for_events' + - $ref: '#/components/parameters/cluster.health::query.wait_for_no_relocating_shards' + - $ref: '#/components/parameters/cluster.health::query.wait_for_no_initializing_shards' + - $ref: '#/components/parameters/cluster.health::query.wait_for_status' + - $ref: '#/components/parameters/cluster.health::query.awareness_attribute' + responses: + '200': + $ref: '#/components/responses/cluster.health@200' + /_cluster/nodes/hot_threads: + get: + operationId: nodes.hot_threads.0 + x-operation-group: nodes.hot_threads + x-ignorable: true + deprecated: true + x-deprecation-message: The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Returns information about hot threads on each node in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_cluster/nodes/hotthreads: + get: + operationId: nodes.hot_threads.1 + x-operation-group: nodes.hot_threads + x-ignorable: true + deprecated: true + x-deprecation-message: The hot threads API accepts `hotthreads` but only `hot_threads` is documented + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_cluster/nodes/{node_id}/hot_threads: + get: + operationId: nodes.hot_threads.2 + x-operation-group: nodes.hot_threads + x-ignorable: true + deprecated: true + x-deprecation-message: The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_cluster/nodes/{node_id}/hotthreads: + get: + operationId: nodes.hot_threads.3 + x-operation-group: nodes.hot_threads + x-ignorable: true + deprecated: true + x-deprecation-message: The hot threads API accepts `hotthreads` but only `hot_threads` is documented + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_cluster/pending_tasks: + get: + operationId: cluster.pending_tasks.0 + x-operation-group: cluster.pending_tasks + x-version-added: '1.0' + description: |- + Returns a list of any cluster-level changes (e.g. create index, update mapping, + allocate or fail shard) which have not yet been executed. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/cluster.pending_tasks::query.local' + - $ref: '#/components/parameters/cluster.pending_tasks::query.master_timeout' + - $ref: '#/components/parameters/cluster.pending_tasks::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/cluster.pending_tasks@200' + /_cluster/reroute: + post: + operationId: cluster.reroute.0 + x-operation-group: cluster.reroute + x-version-added: '1.0' + description: Allows to manually change the allocation of individual shards in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/cluster.reroute::query.dry_run' + - $ref: '#/components/parameters/cluster.reroute::query.explain' + - $ref: '#/components/parameters/cluster.reroute::query.retry_failed' + - $ref: '#/components/parameters/cluster.reroute::query.metric' + - $ref: '#/components/parameters/cluster.reroute::query.master_timeout' + - $ref: '#/components/parameters/cluster.reroute::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.reroute::query.timeout' + requestBody: + $ref: '#/components/requestBodies/cluster.reroute' + responses: + '200': + $ref: '#/components/responses/cluster.reroute@200' + /_cluster/routing/awareness/weights: + delete: + operationId: cluster.delete_weighted_routing.0 + x-operation-group: cluster.delete_weighted_routing + x-version-added: '1.0' + description: Delete weighted shard routing weights. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-deleting-weights + responses: + '200': + $ref: '#/components/responses/cluster.delete_weighted_routing@200' + /_cluster/routing/awareness/{attribute}/weights: + get: + operationId: cluster.get_weighted_routing.0 + x-operation-group: cluster.get_weighted_routing + x-version-added: '1.0' + description: Fetches weighted shard routing weights. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-getting-weights-for-all-zones + parameters: + - $ref: '#/components/parameters/cluster.get_weighted_routing::path.attribute' + responses: + '200': + $ref: '#/components/responses/cluster.get_weighted_routing@200' + put: + operationId: cluster.put_weighted_routing.0 + x-operation-group: cluster.put_weighted_routing + x-version-added: '1.0' + description: Updates weighted shard routing weights. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-weighted-round-robin-search + parameters: + - $ref: '#/components/parameters/cluster.put_weighted_routing::path.attribute' + responses: + '200': + $ref: '#/components/responses/cluster.put_weighted_routing@200' + /_cluster/settings: + get: + operationId: cluster.get_settings.0 + x-operation-group: cluster.get_settings + x-version-added: '1.0' + description: Returns cluster settings. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/ + parameters: + - $ref: '#/components/parameters/cluster.get_settings::query.flat_settings' + - $ref: '#/components/parameters/cluster.get_settings::query.master_timeout' + - $ref: '#/components/parameters/cluster.get_settings::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.get_settings::query.timeout' + - $ref: '#/components/parameters/cluster.get_settings::query.include_defaults' + responses: + '200': + $ref: '#/components/responses/cluster.get_settings@200' + put: + operationId: cluster.put_settings.0 + x-operation-group: cluster.put_settings + x-version-added: '1.0' + description: Updates the cluster settings. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-settings/ + parameters: + - $ref: '#/components/parameters/cluster.put_settings::query.flat_settings' + - $ref: '#/components/parameters/cluster.put_settings::query.master_timeout' + - $ref: '#/components/parameters/cluster.put_settings::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.put_settings::query.timeout' + requestBody: + $ref: '#/components/requestBodies/cluster.put_settings' + responses: + '200': + $ref: '#/components/responses/cluster.put_settings@200' + /_cluster/state: + get: + operationId: cluster.state.0 + x-operation-group: cluster.state + x-version-added: '1.0' + description: Returns a comprehensive information about the state of the cluster. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/cluster.state::query.local' + - $ref: '#/components/parameters/cluster.state::query.master_timeout' + - $ref: '#/components/parameters/cluster.state::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.state::query.flat_settings' + - $ref: '#/components/parameters/cluster.state::query.wait_for_metadata_version' + - $ref: '#/components/parameters/cluster.state::query.wait_for_timeout' + - $ref: '#/components/parameters/cluster.state::query.ignore_unavailable' + - $ref: '#/components/parameters/cluster.state::query.allow_no_indices' + - $ref: '#/components/parameters/cluster.state::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/cluster.state@200' + /_cluster/state/{metric}: + get: + operationId: cluster.state.1 + x-operation-group: cluster.state + x-version-added: '1.0' + description: Returns a comprehensive information about the state of the cluster. + parameters: + - $ref: '#/components/parameters/cluster.state::path.metric' + - $ref: '#/components/parameters/cluster.state::query.local' + - $ref: '#/components/parameters/cluster.state::query.master_timeout' + - $ref: '#/components/parameters/cluster.state::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.state::query.flat_settings' + - $ref: '#/components/parameters/cluster.state::query.wait_for_metadata_version' + - $ref: '#/components/parameters/cluster.state::query.wait_for_timeout' + - $ref: '#/components/parameters/cluster.state::query.ignore_unavailable' + - $ref: '#/components/parameters/cluster.state::query.allow_no_indices' + - $ref: '#/components/parameters/cluster.state::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/cluster.state@200' + /_cluster/state/{metric}/{index}: + get: + operationId: cluster.state.2 + x-operation-group: cluster.state + x-version-added: '1.0' + description: Returns a comprehensive information about the state of the cluster. + parameters: + - $ref: '#/components/parameters/cluster.state::path.index' + - $ref: '#/components/parameters/cluster.state::path.metric' + - $ref: '#/components/parameters/cluster.state::query.local' + - $ref: '#/components/parameters/cluster.state::query.master_timeout' + - $ref: '#/components/parameters/cluster.state::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.state::query.flat_settings' + - $ref: '#/components/parameters/cluster.state::query.wait_for_metadata_version' + - $ref: '#/components/parameters/cluster.state::query.wait_for_timeout' + - $ref: '#/components/parameters/cluster.state::query.ignore_unavailable' + - $ref: '#/components/parameters/cluster.state::query.allow_no_indices' + - $ref: '#/components/parameters/cluster.state::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/cluster.state@200' + /_cluster/stats: + get: + operationId: cluster.stats.0 + x-operation-group: cluster.stats + x-version-added: '1.0' + description: Returns high-level overview of cluster statistics. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ + parameters: + - $ref: '#/components/parameters/cluster.stats::query.flat_settings' + - $ref: '#/components/parameters/cluster.stats::query.timeout' + responses: + '200': + $ref: '#/components/responses/cluster.stats@200' + /_cluster/stats/nodes/{node_id}: + get: + operationId: cluster.stats.1 + x-operation-group: cluster.stats + x-version-added: '1.0' + description: Returns high-level overview of cluster statistics. + parameters: + - $ref: '#/components/parameters/cluster.stats::path.node_id' + - $ref: '#/components/parameters/cluster.stats::query.flat_settings' + - $ref: '#/components/parameters/cluster.stats::query.timeout' + responses: + '200': + $ref: '#/components/responses/cluster.stats@200' + /_cluster/voting_config_exclusions: + delete: + operationId: cluster.delete_voting_config_exclusions.0 + x-operation-group: cluster.delete_voting_config_exclusions + x-version-added: '1.0' + description: Clears cluster voting config exclusions. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/cluster.delete_voting_config_exclusions::query.wait_for_removal' + responses: + '200': + $ref: '#/components/responses/cluster.delete_voting_config_exclusions@200' + post: + operationId: cluster.post_voting_config_exclusions.0 + x-operation-group: cluster.post_voting_config_exclusions + x-version-added: '1.0' + description: Updates the cluster voting config exclusions by node ids or node names. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/cluster.post_voting_config_exclusions::query.node_ids' + - $ref: '#/components/parameters/cluster.post_voting_config_exclusions::query.node_names' + - $ref: '#/components/parameters/cluster.post_voting_config_exclusions::query.timeout' + responses: + '200': + $ref: '#/components/responses/cluster.post_voting_config_exclusions@200' + /_component_template: + get: + operationId: cluster.get_component_template.0 + x-operation-group: cluster.get_component_template + x-version-added: '1.0' + description: Returns one or more component templates. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/cluster.get_component_template::query.master_timeout' + - $ref: '#/components/parameters/cluster.get_component_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.get_component_template::query.local' + responses: + '200': + $ref: '#/components/responses/cluster.get_component_template@200' + /_component_template/{name}: + delete: + operationId: cluster.delete_component_template.0 + x-operation-group: cluster.delete_component_template + x-version-added: '1.0' + description: Deletes a component template. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/cluster.delete_component_template::path.name' + - $ref: '#/components/parameters/cluster.delete_component_template::query.timeout' + - $ref: '#/components/parameters/cluster.delete_component_template::query.master_timeout' + - $ref: '#/components/parameters/cluster.delete_component_template::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/cluster.delete_component_template@200' + get: + operationId: cluster.get_component_template.1 + x-operation-group: cluster.get_component_template + x-version-added: '1.0' + description: Returns one or more component templates. + parameters: + - $ref: '#/components/parameters/cluster.get_component_template::path.name' + - $ref: '#/components/parameters/cluster.get_component_template::query.master_timeout' + - $ref: '#/components/parameters/cluster.get_component_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.get_component_template::query.local' + responses: + '200': + $ref: '#/components/responses/cluster.get_component_template@200' + head: + operationId: cluster.exists_component_template.0 + x-operation-group: cluster.exists_component_template + x-version-added: '1.0' + description: Returns information about whether a particular component template exist. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/cluster.exists_component_template::path.name' + - $ref: '#/components/parameters/cluster.exists_component_template::query.master_timeout' + - $ref: '#/components/parameters/cluster.exists_component_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.exists_component_template::query.local' + responses: + '200': + $ref: '#/components/responses/cluster.exists_component_template@200' + post: + operationId: cluster.put_component_template.0 + x-operation-group: cluster.put_component_template + x-version-added: '1.0' + description: Creates or updates a component template. + parameters: + - $ref: '#/components/parameters/cluster.put_component_template::path.name' + - $ref: '#/components/parameters/cluster.put_component_template::query.create' + - $ref: '#/components/parameters/cluster.put_component_template::query.timeout' + - $ref: '#/components/parameters/cluster.put_component_template::query.master_timeout' + - $ref: '#/components/parameters/cluster.put_component_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/cluster.put_component_template' + responses: + '200': + $ref: '#/components/responses/cluster.put_component_template@200' + put: + operationId: cluster.put_component_template.1 + x-operation-group: cluster.put_component_template + x-version-added: '1.0' + description: Creates or updates a component template. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template + parameters: + - $ref: '#/components/parameters/cluster.put_component_template::path.name' + - $ref: '#/components/parameters/cluster.put_component_template::query.create' + - $ref: '#/components/parameters/cluster.put_component_template::query.timeout' + - $ref: '#/components/parameters/cluster.put_component_template::query.master_timeout' + - $ref: '#/components/parameters/cluster.put_component_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/cluster.put_component_template' + responses: + '200': + $ref: '#/components/responses/cluster.put_component_template@200' + /_count: + get: + operationId: count.0 + x-operation-group: count + x-version-added: '1.0' + description: Returns number of documents matching a query. + parameters: + - $ref: '#/components/parameters/count::query.ignore_unavailable' + - $ref: '#/components/parameters/count::query.ignore_throttled' + - $ref: '#/components/parameters/count::query.allow_no_indices' + - $ref: '#/components/parameters/count::query.expand_wildcards' + - $ref: '#/components/parameters/count::query.min_score' + - $ref: '#/components/parameters/count::query.preference' + - $ref: '#/components/parameters/count::query.routing' + - $ref: '#/components/parameters/count::query.q' + - $ref: '#/components/parameters/count::query.analyzer' + - $ref: '#/components/parameters/count::query.analyze_wildcard' + - $ref: '#/components/parameters/count::query.default_operator' + - $ref: '#/components/parameters/count::query.df' + - $ref: '#/components/parameters/count::query.lenient' + - $ref: '#/components/parameters/count::query.terminate_after' + requestBody: + $ref: '#/components/requestBodies/count' + responses: + '200': + $ref: '#/components/responses/count@200' + post: + operationId: count.1 + x-operation-group: count + x-version-added: '1.0' + description: Returns number of documents matching a query. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/count/ + parameters: + - $ref: '#/components/parameters/count::query.ignore_unavailable' + - $ref: '#/components/parameters/count::query.ignore_throttled' + - $ref: '#/components/parameters/count::query.allow_no_indices' + - $ref: '#/components/parameters/count::query.expand_wildcards' + - $ref: '#/components/parameters/count::query.min_score' + - $ref: '#/components/parameters/count::query.preference' + - $ref: '#/components/parameters/count::query.routing' + - $ref: '#/components/parameters/count::query.q' + - $ref: '#/components/parameters/count::query.analyzer' + - $ref: '#/components/parameters/count::query.analyze_wildcard' + - $ref: '#/components/parameters/count::query.default_operator' + - $ref: '#/components/parameters/count::query.df' + - $ref: '#/components/parameters/count::query.lenient' + - $ref: '#/components/parameters/count::query.terminate_after' + requestBody: + $ref: '#/components/requestBodies/count' + responses: + '200': + $ref: '#/components/responses/count@200' + /_dangling: + get: + operationId: dangling_indices.list_dangling_indices.0 + x-operation-group: dangling_indices.list_dangling_indices + x-version-added: '1.0' + description: Returns all dangling indices. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ + parameters: [] + responses: + '200': + $ref: '#/components/responses/dangling_indices.list_dangling_indices@200' + /_dangling/{index_uuid}: + delete: + operationId: dangling_indices.delete_dangling_index.0 + x-operation-group: dangling_indices.delete_dangling_index + x-version-added: '1.0' + description: Deletes the specified dangling index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ + parameters: + - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::path.index_uuid' + - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.accept_data_loss' + - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.timeout' + - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.master_timeout' + - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/dangling_indices.delete_dangling_index@200' + post: + operationId: dangling_indices.import_dangling_index.0 + x-operation-group: dangling_indices.import_dangling_index + x-version-added: '1.0' + description: Imports the specified dangling index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ + parameters: + - $ref: '#/components/parameters/dangling_indices.import_dangling_index::path.index_uuid' + - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.accept_data_loss' + - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.timeout' + - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.master_timeout' + - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/dangling_indices.import_dangling_index@200' + /_data_stream: + get: + operationId: indices.get_data_stream.0 + x-operation-group: indices.get_data_stream + x-version-added: '1.0' + description: Returns data streams. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/data-streams/ + parameters: [] + responses: + '200': + $ref: '#/components/responses/indices.get_data_stream@200' + /_data_stream/_stats: + get: + operationId: indices.data_streams_stats.0 + x-operation-group: indices.data_streams_stats + x-version-added: '1.0' + description: Provides statistics on operations happening in a data stream. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/data-streams/ + parameters: [] + responses: + '200': + $ref: '#/components/responses/indices.data_streams_stats@200' + /_data_stream/{name}: + delete: + operationId: indices.delete_data_stream.0 + x-operation-group: indices.delete_data_stream + x-version-added: '1.0' + description: Deletes a data stream. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/data-streams/ + parameters: + - $ref: '#/components/parameters/indices.delete_data_stream::path.name' + responses: + '200': + $ref: '#/components/responses/indices.delete_data_stream@200' + get: + operationId: indices.get_data_stream.1 + x-operation-group: indices.get_data_stream + x-version-added: '1.0' + description: Returns data streams. + parameters: + - $ref: '#/components/parameters/indices.get_data_stream::path.name' + responses: + '200': + $ref: '#/components/responses/indices.get_data_stream@200' + put: + operationId: indices.create_data_stream.0 + x-operation-group: indices.create_data_stream + x-version-added: '1.0' + description: Creates or updates a data stream. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/data-streams/ + parameters: + - $ref: '#/components/parameters/indices.create_data_stream::path.name' + requestBody: + $ref: '#/components/requestBodies/indices.create_data_stream' + responses: + '200': + $ref: '#/components/responses/indices.create_data_stream@200' + /_data_stream/{name}/_stats: + get: + operationId: indices.data_streams_stats.1 + x-operation-group: indices.data_streams_stats + x-version-added: '1.0' + description: Provides statistics on operations happening in a data stream. + parameters: + - $ref: '#/components/parameters/indices.data_streams_stats::path.name' + responses: + '200': + $ref: '#/components/responses/indices.data_streams_stats@200' + /_delete_by_query/{task_id}/_rethrottle: + post: + operationId: delete_by_query_rethrottle.0 + x-operation-group: delete_by_query_rethrottle + x-version-added: '1.0' + description: Changes the number of requests per second for a particular Delete By Query operation. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/delete_by_query_rethrottle::path.task_id' + - $ref: '#/components/parameters/delete_by_query_rethrottle::query.requests_per_second' + responses: + '200': + $ref: '#/components/responses/delete_by_query_rethrottle@200' + /_field_caps: + get: + operationId: field_caps.0 + x-operation-group: field_caps + x-version-added: '1.0' + description: Returns the information about the capabilities of fields among multiple indices. + externalDocs: + url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations + parameters: + - $ref: '#/components/parameters/field_caps::query.fields' + - $ref: '#/components/parameters/field_caps::query.ignore_unavailable' + - $ref: '#/components/parameters/field_caps::query.allow_no_indices' + - $ref: '#/components/parameters/field_caps::query.expand_wildcards' + - $ref: '#/components/parameters/field_caps::query.include_unmapped' + requestBody: + $ref: '#/components/requestBodies/field_caps' + responses: + '200': + $ref: '#/components/responses/field_caps@200' + post: + operationId: field_caps.1 + x-operation-group: field_caps + x-version-added: '1.0' + description: Returns the information about the capabilities of fields among multiple indices. + parameters: + - $ref: '#/components/parameters/field_caps::query.fields' + - $ref: '#/components/parameters/field_caps::query.ignore_unavailable' + - $ref: '#/components/parameters/field_caps::query.allow_no_indices' + - $ref: '#/components/parameters/field_caps::query.expand_wildcards' + - $ref: '#/components/parameters/field_caps::query.include_unmapped' + requestBody: + $ref: '#/components/requestBodies/field_caps' + responses: + '200': + $ref: '#/components/responses/field_caps@200' + /_flush: + get: + operationId: indices.flush.0 + x-operation-group: indices.flush + x-version-added: '1.0' + description: Performs the flush operation on one or more indices. + parameters: + - $ref: '#/components/parameters/indices.flush::query.force' + - $ref: '#/components/parameters/indices.flush::query.wait_if_ongoing' + - $ref: '#/components/parameters/indices.flush::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.flush::query.allow_no_indices' + - $ref: '#/components/parameters/indices.flush::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.flush@200' + post: + operationId: indices.flush.1 + x-operation-group: indices.flush + x-version-added: '1.0' + description: Performs the flush operation on one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.flush::query.force' + - $ref: '#/components/parameters/indices.flush::query.wait_if_ongoing' + - $ref: '#/components/parameters/indices.flush::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.flush::query.allow_no_indices' + - $ref: '#/components/parameters/indices.flush::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.flush@200' + /_forcemerge: + post: + operationId: indices.forcemerge.0 + x-operation-group: indices.forcemerge + x-version-added: '1.0' + description: Performs the force merge operation on one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.forcemerge::query.flush' + - $ref: '#/components/parameters/indices.forcemerge::query.primary_only' + - $ref: '#/components/parameters/indices.forcemerge::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.forcemerge::query.allow_no_indices' + - $ref: '#/components/parameters/indices.forcemerge::query.expand_wildcards' + - $ref: '#/components/parameters/indices.forcemerge::query.max_num_segments' + - $ref: '#/components/parameters/indices.forcemerge::query.only_expunge_deletes' + - $ref: '#/components/parameters/indices.forcemerge::query.wait_for_completion' + responses: + '200': + $ref: '#/components/responses/indices.forcemerge@200' + /_index_template: + get: + operationId: indices.get_index_template.0 + x-operation-group: indices.get_index_template + x-version-added: '1.0' + description: Returns an index template. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-templates/ + parameters: + - $ref: '#/components/parameters/indices.get_index_template::query.flat_settings' + - $ref: '#/components/parameters/indices.get_index_template::query.master_timeout' + - $ref: '#/components/parameters/indices.get_index_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_index_template::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_index_template@200' + /_index_template/_simulate: + post: + operationId: indices.simulate_template.0 + x-operation-group: indices.simulate_template + x-version-added: '1.0' + description: Simulate resolving the given template name or body. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.simulate_template::query.create' + - $ref: '#/components/parameters/indices.simulate_template::query.cause' + - $ref: '#/components/parameters/indices.simulate_template::query.master_timeout' + - $ref: '#/components/parameters/indices.simulate_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.simulate_template' + responses: + '200': + $ref: '#/components/responses/indices.simulate_template@200' + /_index_template/_simulate/{name}: + post: + operationId: indices.simulate_template.1 + x-operation-group: indices.simulate_template + x-version-added: '1.0' + description: Simulate resolving the given template name or body. + parameters: + - $ref: '#/components/parameters/indices.simulate_template::path.name' + - $ref: '#/components/parameters/indices.simulate_template::query.create' + - $ref: '#/components/parameters/indices.simulate_template::query.cause' + - $ref: '#/components/parameters/indices.simulate_template::query.master_timeout' + - $ref: '#/components/parameters/indices.simulate_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.simulate_template' + responses: + '200': + $ref: '#/components/responses/indices.simulate_template@200' + /_index_template/_simulate_index/{name}: + post: + operationId: indices.simulate_index_template.0 + x-operation-group: indices.simulate_index_template + x-version-added: '1.0' + description: Simulate matching the given index name against the index templates in the system. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.simulate_index_template::path.name' + - $ref: '#/components/parameters/indices.simulate_index_template::query.create' + - $ref: '#/components/parameters/indices.simulate_index_template::query.cause' + - $ref: '#/components/parameters/indices.simulate_index_template::query.master_timeout' + - $ref: '#/components/parameters/indices.simulate_index_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.simulate_index_template' + responses: + '200': + $ref: '#/components/responses/indices.simulate_index_template@200' + /_index_template/{name}: + delete: + operationId: indices.delete_index_template.0 + x-operation-group: indices.delete_index_template + x-version-added: '1.0' + description: Deletes an index template. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-templates/#delete-a-template + parameters: + - $ref: '#/components/parameters/indices.delete_index_template::path.name' + - $ref: '#/components/parameters/indices.delete_index_template::query.timeout' + - $ref: '#/components/parameters/indices.delete_index_template::query.master_timeout' + - $ref: '#/components/parameters/indices.delete_index_template::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/indices.delete_index_template@200' + get: + operationId: indices.get_index_template.1 + x-operation-group: indices.get_index_template + x-version-added: '1.0' + description: Returns an index template. + parameters: + - $ref: '#/components/parameters/indices.get_index_template::path.name' + - $ref: '#/components/parameters/indices.get_index_template::query.flat_settings' + - $ref: '#/components/parameters/indices.get_index_template::query.master_timeout' + - $ref: '#/components/parameters/indices.get_index_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_index_template::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_index_template@200' + head: + operationId: indices.exists_index_template.0 + x-operation-group: indices.exists_index_template + x-version-added: '1.0' + description: Returns information about whether a particular index template exists. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-templates/ + parameters: + - $ref: '#/components/parameters/indices.exists_index_template::path.name' + - $ref: '#/components/parameters/indices.exists_index_template::query.flat_settings' + - $ref: '#/components/parameters/indices.exists_index_template::query.master_timeout' + - $ref: '#/components/parameters/indices.exists_index_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.exists_index_template::query.local' + responses: + '200': + $ref: '#/components/responses/indices.exists_index_template@200' + post: + operationId: indices.put_index_template.0 + x-operation-group: indices.put_index_template + x-version-added: '1.0' + description: Creates or updates an index template. + parameters: + - $ref: '#/components/parameters/indices.put_index_template::path.name' + - $ref: '#/components/parameters/indices.put_index_template::query.create' + - $ref: '#/components/parameters/indices.put_index_template::query.cause' + - $ref: '#/components/parameters/indices.put_index_template::query.master_timeout' + - $ref: '#/components/parameters/indices.put_index_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.put_index_template' + responses: + '200': + $ref: '#/components/responses/indices.put_index_template@200' + put: + operationId: indices.put_index_template.1 + x-operation-group: indices.put_index_template + x-version-added: '1.0' + description: Creates or updates an index template. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-templates/ + parameters: + - $ref: '#/components/parameters/indices.put_index_template::path.name' + - $ref: '#/components/parameters/indices.put_index_template::query.create' + - $ref: '#/components/parameters/indices.put_index_template::query.cause' + - $ref: '#/components/parameters/indices.put_index_template::query.master_timeout' + - $ref: '#/components/parameters/indices.put_index_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.put_index_template' + responses: + '200': + $ref: '#/components/responses/indices.put_index_template@200' + /_ingest/pipeline: + get: + operationId: ingest.get_pipeline.0 + x-operation-group: ingest.get_pipeline + x-version-added: '1.0' + description: Returns a pipeline. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/ + parameters: + - $ref: '#/components/parameters/ingest.get_pipeline::query.master_timeout' + - $ref: '#/components/parameters/ingest.get_pipeline::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/ingest.get_pipeline@200' + /_ingest/pipeline/_simulate: + get: + operationId: ingest.simulate.0 + x-operation-group: ingest.simulate + x-version-added: '1.0' + description: Allows to simulate a pipeline with example documents. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ + parameters: + - $ref: '#/components/parameters/ingest.simulate::query.verbose' + requestBody: + $ref: '#/components/requestBodies/ingest.simulate' + responses: + '200': + $ref: '#/components/responses/ingest.simulate@200' + post: + operationId: ingest.simulate.1 + x-operation-group: ingest.simulate + x-version-added: '1.0' + description: Allows to simulate a pipeline with example documents. + parameters: + - $ref: '#/components/parameters/ingest.simulate::query.verbose' + requestBody: + $ref: '#/components/requestBodies/ingest.simulate' + responses: + '200': + $ref: '#/components/responses/ingest.simulate@200' + /_ingest/pipeline/{id}: + delete: + operationId: ingest.delete_pipeline.0 + x-operation-group: ingest.delete_pipeline + x-version-added: '1.0' + description: Deletes a pipeline. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/ + parameters: + - $ref: '#/components/parameters/ingest.delete_pipeline::path.id' + - $ref: '#/components/parameters/ingest.delete_pipeline::query.master_timeout' + - $ref: '#/components/parameters/ingest.delete_pipeline::query.cluster_manager_timeout' + - $ref: '#/components/parameters/ingest.delete_pipeline::query.timeout' + responses: + '200': + $ref: '#/components/responses/ingest.delete_pipeline@200' + get: + operationId: ingest.get_pipeline.1 + x-operation-group: ingest.get_pipeline + x-version-added: '1.0' + description: Returns a pipeline. + parameters: + - $ref: '#/components/parameters/ingest.get_pipeline::path.id' + - $ref: '#/components/parameters/ingest.get_pipeline::query.master_timeout' + - $ref: '#/components/parameters/ingest.get_pipeline::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/ingest.get_pipeline@200' + put: + operationId: ingest.put_pipeline.0 + x-operation-group: ingest.put_pipeline + x-version-added: '1.0' + description: Creates or updates a pipeline. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/ + parameters: + - $ref: '#/components/parameters/ingest.put_pipeline::path.id' + - $ref: '#/components/parameters/ingest.put_pipeline::query.master_timeout' + - $ref: '#/components/parameters/ingest.put_pipeline::query.cluster_manager_timeout' + - $ref: '#/components/parameters/ingest.put_pipeline::query.timeout' + requestBody: + $ref: '#/components/requestBodies/ingest.put_pipeline' + responses: + '200': + $ref: '#/components/responses/ingest.put_pipeline@200' + /_ingest/pipeline/{id}/_simulate: + get: + operationId: ingest.simulate.2 + x-operation-group: ingest.simulate + x-version-added: '1.0' + description: Allows to simulate a pipeline with example documents. + parameters: + - $ref: '#/components/parameters/ingest.simulate::path.id' + - $ref: '#/components/parameters/ingest.simulate::query.verbose' + requestBody: + $ref: '#/components/requestBodies/ingest.simulate' + responses: + '200': + $ref: '#/components/responses/ingest.simulate@200' + post: + operationId: ingest.simulate.3 + x-operation-group: ingest.simulate + x-version-added: '1.0' + description: Allows to simulate a pipeline with example documents. + parameters: + - $ref: '#/components/parameters/ingest.simulate::path.id' + - $ref: '#/components/parameters/ingest.simulate::query.verbose' + requestBody: + $ref: '#/components/requestBodies/ingest.simulate' + responses: + '200': + $ref: '#/components/responses/ingest.simulate@200' + /_ingest/processor/grok: + get: + operationId: ingest.processor_grok.0 + x-operation-group: ingest.processor_grok + x-version-added: '1.0' + description: Returns a list of the built-in patterns. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: [] + responses: + '200': + $ref: '#/components/responses/ingest.processor_grok@200' + /_mapping: + get: + operationId: indices.get_mapping.0 + x-operation-group: indices.get_mapping + x-version-added: '1.0' + description: Returns mappings for one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest/field-types/index/#get-a-mapping + parameters: + - $ref: '#/components/parameters/indices.get_mapping::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_mapping::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_mapping::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_mapping::query.master_timeout' + - $ref: '#/components/parameters/indices.get_mapping::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_mapping::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_mapping@200' + /_mapping/field/{fields}: + get: + operationId: indices.get_field_mapping.0 + x-operation-group: indices.get_field_mapping + x-version-added: '1.0' + description: Returns mapping for one or more fields. + externalDocs: + url: https://opensearch.org/docs/latest/field-types/index/ + parameters: + - $ref: '#/components/parameters/indices.get_field_mapping::path.fields' + - $ref: '#/components/parameters/indices.get_field_mapping::query.include_defaults' + - $ref: '#/components/parameters/indices.get_field_mapping::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_field_mapping::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_field_mapping::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_field_mapping::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_field_mapping@200' + /_mget: + get: + operationId: mget.0 + x-operation-group: mget + x-version-added: '1.0' + description: Allows to get multiple documents in one request. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/ + parameters: + - $ref: '#/components/parameters/mget::query.stored_fields' + - $ref: '#/components/parameters/mget::query.preference' + - $ref: '#/components/parameters/mget::query.realtime' + - $ref: '#/components/parameters/mget::query.refresh' + - $ref: '#/components/parameters/mget::query.routing' + - $ref: '#/components/parameters/mget::query._source' + - $ref: '#/components/parameters/mget::query._source_excludes' + - $ref: '#/components/parameters/mget::query._source_includes' + requestBody: + $ref: '#/components/requestBodies/mget' + responses: + '200': + $ref: '#/components/responses/mget@200' + post: + operationId: mget.1 + x-operation-group: mget + x-version-added: '1.0' + description: Allows to get multiple documents in one request. + parameters: + - $ref: '#/components/parameters/mget::query.stored_fields' + - $ref: '#/components/parameters/mget::query.preference' + - $ref: '#/components/parameters/mget::query.realtime' + - $ref: '#/components/parameters/mget::query.refresh' + - $ref: '#/components/parameters/mget::query.routing' + - $ref: '#/components/parameters/mget::query._source' + - $ref: '#/components/parameters/mget::query._source_excludes' + - $ref: '#/components/parameters/mget::query._source_includes' + requestBody: + $ref: '#/components/requestBodies/mget' + responses: + '200': + $ref: '#/components/responses/mget@200' + /_msearch: + get: + operationId: msearch.0 + x-operation-group: msearch + x-version-added: '1.0' + description: Allows to execute several search operations in one request. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/multi-search/ + parameters: + - $ref: '#/components/parameters/msearch::query.search_type' + - $ref: '#/components/parameters/msearch::query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch::query.typed_keys' + - $ref: '#/components/parameters/msearch::query.pre_filter_shard_size' + - $ref: '#/components/parameters/msearch::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/msearch::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/msearch' + responses: + '200': + $ref: '#/components/responses/msearch@200' + post: + operationId: msearch.1 + x-operation-group: msearch + x-version-added: '1.0' + description: Allows to execute several search operations in one request. + parameters: + - $ref: '#/components/parameters/msearch::query.search_type' + - $ref: '#/components/parameters/msearch::query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch::query.typed_keys' + - $ref: '#/components/parameters/msearch::query.pre_filter_shard_size' + - $ref: '#/components/parameters/msearch::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/msearch::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/msearch' + responses: + '200': + $ref: '#/components/responses/msearch@200' + /_msearch/template: + get: + operationId: msearch_template.0 + x-operation-group: msearch_template + x-version-added: '1.0' + description: Allows to execute several search template operations in one request. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/search-template/ + parameters: + - $ref: '#/components/parameters/msearch_template::query.search_type' + - $ref: '#/components/parameters/msearch_template::query.typed_keys' + - $ref: '#/components/parameters/msearch_template::query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch_template::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch_template::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/msearch_template' + responses: + '200': + $ref: '#/components/responses/msearch_template@200' + post: + operationId: msearch_template.1 + x-operation-group: msearch_template + x-version-added: '1.0' + description: Allows to execute several search template operations in one request. + parameters: + - $ref: '#/components/parameters/msearch_template::query.search_type' + - $ref: '#/components/parameters/msearch_template::query.typed_keys' + - $ref: '#/components/parameters/msearch_template::query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch_template::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch_template::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/msearch_template' + responses: + '200': + $ref: '#/components/responses/msearch_template@200' + /_mtermvectors: + get: + operationId: mtermvectors.0 + x-operation-group: mtermvectors + x-version-added: '1.0' + description: Returns multiple termvectors in one request. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/mtermvectors::query.ids' + - $ref: '#/components/parameters/mtermvectors::query.term_statistics' + - $ref: '#/components/parameters/mtermvectors::query.field_statistics' + - $ref: '#/components/parameters/mtermvectors::query.fields' + - $ref: '#/components/parameters/mtermvectors::query.offsets' + - $ref: '#/components/parameters/mtermvectors::query.positions' + - $ref: '#/components/parameters/mtermvectors::query.payloads' + - $ref: '#/components/parameters/mtermvectors::query.preference' + - $ref: '#/components/parameters/mtermvectors::query.routing' + - $ref: '#/components/parameters/mtermvectors::query.realtime' + - $ref: '#/components/parameters/mtermvectors::query.version' + - $ref: '#/components/parameters/mtermvectors::query.version_type' + requestBody: + $ref: '#/components/requestBodies/mtermvectors' + responses: + '200': + $ref: '#/components/responses/mtermvectors@200' + post: + operationId: mtermvectors.1 + x-operation-group: mtermvectors + x-version-added: '1.0' + description: Returns multiple termvectors in one request. + parameters: + - $ref: '#/components/parameters/mtermvectors::query.ids' + - $ref: '#/components/parameters/mtermvectors::query.term_statistics' + - $ref: '#/components/parameters/mtermvectors::query.field_statistics' + - $ref: '#/components/parameters/mtermvectors::query.fields' + - $ref: '#/components/parameters/mtermvectors::query.offsets' + - $ref: '#/components/parameters/mtermvectors::query.positions' + - $ref: '#/components/parameters/mtermvectors::query.payloads' + - $ref: '#/components/parameters/mtermvectors::query.preference' + - $ref: '#/components/parameters/mtermvectors::query.routing' + - $ref: '#/components/parameters/mtermvectors::query.realtime' + - $ref: '#/components/parameters/mtermvectors::query.version' + - $ref: '#/components/parameters/mtermvectors::query.version_type' + requestBody: + $ref: '#/components/requestBodies/mtermvectors' + responses: + '200': + $ref: '#/components/responses/mtermvectors@200' + /_nodes: + get: + operationId: nodes.info.0 + x-operation-group: nodes.info + x-version-added: '1.0' + description: Returns information about nodes in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/ + parameters: + - $ref: '#/components/parameters/nodes.info::query.flat_settings' + - $ref: '#/components/parameters/nodes.info::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.info@200' + /_nodes/hot_threads: + get: + operationId: nodes.hot_threads.4 + x-operation-group: nodes.hot_threads + x-version-added: '1.0' + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_nodes/hotthreads: + get: + operationId: nodes.hot_threads.5 + x-operation-group: nodes.hot_threads + x-ignorable: true + deprecated: true + x-deprecation-message: The hot threads API accepts `hotthreads` but only `hot_threads` is documented + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_nodes/reload_secure_settings: + post: + operationId: nodes.reload_secure_settings.0 + x-operation-group: nodes.reload_secure_settings + x-version-added: '1.0' + description: Reloads secure settings. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/ + parameters: + - $ref: '#/components/parameters/nodes.reload_secure_settings::query.timeout' + requestBody: + $ref: '#/components/requestBodies/nodes.reload_secure_settings' + responses: + '200': + $ref: '#/components/responses/nodes.reload_secure_settings@200' + /_nodes/stats: + get: + operationId: nodes.stats.0 + x-operation-group: nodes.stats + x-version-added: '1.0' + description: Returns statistical information about nodes in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ + parameters: + - $ref: '#/components/parameters/nodes.stats::query.completion_fields' + - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats::query.fields' + - $ref: '#/components/parameters/nodes.stats::query.groups' + - $ref: '#/components/parameters/nodes.stats::query.level' + - $ref: '#/components/parameters/nodes.stats::query.types' + - $ref: '#/components/parameters/nodes.stats::query.timeout' + - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + responses: + '200': + $ref: '#/components/responses/nodes.stats@200' + /_nodes/stats/{metric}: + get: + operationId: nodes.stats.1 + x-operation-group: nodes.stats + x-version-added: '1.0' + description: Returns statistical information about nodes in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.stats::path.metric' + - $ref: '#/components/parameters/nodes.stats::query.completion_fields' + - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats::query.fields' + - $ref: '#/components/parameters/nodes.stats::query.groups' + - $ref: '#/components/parameters/nodes.stats::query.level' + - $ref: '#/components/parameters/nodes.stats::query.types' + - $ref: '#/components/parameters/nodes.stats::query.timeout' + - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + responses: + '200': + $ref: '#/components/responses/nodes.stats@200' + /_nodes/stats/{metric}/{index_metric}: + get: + operationId: nodes.stats.2 + x-operation-group: nodes.stats + x-version-added: '1.0' + description: Returns statistical information about nodes in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.stats::path.metric' + - $ref: '#/components/parameters/nodes.stats::path.index_metric' + - $ref: '#/components/parameters/nodes.stats::query.completion_fields' + - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats::query.fields' + - $ref: '#/components/parameters/nodes.stats::query.groups' + - $ref: '#/components/parameters/nodes.stats::query.level' + - $ref: '#/components/parameters/nodes.stats::query.types' + - $ref: '#/components/parameters/nodes.stats::query.timeout' + - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + responses: + '200': + $ref: '#/components/responses/nodes.stats@200' + /_nodes/usage: + get: + operationId: nodes.usage.0 + x-operation-group: nodes.usage + x-version-added: '1.0' + description: Returns low-level information about REST actions usage on nodes. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/nodes.usage::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.usage@200' + /_nodes/usage/{metric}: + get: + operationId: nodes.usage.1 + x-operation-group: nodes.usage + x-version-added: '1.0' + description: Returns low-level information about REST actions usage on nodes. + parameters: + - $ref: '#/components/parameters/nodes.usage::path.metric' + - $ref: '#/components/parameters/nodes.usage::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.usage@200' + /_nodes/{node_id}: + get: + operationId: nodes.info.1 + x-operation-group: nodes.info + x-version-added: '1.0' + description: Returns information about nodes in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.info::path.node_id' + - $ref: '#/components/parameters/nodes.info::query.flat_settings' + - $ref: '#/components/parameters/nodes.info::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.info@200' + /_nodes/{node_id}/hot_threads: + get: + operationId: nodes.hot_threads.6 + x-operation-group: nodes.hot_threads + x-version-added: '1.0' + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_nodes/{node_id}/hotthreads: + get: + operationId: nodes.hot_threads.7 + x-operation-group: nodes.hot_threads + x-ignorable: true + deprecated: true + x-deprecation-message: The hot threads API accepts `hotthreads` but only `hot_threads` is documented + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_nodes/{node_id}/reload_secure_settings: + post: + operationId: nodes.reload_secure_settings.1 + x-operation-group: nodes.reload_secure_settings + x-version-added: '1.0' + description: Reloads secure settings. + parameters: + - $ref: '#/components/parameters/nodes.reload_secure_settings::path.node_id' + - $ref: '#/components/parameters/nodes.reload_secure_settings::query.timeout' + requestBody: + $ref: '#/components/requestBodies/nodes.reload_secure_settings' + responses: + '200': + $ref: '#/components/responses/nodes.reload_secure_settings@200' + /_nodes/{node_id}/stats: + get: + operationId: nodes.stats.3 + x-operation-group: nodes.stats + x-version-added: '1.0' + description: Returns statistical information about nodes in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.stats::path.node_id' + - $ref: '#/components/parameters/nodes.stats::query.completion_fields' + - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats::query.fields' + - $ref: '#/components/parameters/nodes.stats::query.groups' + - $ref: '#/components/parameters/nodes.stats::query.level' + - $ref: '#/components/parameters/nodes.stats::query.types' + - $ref: '#/components/parameters/nodes.stats::query.timeout' + - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + responses: + '200': + $ref: '#/components/responses/nodes.stats@200' + /_nodes/{node_id}/stats/{metric}: + get: + operationId: nodes.stats.4 + x-operation-group: nodes.stats + x-version-added: '1.0' + description: Returns statistical information about nodes in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.stats::path.metric' + - $ref: '#/components/parameters/nodes.stats::path.node_id' + - $ref: '#/components/parameters/nodes.stats::query.completion_fields' + - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats::query.fields' + - $ref: '#/components/parameters/nodes.stats::query.groups' + - $ref: '#/components/parameters/nodes.stats::query.level' + - $ref: '#/components/parameters/nodes.stats::query.types' + - $ref: '#/components/parameters/nodes.stats::query.timeout' + - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + responses: + '200': + $ref: '#/components/responses/nodes.stats@200' + /_nodes/{node_id}/stats/{metric}/{index_metric}: + get: + operationId: nodes.stats.5 + x-operation-group: nodes.stats + x-version-added: '1.0' + description: Returns statistical information about nodes in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.stats::path.metric' + - $ref: '#/components/parameters/nodes.stats::path.index_metric' + - $ref: '#/components/parameters/nodes.stats::path.node_id' + - $ref: '#/components/parameters/nodes.stats::query.completion_fields' + - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats::query.fields' + - $ref: '#/components/parameters/nodes.stats::query.groups' + - $ref: '#/components/parameters/nodes.stats::query.level' + - $ref: '#/components/parameters/nodes.stats::query.types' + - $ref: '#/components/parameters/nodes.stats::query.timeout' + - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + responses: + '200': + $ref: '#/components/responses/nodes.stats@200' + /_nodes/{node_id}/usage: + get: + operationId: nodes.usage.2 + x-operation-group: nodes.usage + x-version-added: '1.0' + description: Returns low-level information about REST actions usage on nodes. + parameters: + - $ref: '#/components/parameters/nodes.usage::path.node_id' + - $ref: '#/components/parameters/nodes.usage::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.usage@200' + /_nodes/{node_id}/usage/{metric}: + get: + operationId: nodes.usage.3 + x-operation-group: nodes.usage + x-version-added: '1.0' + description: Returns low-level information about REST actions usage on nodes. + parameters: + - $ref: '#/components/parameters/nodes.usage::path.metric' + - $ref: '#/components/parameters/nodes.usage::path.node_id' + - $ref: '#/components/parameters/nodes.usage::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.usage@200' + /_nodes/{node_id}/{metric}: + get: + operationId: nodes.info.2 + x-operation-group: nodes.info + x-version-added: '1.0' + description: Returns information about nodes in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.info::path.node_id' + - $ref: '#/components/parameters/nodes.info::path.metric' + - $ref: '#/components/parameters/nodes.info::query.flat_settings' + - $ref: '#/components/parameters/nodes.info::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.info@200' + /_plugins/_knn/models/_search: + get: + operationId: knn.search_models.0 + x-operation-group: knn.search_models + x-version-added: '1.0' + description: Use an OpenSearch query to search for models in the index. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/knn/api/#search-model + parameters: + - $ref: '#/components/parameters/knn.search_models::query.analyzer' + - $ref: '#/components/parameters/knn.search_models::query.analyze_wildcard' + - $ref: '#/components/parameters/knn.search_models::query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/knn.search_models::query.default_operator' + - $ref: '#/components/parameters/knn.search_models::query.df' + - $ref: '#/components/parameters/knn.search_models::query.explain' + - $ref: '#/components/parameters/knn.search_models::query.stored_fields' + - $ref: '#/components/parameters/knn.search_models::query.docvalue_fields' + - $ref: '#/components/parameters/knn.search_models::query.from' + - $ref: '#/components/parameters/knn.search_models::query.ignore_unavailable' + - $ref: '#/components/parameters/knn.search_models::query.ignore_throttled' + - $ref: '#/components/parameters/knn.search_models::query.allow_no_indices' + - $ref: '#/components/parameters/knn.search_models::query.expand_wildcards' + - $ref: '#/components/parameters/knn.search_models::query.lenient' + - $ref: '#/components/parameters/knn.search_models::query.preference' + - $ref: '#/components/parameters/knn.search_models::query.q' + - $ref: '#/components/parameters/knn.search_models::query.routing' + - $ref: '#/components/parameters/knn.search_models::query.scroll' + - $ref: '#/components/parameters/knn.search_models::query.search_type' + - $ref: '#/components/parameters/knn.search_models::query.size' + - $ref: '#/components/parameters/knn.search_models::query.sort' + - $ref: '#/components/parameters/knn.search_models::query._source' + - $ref: '#/components/parameters/knn.search_models::query._source_excludes' + - $ref: '#/components/parameters/knn.search_models::query._source_includes' + - $ref: '#/components/parameters/knn.search_models::query.terminate_after' + - $ref: '#/components/parameters/knn.search_models::query.stats' + - $ref: '#/components/parameters/knn.search_models::query.suggest_field' + - $ref: '#/components/parameters/knn.search_models::query.suggest_mode' + - $ref: '#/components/parameters/knn.search_models::query.suggest_size' + - $ref: '#/components/parameters/knn.search_models::query.suggest_text' + - $ref: '#/components/parameters/knn.search_models::query.timeout' + - $ref: '#/components/parameters/knn.search_models::query.track_scores' + - $ref: '#/components/parameters/knn.search_models::query.track_total_hits' + - $ref: '#/components/parameters/knn.search_models::query.allow_partial_search_results' + - $ref: '#/components/parameters/knn.search_models::query.typed_keys' + - $ref: '#/components/parameters/knn.search_models::query.version' + - $ref: '#/components/parameters/knn.search_models::query.seq_no_primary_term' + - $ref: '#/components/parameters/knn.search_models::query.request_cache' + - $ref: '#/components/parameters/knn.search_models::query.batched_reduce_size' + - $ref: '#/components/parameters/knn.search_models::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/knn.search_models::query.pre_filter_shard_size' + - $ref: '#/components/parameters/knn.search_models::query.rest_total_hits_as_int' + responses: + '200': + $ref: '#/components/responses/knn.search_models@200' + post: + operationId: knn.search_models.1 + x-operation-group: knn.search_models + x-version-added: '1.0' + description: Use an OpenSearch query to search for models in the index. + parameters: + - $ref: '#/components/parameters/knn.search_models::query.analyzer' + - $ref: '#/components/parameters/knn.search_models::query.analyze_wildcard' + - $ref: '#/components/parameters/knn.search_models::query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/knn.search_models::query.default_operator' + - $ref: '#/components/parameters/knn.search_models::query.df' + - $ref: '#/components/parameters/knn.search_models::query.explain' + - $ref: '#/components/parameters/knn.search_models::query.stored_fields' + - $ref: '#/components/parameters/knn.search_models::query.docvalue_fields' + - $ref: '#/components/parameters/knn.search_models::query.from' + - $ref: '#/components/parameters/knn.search_models::query.ignore_unavailable' + - $ref: '#/components/parameters/knn.search_models::query.ignore_throttled' + - $ref: '#/components/parameters/knn.search_models::query.allow_no_indices' + - $ref: '#/components/parameters/knn.search_models::query.expand_wildcards' + - $ref: '#/components/parameters/knn.search_models::query.lenient' + - $ref: '#/components/parameters/knn.search_models::query.preference' + - $ref: '#/components/parameters/knn.search_models::query.q' + - $ref: '#/components/parameters/knn.search_models::query.routing' + - $ref: '#/components/parameters/knn.search_models::query.scroll' + - $ref: '#/components/parameters/knn.search_models::query.search_type' + - $ref: '#/components/parameters/knn.search_models::query.size' + - $ref: '#/components/parameters/knn.search_models::query.sort' + - $ref: '#/components/parameters/knn.search_models::query._source' + - $ref: '#/components/parameters/knn.search_models::query._source_excludes' + - $ref: '#/components/parameters/knn.search_models::query._source_includes' + - $ref: '#/components/parameters/knn.search_models::query.terminate_after' + - $ref: '#/components/parameters/knn.search_models::query.stats' + - $ref: '#/components/parameters/knn.search_models::query.suggest_field' + - $ref: '#/components/parameters/knn.search_models::query.suggest_mode' + - $ref: '#/components/parameters/knn.search_models::query.suggest_size' + - $ref: '#/components/parameters/knn.search_models::query.suggest_text' + - $ref: '#/components/parameters/knn.search_models::query.timeout' + - $ref: '#/components/parameters/knn.search_models::query.track_scores' + - $ref: '#/components/parameters/knn.search_models::query.track_total_hits' + - $ref: '#/components/parameters/knn.search_models::query.allow_partial_search_results' + - $ref: '#/components/parameters/knn.search_models::query.typed_keys' + - $ref: '#/components/parameters/knn.search_models::query.version' + - $ref: '#/components/parameters/knn.search_models::query.seq_no_primary_term' + - $ref: '#/components/parameters/knn.search_models::query.request_cache' + - $ref: '#/components/parameters/knn.search_models::query.batched_reduce_size' + - $ref: '#/components/parameters/knn.search_models::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/knn.search_models::query.pre_filter_shard_size' + - $ref: '#/components/parameters/knn.search_models::query.rest_total_hits_as_int' + requestBody: + $ref: '#/components/requestBodies/knn.search_models' + responses: + '200': + $ref: '#/components/responses/knn.search_models@200' + /_plugins/_knn/models/_train: + post: + operationId: knn.train_model.0 + x-operation-group: knn.train_model + x-version-added: '1.0' + description: Create and train a model that can be used for initializing k-NN native library indexes during indexing. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/knn/api/#train-model + parameters: + - $ref: '#/components/parameters/knn.train_model::query.preference' + requestBody: + $ref: '#/components/requestBodies/knn.train_model' + responses: + '200': + $ref: '#/components/responses/knn.train_model@200' + /_plugins/_knn/models/{model_id}: + delete: + operationId: knn.delete_model.0 + x-operation-group: knn.delete_model + x-version-added: '1.0' + description: Used to delete a particular model in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/knn/api/#delete-model + parameters: + - $ref: '#/components/parameters/knn.delete_model::path.model_id' + responses: + '200': + $ref: '#/components/responses/knn.delete_model@200' + get: + operationId: knn.get_model.0 + x-operation-group: knn.get_model + x-version-added: '1.0' + description: Used to retrieve information about models present in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/knn/api/#get-model + parameters: + - $ref: '#/components/parameters/knn.get_model::path.model_id' + responses: + '200': + $ref: '#/components/responses/knn.get_model@200' + /_plugins/_knn/models/{model_id}/_train: + post: + operationId: knn.train_model.1 + x-operation-group: knn.train_model + x-version-added: '1.0' + description: Create and train a model that can be used for initializing k-NN native library indexes during indexing. + parameters: + - $ref: '#/components/parameters/knn.train_model::path.model_id' + - $ref: '#/components/parameters/knn.train_model::query.preference' + requestBody: + $ref: '#/components/requestBodies/knn.train_model' + responses: + '200': + $ref: '#/components/responses/knn.train_model@200' + /_plugins/_knn/stats: + get: + operationId: knn.stats.0 + x-operation-group: knn.stats + x-version-added: '1.0' + description: Provides information about the current status of the k-NN plugin. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/knn/api/#stats + parameters: + - $ref: '#/components/parameters/knn.stats::query.timeout' + responses: + '200': + $ref: '#/components/responses/knn.stats@200' + /_plugins/_knn/stats/{stat}: + get: + operationId: knn.stats.1 + x-operation-group: knn.stats + x-version-added: '1.0' + description: Provides information about the current status of the k-NN plugin. + parameters: + - $ref: '#/components/parameters/knn.stats::path.stat' + - $ref: '#/components/parameters/knn.stats::query.timeout' + responses: + '200': + $ref: '#/components/responses/knn.stats@200' + /_plugins/_knn/warmup/{index}: + get: + operationId: knn.warmup.0 + x-operation-group: knn.warmup + x-version-added: '1.0' + description: Preloads native library files into memory, reducing initial search latency for specified indexes + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/knn/api/#warmup-operation + parameters: + - $ref: '#/components/parameters/knn.warmup::path.index' + responses: + '200': + $ref: '#/components/responses/knn.warmup@200' + /_plugins/_knn/{node_id}/stats: + get: + operationId: knn.stats.2 + x-operation-group: knn.stats + x-version-added: '1.0' + description: Provides information about the current status of the k-NN plugin. + parameters: + - $ref: '#/components/parameters/knn.stats::path.node_id' + - $ref: '#/components/parameters/knn.stats::query.timeout' + responses: + '200': + $ref: '#/components/responses/knn.stats@200' + /_plugins/_knn/{node_id}/stats/{stat}: + get: + operationId: knn.stats.3 + x-operation-group: knn.stats + x-version-added: '1.0' + description: Provides information about the current status of the k-NN plugin. + parameters: + - $ref: '#/components/parameters/knn.stats::path.node_id' + - $ref: '#/components/parameters/knn.stats::path.stat' + - $ref: '#/components/parameters/knn.stats::query.timeout' + responses: + '200': + $ref: '#/components/responses/knn.stats@200' + /_plugins/_notifications/configs: + delete: + operationId: notifications.delete_config.0 + x-operation-group: notifications.delete_config + x-version-added: '2.2' + description: Delete channel configuration. + parameters: + - $ref: '#/components/parameters/notifications.delete_config::query.config_id' + - $ref: '#/components/parameters/notifications.delete_config::query.config_id_list' + responses: + '200': + $ref: '#/components/responses/notifications.delete_config@200' + get: + operationId: notifications.get_config.0 + x-operation-group: notifications.get_config + x-version-added: '2.0' + description: Get channel configuration. + externalDocs: + url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#get-channel-configuration + parameters: + - $ref: '#/components/parameters/notifications.get_config::query.last_updated_time_ms' + - $ref: '#/components/parameters/notifications.get_config::query.created_time_ms' + - $ref: '#/components/parameters/notifications.get_config::query.config_type' + - $ref: '#/components/parameters/notifications.get_config::query.email.email_account_id' + - $ref: '#/components/parameters/notifications.get_config::query.email.email_group_id_list' + - $ref: '#/components/parameters/notifications.get_config::query.smtp_account.method' + - $ref: '#/components/parameters/notifications.get_config::query.ses_account.region' + - $ref: '#/components/parameters/notifications.get_config::query.name' + - $ref: '#/components/parameters/notifications.get_config::query.name.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.description' + - $ref: '#/components/parameters/notifications.get_config::query.description.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.slack.url' + - $ref: '#/components/parameters/notifications.get_config::query.slack.url.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.chime.url' + - $ref: '#/components/parameters/notifications.get_config::query.chime.url.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.microsoft_teams.url' + - $ref: '#/components/parameters/notifications.get_config::query.microsoft_teams.url.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.webhook.url' + - $ref: '#/components/parameters/notifications.get_config::query.webhook.url.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.smtp_account.host' + - $ref: '#/components/parameters/notifications.get_config::query.smtp_account.host.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.smtp_account.from_address' + - $ref: '#/components/parameters/notifications.get_config::query.smtp_account.from_address.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.sns.topic_arn' + - $ref: '#/components/parameters/notifications.get_config::query.sns.topic_arn.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.sns.role_arn' + - $ref: '#/components/parameters/notifications.get_config::query.sns.role_arn.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.ses_account.role_arn' + - $ref: '#/components/parameters/notifications.get_config::query.ses_account.role_arn.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.ses_account.from_address' + - $ref: '#/components/parameters/notifications.get_config::query.ses_account.from_address.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.is_enabled' + - $ref: '#/components/parameters/notifications.get_config::query.email.recipient_list.recipient' + - $ref: '#/components/parameters/notifications.get_config::query.email.recipient_list.recipient.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.email_group.recipient_list.recipient' + - $ref: '#/components/parameters/notifications.get_config::query.email_group.recipient_list.recipient.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.query' + - $ref: '#/components/parameters/notifications.get_config::query.text_query' + requestBody: + $ref: '#/components/requestBodies/notifications.get_config' + responses: + '200': + $ref: '#/components/responses/notifications.get_config@200' + post: + operationId: notifications.create_config.0 + x-operation-group: notifications.create_config + x-version-added: '2.0' + description: Create channel configuration. + externalDocs: + url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#create-channel-configuration + requestBody: + $ref: '#/components/requestBodies/notifications.create_config' + responses: + '200': + $ref: '#/components/responses/notifications.create_config@200' + /_plugins/_notifications/configs/{config_id}: + delete: + operationId: notifications.delete_config.1 + x-operation-group: notifications.delete_config + x-version-added: '2.0' + description: Delete channel configuration. + externalDocs: + url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#delete-channel-configuration + parameters: + - $ref: '#/components/parameters/notifications.delete_config::path.config_id' + responses: + '200': + $ref: '#/components/responses/notifications.delete_config@200' + get: + operationId: notifications.get_config.1 + x-operation-group: notifications.get_config + x-version-added: '2.0' + description: Get channel configuration. + parameters: + - $ref: '#/components/parameters/notifications.get_config::path.config_id' + responses: + '200': + $ref: '#/components/responses/notifications.get_config@200' + put: + operationId: notifications.update_config.0 + x-operation-group: notifications.update_config + x-version-added: '2.0' + description: Update channel configuration. + externalDocs: + url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#update-channel-configuration + parameters: + - $ref: '#/components/parameters/notifications.update_config::path.config_id' + requestBody: + $ref: '#/components/requestBodies/notifications.update_config' + responses: + '200': + $ref: '#/components/responses/notifications.update_config@200' + /_plugins/_notifications/feature/test/{config_id}: + get: + operationId: notifications.send_test.0 + x-operation-group: notifications.send_test + deprecated: true + x-deprecation-message: Use the POST method instead. + x-version-added: '2.0' + x-version-deprecated: '2.3' + description: Send a test notification. + externalDocs: + url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#send-test-notification + parameters: + - $ref: '#/components/parameters/notifications.send_test::path.config_id' + responses: + '200': + $ref: '#/components/responses/notifications.send_test@200' + post: + operationId: notifications.send_test.1 + x-operation-group: notifications.send_test + x-version-added: '2.0' + description: Send a test notification. + parameters: + - $ref: '#/components/parameters/notifications.send_test::path.config_id' + responses: + '200': + $ref: '#/components/responses/notifications.send_test@200' + /_plugins/_notifications/features: + get: + operationId: notifications.list_features.0 + x-operation-group: notifications.list_features + x-version-added: '2.0' + description: List supported channel configurations. + externalDocs: + url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-supported-channel-configurations + responses: + '200': + $ref: '#/components/responses/notifications.list_features@200' + /_plugins/_security/api/account: + get: + operationId: security.get_account_details.0 + x-operation-group: security.get_account_details + x-version-added: '1.0' + description: Returns account details for the current user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-account-details + responses: + '200': + $ref: '#/components/responses/security.get_account_details@200' + put: + operationId: security.change_password.0 + x-operation-group: security.change_password + x-version-added: '1.0' + description: Changes the password for the current user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#change-password + requestBody: + $ref: '#/components/requestBodies/security.change_password' + responses: + '200': + $ref: '#/components/responses/security.change_password@200' + /_plugins/_security/api/actiongroups: + get: + operationId: security.get_action_groups.0 + x-operation-group: security.get_action_groups + x-version-added: '1.0' + description: Retrieves all action groups. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-action-groups + responses: + '200': + $ref: '#/components/responses/security.get_action_groups@200' + patch: + operationId: security.patch_action_groups.0 + x-operation-group: security.patch_action_groups + x-version-added: '1.0' + description: Creates, updates, or deletes multiple action groups in a single call. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-action-groups + requestBody: + $ref: '#/components/requestBodies/security.patch_action_groups' + responses: + '200': + $ref: '#/components/responses/security.patch_action_groups@200' + /_plugins/_security/api/actiongroups/{action_group}: + delete: + operationId: security.delete_action_group.0 + x-operation-group: security.delete_action_group + x-version-added: '1.0' + description: Delete a specified action group. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group + parameters: + - $ref: '#/components/parameters/security.delete_action_group::path.action_group' + responses: + '200': + $ref: '#/components/responses/security.delete_action_group@200' + get: + operationId: security.get_action_group.0 + x-operation-group: security.get_action_group + x-version-added: '1.0' + description: Retrieves one action group. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-action-group + parameters: + - $ref: '#/components/parameters/security.get_action_group::path.action_group' + responses: + '200': + $ref: '#/components/responses/security.get_action_group@200' + patch: + operationId: security.patch_action_group.0 + x-operation-group: security.patch_action_group + x-version-added: '1.0' + description: Updates individual attributes of an action group. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-action-group + parameters: + - $ref: '#/components/parameters/security.patch_action_group::path.action_group' + requestBody: + $ref: '#/components/requestBodies/security.patch_action_group' + responses: + '200': + $ref: '#/components/responses/security.patch_action_group@200' + put: + operationId: security.create_action_group.0 + x-operation-group: security.create_action_group + x-version-added: '1.0' + description: Creates or replaces the specified action group. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#create-action-group + parameters: + - $ref: '#/components/parameters/security.create_action_group::path.action_group' + requestBody: + $ref: '#/components/requestBodies/security.create_action_group' + responses: + '200': + $ref: '#/components/responses/security.create_action_group@200' + /_plugins/_security/api/audit: + get: + operationId: security.get_audit_configuration.0 + x-operation-group: security.get_audit_configuration + x-version-added: '1.0' + description: Retrieves the audit configuration. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs + responses: + '200': + $ref: '#/components/responses/security.get_audit_configuration@200' + patch: + operationId: security.patch_audit_configuration.0 + x-operation-group: security.patch_audit_configuration + x-version-added: '1.0' + description: A PATCH call is used to update specified fields in the audit configuration. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs + requestBody: + $ref: '#/components/requestBodies/security.patch_audit_configuration' + responses: + '200': + $ref: '#/components/responses/security.patch_audit_configuration@200' + /_plugins/_security/api/audit/config: + put: + operationId: security.update_audit_configuration.0 + x-operation-group: security.update_audit_configuration + x-version-added: '1.0' + description: Updates the audit configuration. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs + requestBody: + $ref: '#/components/requestBodies/security.update_audit_configuration' + responses: + '200': + $ref: '#/components/responses/security.update_audit_configuration@200' + /_plugins/_security/api/cache: + delete: + operationId: security.flush_cache.0 + x-operation-group: security.flush_cache + x-version-added: '1.0' + description: Flushes the Security plugin user, authentication, and authorization cache. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#flush-cache + responses: + '200': + $ref: '#/components/responses/security.flush_cache@200' + /_plugins/_security/api/internalusers: + get: + operationId: security.get_users.0 + x-operation-group: security.get_users + x-version-added: '1.0' + description: Retrieve all internal users. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-users + responses: + '200': + $ref: '#/components/responses/security.get_users@200' + patch: + operationId: security.patch_users.0 + x-operation-group: security.patch_users + x-version-added: '1.0' + description: Creates, updates, or deletes multiple internal users in a single call. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-users + requestBody: + $ref: '#/components/requestBodies/security.patch_users' + responses: + '200': + $ref: '#/components/responses/security.patch_users@200' + /_plugins/_security/api/internalusers/{username}: + delete: + operationId: security.delete_user.0 + x-operation-group: security.delete_user + x-version-added: '1.0' + description: Delete the specified user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-user + parameters: + - $ref: '#/components/parameters/security.delete_user::path.username' + responses: + '200': + $ref: '#/components/responses/security.delete_user@200' + get: + operationId: security.get_user.0 + x-operation-group: security.get_user + x-version-added: '1.0' + description: Retrieve one internal user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-user + parameters: + - $ref: '#/components/parameters/security.get_user::path.username' + responses: + '200': + $ref: '#/components/responses/security.get_user@200' + patch: + operationId: security.patch_user.0 + x-operation-group: security.patch_user + x-version-added: '1.0' + description: Updates individual attributes of an internal user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-user + parameters: + - $ref: '#/components/parameters/security.patch_user::path.username' + requestBody: + $ref: '#/components/requestBodies/security.patch_user' + responses: + '200': + $ref: '#/components/responses/security.patch_user@200' + put: + operationId: security.create_user.0 + x-operation-group: security.create_user + x-version-added: '1.0' + description: Creates or replaces the specified user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#create-user + parameters: + - $ref: '#/components/parameters/security.create_user::path.username' + requestBody: + $ref: '#/components/requestBodies/security.create_user' + responses: + '200': + $ref: '#/components/responses/security.create_user@200' + /_plugins/_security/api/nodesdn: + get: + operationId: security.get_distinguished_names.0 + x-operation-group: security.get_distinguished_names + x-version-added: '1.0' + description: Retrieves all distinguished names in the allow list. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names + responses: + '200': + $ref: '#/components/responses/security.get_distinguished_names@200' + patch: + operationId: security.patch_distinguished_names.0 + x-operation-group: security.patch_distinguished_names + x-version-added: '1.0' + description: Bulk update of distinguished names. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#update-all-distinguished-names + requestBody: + $ref: '#/components/requestBodies/security.patch_distinguished_names' + responses: + '200': + $ref: '#/components/responses/security.patch_distinguished_names@200' + /_plugins/_security/api/nodesdn/{cluster_name}: + delete: + operationId: security.delete_distinguished_names.0 + x-operation-group: security.delete_distinguished_names + x-version-added: '1.0' + description: Deletes all distinguished names in the specified cluster’s or node’s allow list. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names + parameters: + - $ref: '#/components/parameters/security.delete_distinguished_names::path.cluster_name' + responses: + '200': + $ref: '#/components/responses/security.delete_distinguished_names@200' + get: + operationId: security.get_distinguished_names.1 + x-operation-group: security.get_distinguished_names + x-version-added: '1.0' + description: Retrieve distinguished names of a specified cluster. + parameters: + - $ref: '#/components/parameters/security.get_distinguished_names::path.cluster_name' + responses: + '200': + $ref: '#/components/responses/security.get_distinguished_names@200' + put: + operationId: security.update_distinguished_names.0 + x-operation-group: security.update_distinguished_names + x-version-added: '1.0' + description: Adds or updates the specified distinguished names in the cluster’s or node’s allow list. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names + parameters: + - $ref: '#/components/parameters/security.update_distinguished_names::path.cluster_name' + requestBody: + $ref: '#/components/requestBodies/security.update_distinguished_names' + responses: + '200': + $ref: '#/components/responses/security.update_distinguished_names@200' + /_plugins/_security/api/roles: + patch: + operationId: security.patch_roles.0 + x-operation-group: security.patch_roles + x-version-added: '1.0' + description: Creates, updates, or deletes multiple roles in a single call. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-roles + requestBody: + $ref: '#/components/requestBodies/security.patch_roles' + responses: + '200': + $ref: '#/components/responses/security.patch_roles@200' + /_plugins/_security/api/roles/: + get: + operationId: security.get_roles.0 + x-operation-group: security.get_roles + x-version-added: '1.0' + description: Retrieves all roles. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-roles + responses: + '200': + $ref: '#/components/responses/security.get_roles@200' + /_plugins/_security/api/roles/{role}: + delete: + operationId: security.delete_role.0 + x-operation-group: security.delete_role + x-version-added: '1.0' + description: Delete the specified role. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role + parameters: + - $ref: '#/components/parameters/security.delete_role::path.role' + responses: + '200': + $ref: '#/components/responses/security.delete_role@200' + get: + operationId: security.get_role.0 + x-operation-group: security.get_role + x-version-added: '1.0' + description: Retrieves one role. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-role + parameters: + - $ref: '#/components/parameters/security.get_role::path.role' + responses: + '200': + $ref: '#/components/responses/security.get_role@200' + patch: + operationId: security.patch_role.0 + x-operation-group: security.patch_role + x-version-added: '1.0' + description: Updates individual attributes of a role. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role + parameters: + - $ref: '#/components/parameters/security.patch_role::path.role' + requestBody: + $ref: '#/components/requestBodies/security.patch_role' + responses: + '200': + $ref: '#/components/responses/security.patch_role@200' + put: + operationId: security.create_role.0 + x-operation-group: security.create_role + x-version-added: '1.0' + description: Creates or replaces the specified role. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#create-role + parameters: + - $ref: '#/components/parameters/security.create_role::path.role' + requestBody: + $ref: '#/components/requestBodies/security.create_role' + responses: + '200': + $ref: '#/components/responses/security.create_role@200' + /_plugins/_security/api/rolesmapping: + get: + operationId: security.get_role_mappings.0 + x-operation-group: security.get_role_mappings + x-version-added: '1.0' + description: Retrieves all role mappings. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-role-mappings + responses: + '200': + $ref: '#/components/responses/security.get_role_mappings@200' + patch: + operationId: security.patch_role_mappings.0 + x-operation-group: security.patch_role_mappings + x-version-added: '1.0' + description: Creates or updates multiple role mappings in a single call. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mappings + requestBody: + $ref: '#/components/requestBodies/security.patch_role_mappings' + responses: + '200': + $ref: '#/components/responses/security.patch_role_mappings@200' + /_plugins/_security/api/rolesmapping/{role}: + delete: + operationId: security.delete_role_mapping.0 + x-operation-group: security.delete_role_mapping + x-version-added: '1.0' + description: Deletes the specified role mapping. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping + parameters: + - $ref: '#/components/parameters/security.delete_role_mapping::path.role' + responses: + '200': + $ref: '#/components/responses/security.delete_role_mapping@200' + get: + operationId: security.get_role_mapping.0 + x-operation-group: security.get_role_mapping + x-version-added: '1.0' + description: Retrieves one role mapping. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping + parameters: + - $ref: '#/components/parameters/security.get_role_mapping::path.role' + responses: + '200': + $ref: '#/components/responses/security.get_role_mapping@200' + patch: + operationId: security.patch_role_mapping.0 + x-operation-group: security.patch_role_mapping + x-version-added: '1.0' + description: Updates individual attributes of a role mapping. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mapping + parameters: + - $ref: '#/components/parameters/security.patch_role_mapping::path.role' + requestBody: + $ref: '#/components/requestBodies/security.patch_role_mapping' + responses: + '200': + $ref: '#/components/responses/security.patch_role_mapping@200' + put: + operationId: security.create_role_mapping.0 + x-operation-group: security.create_role_mapping + x-version-added: '1.0' + description: Creates or replaces the specified role mapping. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping + parameters: + - $ref: '#/components/parameters/security.create_role_mapping::path.role' + requestBody: + $ref: '#/components/requestBodies/security.create_role_mapping' + responses: + '200': + $ref: '#/components/responses/security.create_role_mapping@200' + /_plugins/_security/api/securityconfig: + get: + operationId: security.get_configuration.0 + x-operation-group: security.get_configuration + x-version-added: '1.0' + description: Returns the current Security plugin configuration in JSON format. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#get-configuration + responses: + '200': + $ref: '#/components/responses/security.get_configuration@200' + patch: + operationId: security.patch_configuration.0 + x-operation-group: security.patch_configuration + x-version-added: '1.0' + description: A PATCH call is used to update the existing configuration using the REST API. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#patch-configuration + requestBody: + $ref: '#/components/requestBodies/security.patch_configuration' + responses: + '200': + $ref: '#/components/responses/security.patch_configuration@200' + /_plugins/_security/api/securityconfig/config: + put: + operationId: security.update_configuration.0 + x-operation-group: security.update_configuration + x-version-added: '1.0' + description: Adds or updates the existing configuration using the REST API. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#update-configuration + requestBody: + $ref: '#/components/requestBodies/security.update_configuration' + responses: + '200': + $ref: '#/components/responses/security.update_configuration@200' + /_plugins/_security/api/ssl/certs: + get: + operationId: security.get_certificates.0 + x-operation-group: security.get_certificates + x-version-added: '1.0' + description: Retrieves the cluster’s security certificates. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-certificates + responses: + '200': + $ref: '#/components/responses/security.get_certificates@200' + /_plugins/_security/api/ssl/http/reloadcerts: + put: + operationId: security.reload_http_certificates.0 + x-operation-group: security.reload_http_certificates + x-version-added: '1.0' + description: Reload HTTP layer communication certificates. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates + responses: + '200': + $ref: '#/components/responses/security.reload_http_certificates@200' + /_plugins/_security/api/ssl/transport/reloadcerts: + put: + operationId: security.reload_transport_certificates.0 + x-operation-group: security.reload_transport_certificates + x-version-added: '1.0' + description: Reload transport layer communication certificates. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates + responses: + '200': + $ref: '#/components/responses/security.reload_transport_certificates@200' + /_plugins/_security/api/tenants/: + get: + operationId: security.get_tenants.0 + x-operation-group: security.get_tenants + x-version-added: '1.0' + description: Retrieves all tenants. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#get-tenants + responses: + '200': + $ref: '#/components/responses/security.get_tenants@200' + patch: + operationId: security.patch_tenants.0 + x-operation-group: security.patch_tenants + x-version-added: '1.0' + description: Add, delete, or modify multiple tenants in a single call. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#patch-tenants + requestBody: + $ref: '#/components/requestBodies/security.patch_tenants' + responses: + '200': + $ref: '#/components/responses/security.patch_tenants@200' + /_plugins/_security/api/tenants/{tenant}: + delete: + operationId: security.delete_tenant.0 + x-operation-group: security.delete_tenant + x-version-added: '1.0' + description: Delete the specified tenant. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group + parameters: + - $ref: '#/components/parameters/security.delete_tenant::path.tenant' + responses: + '200': + $ref: '#/components/responses/security.delete_tenant@200' + get: + operationId: security.get_tenant.0 + x-operation-group: security.get_tenant + x-version-added: '1.0' + description: Retrieves one tenant. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#get-tenant + parameters: + - $ref: '#/components/parameters/security.get_tenant::path.tenant' + responses: + '200': + $ref: '#/components/responses/security.get_tenant@200' + patch: + operationId: security.patch_tenant.0 + x-operation-group: security.patch_tenant + x-version-added: '1.0' + description: Add, delete, or modify a single tenant. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#patch-tenant + parameters: + - $ref: '#/components/parameters/security.patch_tenant::path.tenant' + requestBody: + $ref: '#/components/requestBodies/security.patch_tenant' + responses: + '200': + $ref: '#/components/responses/security.patch_tenant@200' + put: + operationId: security.create_tenant.0 + x-operation-group: security.create_tenant + x-version-added: '1.0' + description: Creates or replaces the specified tenant. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#create-tenant + parameters: + - $ref: '#/components/parameters/security.create_tenant::path.tenant' + requestBody: + $ref: '#/components/requestBodies/security.create_tenant' + responses: + '200': + $ref: '#/components/responses/security.create_tenant@200' + /_plugins/_security/health: + get: + operationId: security.health.0 + x-operation-group: security.health + x-version-added: '1.0' + description: Checks to see if the Security plugin is up and running. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#health-check + responses: + '200': + $ref: '#/components/responses/security.health@200' + /_rank_eval: + get: + operationId: rank_eval.0 + x-operation-group: rank_eval + x-version-added: '1.0' + description: Allows to evaluate the quality of ranked search results over a set of typical search queries. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/rank-eval/ + parameters: + - $ref: '#/components/parameters/rank_eval::query.ignore_unavailable' + - $ref: '#/components/parameters/rank_eval::query.allow_no_indices' + - $ref: '#/components/parameters/rank_eval::query.expand_wildcards' + - $ref: '#/components/parameters/rank_eval::query.search_type' + requestBody: + $ref: '#/components/requestBodies/rank_eval' + responses: + '200': + $ref: '#/components/responses/rank_eval@200' + post: + operationId: rank_eval.1 + x-operation-group: rank_eval + x-version-added: '1.0' + description: Allows to evaluate the quality of ranked search results over a set of typical search queries. + parameters: + - $ref: '#/components/parameters/rank_eval::query.ignore_unavailable' + - $ref: '#/components/parameters/rank_eval::query.allow_no_indices' + - $ref: '#/components/parameters/rank_eval::query.expand_wildcards' + - $ref: '#/components/parameters/rank_eval::query.search_type' + requestBody: + $ref: '#/components/requestBodies/rank_eval' + responses: + '200': + $ref: '#/components/responses/rank_eval@200' + /_recovery: + get: + operationId: indices.recovery.0 + x-operation-group: indices.recovery + x-version-added: '1.0' + description: Returns information about ongoing index shard recoveries. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.recovery::query.detailed' + - $ref: '#/components/parameters/indices.recovery::query.active_only' + responses: + '200': + $ref: '#/components/responses/indices.recovery@200' + /_refresh: + get: + operationId: indices.refresh.0 + x-operation-group: indices.refresh + x-version-added: '1.0' + description: Performs the refresh operation in one or more indices. + parameters: + - $ref: '#/components/parameters/indices.refresh::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.refresh::query.allow_no_indices' + - $ref: '#/components/parameters/indices.refresh::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.refresh@200' + post: + operationId: indices.refresh.1 + x-operation-group: indices.refresh + x-version-added: '1.0' + description: Performs the refresh operation in one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability + parameters: + - $ref: '#/components/parameters/indices.refresh::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.refresh::query.allow_no_indices' + - $ref: '#/components/parameters/indices.refresh::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.refresh@200' + /_reindex: + post: + operationId: reindex.0 + x-operation-group: reindex + x-version-added: '1.0' + description: |- + Allows to copy documents from one index to another, optionally filtering the source + documents by a query, changing the destination index settings, or fetching the + documents from a remote cluster. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/reindex-data/ + parameters: + - $ref: '#/components/parameters/reindex::query.refresh' + - $ref: '#/components/parameters/reindex::query.timeout' + - $ref: '#/components/parameters/reindex::query.wait_for_active_shards' + - $ref: '#/components/parameters/reindex::query.wait_for_completion' + - $ref: '#/components/parameters/reindex::query.requests_per_second' + - $ref: '#/components/parameters/reindex::query.scroll' + - $ref: '#/components/parameters/reindex::query.slices' + - $ref: '#/components/parameters/reindex::query.max_docs' + requestBody: + $ref: '#/components/requestBodies/reindex' + responses: + '200': + $ref: '#/components/responses/reindex@200' + /_reindex/{task_id}/_rethrottle: + post: + operationId: reindex_rethrottle.0 + x-operation-group: reindex_rethrottle + x-version-added: '1.0' + description: Changes the number of requests per second for a particular Reindex operation. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/reindex_rethrottle::path.task_id' + - $ref: '#/components/parameters/reindex_rethrottle::query.requests_per_second' + responses: + '200': + $ref: '#/components/responses/reindex_rethrottle@200' + /_remote/info: + get: + operationId: cluster.remote_info.0 + x-operation-group: cluster.remote_info + x-version-added: '1.0' + description: Returns the information about configured remote clusters. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/remote-info/ + parameters: [] + responses: + '200': + $ref: '#/components/responses/cluster.remote_info@200' + /_remotestore/_restore: + post: + operationId: remote_store.restore.0 + x-operation-group: remote_store.restore + x-version-added: '1.0' + description: Restores from remote store. + externalDocs: + url: https://opensearch.org/docs/latest/opensearch/remote/#restoring-from-a-backup + parameters: + - $ref: '#/components/parameters/remote_store.restore::query.cluster_manager_timeout' + - $ref: '#/components/parameters/remote_store.restore::query.wait_for_completion' + requestBody: + $ref: '#/components/requestBodies/remote_store.restore' + responses: + '200': + $ref: '#/components/responses/remote_store.restore@200' + /_render/template: + get: + operationId: render_search_template.0 + x-operation-group: render_search_template + x-version-added: '1.0' + description: Allows to use the Mustache language to pre-render a search definition. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/search-template/ + parameters: [] + requestBody: + $ref: '#/components/requestBodies/render_search_template' + responses: + '200': + $ref: '#/components/responses/render_search_template@200' + post: + operationId: render_search_template.1 + x-operation-group: render_search_template + x-version-added: '1.0' + description: Allows to use the Mustache language to pre-render a search definition. + parameters: [] + requestBody: + $ref: '#/components/requestBodies/render_search_template' + responses: + '200': + $ref: '#/components/responses/render_search_template@200' + /_render/template/{id}: + get: + operationId: render_search_template.2 + x-operation-group: render_search_template + x-version-added: '1.0' + description: Allows to use the Mustache language to pre-render a search definition. + parameters: + - $ref: '#/components/parameters/render_search_template::path.id' + requestBody: + $ref: '#/components/requestBodies/render_search_template' + responses: + '200': + $ref: '#/components/responses/render_search_template@200' + post: + operationId: render_search_template.3 + x-operation-group: render_search_template + x-version-added: '1.0' + description: Allows to use the Mustache language to pre-render a search definition. + parameters: + - $ref: '#/components/parameters/render_search_template::path.id' + requestBody: + $ref: '#/components/requestBodies/render_search_template' + responses: + '200': + $ref: '#/components/responses/render_search_template@200' + /_resolve/index/{name}: + get: + operationId: indices.resolve_index.0 + x-operation-group: indices.resolve_index + x-version-added: '1.0' + description: Returns information about any matching indices, aliases, and data streams. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.resolve_index::path.name' + - $ref: '#/components/parameters/indices.resolve_index::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.resolve_index@200' + /_script_context: + get: + operationId: get_script_context.0 + x-operation-group: get_script_context + x-version-added: '1.0' + description: Returns all script contexts. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/script-apis/get-script-contexts/ + parameters: [] + responses: + '200': + $ref: '#/components/responses/get_script_context@200' + /_script_language: + get: + operationId: get_script_languages.0 + x-operation-group: get_script_languages + x-version-added: '1.0' + description: Returns available script types, languages and contexts. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/script-apis/get-script-language/ + parameters: [] + responses: + '200': + $ref: '#/components/responses/get_script_languages@200' + /_scripts/painless/_execute: + get: + operationId: scripts_painless_execute.0 + x-operation-group: scripts_painless_execute + x-version-added: '1.0' + description: Allows an arbitrary script to be executed and a result to be returned. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/ + parameters: [] + requestBody: + $ref: '#/components/requestBodies/scripts_painless_execute' + responses: + '200': + $ref: '#/components/responses/scripts_painless_execute@200' + post: + operationId: scripts_painless_execute.1 + x-operation-group: scripts_painless_execute + x-version-added: '1.0' + description: Allows an arbitrary script to be executed and a result to be returned. + parameters: [] + requestBody: + $ref: '#/components/requestBodies/scripts_painless_execute' + responses: + '200': + $ref: '#/components/responses/scripts_painless_execute@200' + /_scripts/{id}: + delete: + operationId: delete_script.0 + x-operation-group: delete_script + x-version-added: '1.0' + description: Deletes a script. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/script-apis/delete-script/ + parameters: + - $ref: '#/components/parameters/delete_script::path.id' + - $ref: '#/components/parameters/delete_script::query.timeout' + - $ref: '#/components/parameters/delete_script::query.master_timeout' + - $ref: '#/components/parameters/delete_script::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/delete_script@200' + get: + operationId: get_script.0 + x-operation-group: get_script + x-version-added: '1.0' + description: Returns a script. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/script-apis/get-stored-script/ + parameters: + - $ref: '#/components/parameters/get_script::path.id' + - $ref: '#/components/parameters/get_script::query.master_timeout' + - $ref: '#/components/parameters/get_script::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/get_script@200' + post: + operationId: put_script.0 + x-operation-group: put_script + x-version-added: '1.0' + description: Creates or updates a script. + parameters: + - $ref: '#/components/parameters/put_script::path.id' + - $ref: '#/components/parameters/put_script::query.timeout' + - $ref: '#/components/parameters/put_script::query.master_timeout' + - $ref: '#/components/parameters/put_script::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/put_script' + responses: + '200': + $ref: '#/components/responses/put_script@200' + put: + operationId: put_script.1 + x-operation-group: put_script + x-version-added: '1.0' + description: Creates or updates a script. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/ + parameters: + - $ref: '#/components/parameters/put_script::path.id' + - $ref: '#/components/parameters/put_script::query.timeout' + - $ref: '#/components/parameters/put_script::query.master_timeout' + - $ref: '#/components/parameters/put_script::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/put_script' + responses: + '200': + $ref: '#/components/responses/put_script@200' + /_scripts/{id}/{context}: + post: + operationId: put_script.2 + x-operation-group: put_script + x-version-added: '1.0' + description: Creates or updates a script. + parameters: + - $ref: '#/components/parameters/put_script::path.id' + - $ref: '#/components/parameters/put_script::path.context' + - $ref: '#/components/parameters/put_script::query.timeout' + - $ref: '#/components/parameters/put_script::query.master_timeout' + - $ref: '#/components/parameters/put_script::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/put_script' + responses: + '200': + $ref: '#/components/responses/put_script@200' + put: + operationId: put_script.3 + x-operation-group: put_script + x-version-added: '1.0' + description: Creates or updates a script. + parameters: + - $ref: '#/components/parameters/put_script::path.id' + - $ref: '#/components/parameters/put_script::path.context' + - $ref: '#/components/parameters/put_script::query.timeout' + - $ref: '#/components/parameters/put_script::query.master_timeout' + - $ref: '#/components/parameters/put_script::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/put_script' + responses: + '200': + $ref: '#/components/responses/put_script@200' + /_search: + get: + operationId: search.0 + x-operation-group: search + x-version-added: '1.0' + description: Returns results matching a query. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/search/ + parameters: + - $ref: '#/components/parameters/search::query.analyzer' + - $ref: '#/components/parameters/search::query.analyze_wildcard' + - $ref: '#/components/parameters/search::query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/search::query.default_operator' + - $ref: '#/components/parameters/search::query.df' + - $ref: '#/components/parameters/search::query.explain' + - $ref: '#/components/parameters/search::query.stored_fields' + - $ref: '#/components/parameters/search::query.docvalue_fields' + - $ref: '#/components/parameters/search::query.from' + - $ref: '#/components/parameters/search::query.ignore_unavailable' + - $ref: '#/components/parameters/search::query.ignore_throttled' + - $ref: '#/components/parameters/search::query.allow_no_indices' + - $ref: '#/components/parameters/search::query.expand_wildcards' + - $ref: '#/components/parameters/search::query.lenient' + - $ref: '#/components/parameters/search::query.preference' + - $ref: '#/components/parameters/search::query.q' + - $ref: '#/components/parameters/search::query.routing' + - $ref: '#/components/parameters/search::query.scroll' + - $ref: '#/components/parameters/search::query.search_type' + - $ref: '#/components/parameters/search::query.size' + - $ref: '#/components/parameters/search::query.sort' + - $ref: '#/components/parameters/search::query._source' + - $ref: '#/components/parameters/search::query._source_excludes' + - $ref: '#/components/parameters/search::query._source_includes' + - $ref: '#/components/parameters/search::query.terminate_after' + - $ref: '#/components/parameters/search::query.stats' + - $ref: '#/components/parameters/search::query.suggest_field' + - $ref: '#/components/parameters/search::query.suggest_mode' + - $ref: '#/components/parameters/search::query.suggest_size' + - $ref: '#/components/parameters/search::query.suggest_text' + - $ref: '#/components/parameters/search::query.timeout' + - $ref: '#/components/parameters/search::query.track_scores' + - $ref: '#/components/parameters/search::query.track_total_hits' + - $ref: '#/components/parameters/search::query.allow_partial_search_results' + - $ref: '#/components/parameters/search::query.typed_keys' + - $ref: '#/components/parameters/search::query.version' + - $ref: '#/components/parameters/search::query.seq_no_primary_term' + - $ref: '#/components/parameters/search::query.request_cache' + - $ref: '#/components/parameters/search::query.batched_reduce_size' + - $ref: '#/components/parameters/search::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/search::query.pre_filter_shard_size' + - $ref: '#/components/parameters/search::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search::query.search_pipeline' + - $ref: '#/components/parameters/search::query.include_named_queries_score' + requestBody: + $ref: '#/components/requestBodies/search' + responses: + '200': + $ref: '#/components/responses/search@200' + post: + operationId: search.1 + x-operation-group: search + x-version-added: '1.0' + description: Returns results matching a query. + parameters: + - $ref: '#/components/parameters/search::query.analyzer' + - $ref: '#/components/parameters/search::query.analyze_wildcard' + - $ref: '#/components/parameters/search::query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/search::query.default_operator' + - $ref: '#/components/parameters/search::query.df' + - $ref: '#/components/parameters/search::query.explain' + - $ref: '#/components/parameters/search::query.stored_fields' + - $ref: '#/components/parameters/search::query.docvalue_fields' + - $ref: '#/components/parameters/search::query.from' + - $ref: '#/components/parameters/search::query.ignore_unavailable' + - $ref: '#/components/parameters/search::query.ignore_throttled' + - $ref: '#/components/parameters/search::query.allow_no_indices' + - $ref: '#/components/parameters/search::query.expand_wildcards' + - $ref: '#/components/parameters/search::query.lenient' + - $ref: '#/components/parameters/search::query.preference' + - $ref: '#/components/parameters/search::query.q' + - $ref: '#/components/parameters/search::query.routing' + - $ref: '#/components/parameters/search::query.scroll' + - $ref: '#/components/parameters/search::query.search_type' + - $ref: '#/components/parameters/search::query.size' + - $ref: '#/components/parameters/search::query.sort' + - $ref: '#/components/parameters/search::query._source' + - $ref: '#/components/parameters/search::query._source_excludes' + - $ref: '#/components/parameters/search::query._source_includes' + - $ref: '#/components/parameters/search::query.terminate_after' + - $ref: '#/components/parameters/search::query.stats' + - $ref: '#/components/parameters/search::query.suggest_field' + - $ref: '#/components/parameters/search::query.suggest_mode' + - $ref: '#/components/parameters/search::query.suggest_size' + - $ref: '#/components/parameters/search::query.suggest_text' + - $ref: '#/components/parameters/search::query.timeout' + - $ref: '#/components/parameters/search::query.track_scores' + - $ref: '#/components/parameters/search::query.track_total_hits' + - $ref: '#/components/parameters/search::query.allow_partial_search_results' + - $ref: '#/components/parameters/search::query.typed_keys' + - $ref: '#/components/parameters/search::query.version' + - $ref: '#/components/parameters/search::query.seq_no_primary_term' + - $ref: '#/components/parameters/search::query.request_cache' + - $ref: '#/components/parameters/search::query.batched_reduce_size' + - $ref: '#/components/parameters/search::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/search::query.pre_filter_shard_size' + - $ref: '#/components/parameters/search::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search::query.search_pipeline' + - $ref: '#/components/parameters/search::query.include_named_queries_score' + requestBody: + $ref: '#/components/requestBodies/search' + responses: + '200': + $ref: '#/components/responses/search@200' + /_search/pipeline/{pipeline}: + get: + operationId: search_pipeline.get.0 + x-operation-group: search_pipeline.get + x-version-added: '2.9' + description: Retrieves information about a specified search pipeline. + parameters: + - $ref: '#/components/parameters/search_pipeline.get::path.pipeline' + responses: + '200': + $ref: '#/components/responses/search_pipeline.get@200' + put: + operationId: search_pipeline.create.0 + x-operation-group: search_pipeline.create + x-version-added: '2.9' + description: Creates or replaces the specified search pipeline. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/search-pipelines/creating-search-pipeline/ + parameters: + - $ref: '#/components/parameters/search_pipeline.create::path.pipeline' + requestBody: + $ref: '#/components/requestBodies/search_pipeline.create' + responses: + '200': + $ref: '#/components/responses/search_pipeline.create@200' + /_search/point_in_time: + delete: + operationId: delete_pit.0 + x-operation-group: delete_pit + x-version-added: '2.4' + description: Deletes one or more point in time searches based on the IDs passed. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits + requestBody: + $ref: '#/components/requestBodies/delete_pit' + responses: + '200': + $ref: '#/components/responses/delete_pit@200' + /_search/point_in_time/_all: + delete: + operationId: delete_all_pits.0 + x-operation-group: delete_all_pits + x-version-added: '2.4' + description: Deletes all active point in time searches. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits + responses: + '200': + $ref: '#/components/responses/delete_all_pits@200' + get: + operationId: get_all_pits.0 + x-operation-group: get_all_pits + x-version-added: '2.4' + description: Lists all active point in time searches. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#list-all-pits + responses: + '200': + $ref: '#/components/responses/get_all_pits@200' + /_search/scroll: + delete: + operationId: clear_scroll.0 + x-operation-group: clear_scroll + x-version-added: '1.0' + description: Explicitly clears the search context for a scroll. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/scroll/ + parameters: [] + requestBody: + $ref: '#/components/requestBodies/clear_scroll' + responses: + '200': + $ref: '#/components/responses/clear_scroll@200' + get: + operationId: scroll.0 + x-operation-group: scroll + x-version-added: '1.0' + description: Allows to retrieve a large numbers of results from a single search request. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods + parameters: + - $ref: '#/components/parameters/scroll::query.scroll' + - $ref: '#/components/parameters/scroll::query.scroll_id' + - $ref: '#/components/parameters/scroll::query.rest_total_hits_as_int' + requestBody: + $ref: '#/components/requestBodies/scroll' + responses: + '200': + $ref: '#/components/responses/scroll@200' + post: + operationId: scroll.1 + x-operation-group: scroll + x-version-added: '1.0' + description: Allows to retrieve a large numbers of results from a single search request. + parameters: + - $ref: '#/components/parameters/scroll::query.scroll' + - $ref: '#/components/parameters/scroll::query.scroll_id' + - $ref: '#/components/parameters/scroll::query.rest_total_hits_as_int' + requestBody: + $ref: '#/components/requestBodies/scroll' + responses: + '200': + $ref: '#/components/responses/scroll@200' + /_search/scroll/{scroll_id}: + delete: + operationId: clear_scroll.1 + x-operation-group: clear_scroll + deprecated: true + x-deprecation-message: A scroll id can be quite large and should be specified as part of the body + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Explicitly clears the search context for a scroll. + parameters: + - $ref: '#/components/parameters/clear_scroll::path.scroll_id' + requestBody: + $ref: '#/components/requestBodies/clear_scroll' + responses: + '200': + $ref: '#/components/responses/clear_scroll@200' + get: + operationId: scroll.2 + x-operation-group: scroll + deprecated: true + x-deprecation-message: A scroll id can be quite large and should be specified as part of the body + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Allows to retrieve a large numbers of results from a single search request. + parameters: + - $ref: '#/components/parameters/scroll::path.scroll_id' + - $ref: '#/components/parameters/scroll::query.scroll' + - $ref: '#/components/parameters/scroll::query.scroll_id' + - $ref: '#/components/parameters/scroll::query.rest_total_hits_as_int' + requestBody: + $ref: '#/components/requestBodies/scroll' + responses: + '200': + $ref: '#/components/responses/scroll@200' + post: + operationId: scroll.3 + x-operation-group: scroll + deprecated: true + x-deprecation-message: A scroll id can be quite large and should be specified as part of the body + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Allows to retrieve a large numbers of results from a single search request. + parameters: + - $ref: '#/components/parameters/scroll::path.scroll_id' + - $ref: '#/components/parameters/scroll::query.scroll' + - $ref: '#/components/parameters/scroll::query.scroll_id' + - $ref: '#/components/parameters/scroll::query.rest_total_hits_as_int' + requestBody: + $ref: '#/components/requestBodies/scroll' + responses: + '200': + $ref: '#/components/responses/scroll@200' + /_search/template: + get: + operationId: search_template.0 + x-operation-group: search_template + x-version-added: '1.0' + description: Allows to use the Mustache language to pre-render a search definition. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/search-template/ + parameters: + - $ref: '#/components/parameters/search_template::query.ignore_unavailable' + - $ref: '#/components/parameters/search_template::query.ignore_throttled' + - $ref: '#/components/parameters/search_template::query.allow_no_indices' + - $ref: '#/components/parameters/search_template::query.expand_wildcards' + - $ref: '#/components/parameters/search_template::query.preference' + - $ref: '#/components/parameters/search_template::query.routing' + - $ref: '#/components/parameters/search_template::query.scroll' + - $ref: '#/components/parameters/search_template::query.search_type' + - $ref: '#/components/parameters/search_template::query.explain' + - $ref: '#/components/parameters/search_template::query.profile' + - $ref: '#/components/parameters/search_template::query.typed_keys' + - $ref: '#/components/parameters/search_template::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search_template::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/search_template' + responses: + '200': + $ref: '#/components/responses/search_template@200' + post: + operationId: search_template.1 + x-operation-group: search_template + x-version-added: '1.0' + description: Allows to use the Mustache language to pre-render a search definition. + parameters: + - $ref: '#/components/parameters/search_template::query.ignore_unavailable' + - $ref: '#/components/parameters/search_template::query.ignore_throttled' + - $ref: '#/components/parameters/search_template::query.allow_no_indices' + - $ref: '#/components/parameters/search_template::query.expand_wildcards' + - $ref: '#/components/parameters/search_template::query.preference' + - $ref: '#/components/parameters/search_template::query.routing' + - $ref: '#/components/parameters/search_template::query.scroll' + - $ref: '#/components/parameters/search_template::query.search_type' + - $ref: '#/components/parameters/search_template::query.explain' + - $ref: '#/components/parameters/search_template::query.profile' + - $ref: '#/components/parameters/search_template::query.typed_keys' + - $ref: '#/components/parameters/search_template::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search_template::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/search_template' + responses: + '200': + $ref: '#/components/responses/search_template@200' + /_search_shards: + get: + operationId: search_shards.0 + x-operation-group: search_shards + x-version-added: '1.0' + description: Returns information about the indices and shards that a search request would be executed against. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/search_shards::query.preference' + - $ref: '#/components/parameters/search_shards::query.routing' + - $ref: '#/components/parameters/search_shards::query.local' + - $ref: '#/components/parameters/search_shards::query.ignore_unavailable' + - $ref: '#/components/parameters/search_shards::query.allow_no_indices' + - $ref: '#/components/parameters/search_shards::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/search_shards@200' + post: + operationId: search_shards.1 + x-operation-group: search_shards + x-version-added: '1.0' + description: Returns information about the indices and shards that a search request would be executed against. + parameters: + - $ref: '#/components/parameters/search_shards::query.preference' + - $ref: '#/components/parameters/search_shards::query.routing' + - $ref: '#/components/parameters/search_shards::query.local' + - $ref: '#/components/parameters/search_shards::query.ignore_unavailable' + - $ref: '#/components/parameters/search_shards::query.allow_no_indices' + - $ref: '#/components/parameters/search_shards::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/search_shards@200' + /_segments: + get: + operationId: indices.segments.0 + x-operation-group: indices.segments + x-version-added: '1.0' + description: Provides low-level information about segments in a Lucene index. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.segments::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.segments::query.allow_no_indices' + - $ref: '#/components/parameters/indices.segments::query.expand_wildcards' + - $ref: '#/components/parameters/indices.segments::query.verbose' + responses: + '200': + $ref: '#/components/responses/indices.segments@200' + /_settings: + get: + operationId: indices.get_settings.0 + x-operation-group: indices.get_settings + x-version-added: '1.0' + description: Returns settings for one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ + parameters: + - $ref: '#/components/parameters/indices.get_settings::query.master_timeout' + - $ref: '#/components/parameters/indices.get_settings::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_settings::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_settings::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_settings::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_settings::query.flat_settings' + - $ref: '#/components/parameters/indices.get_settings::query.local' + - $ref: '#/components/parameters/indices.get_settings::query.include_defaults' + responses: + '200': + $ref: '#/components/responses/indices.get_settings@200' + put: + operationId: indices.put_settings.0 + x-operation-group: indices.put_settings + x-version-added: '1.0' + description: Updates the index settings. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/ + parameters: + - $ref: '#/components/parameters/indices.put_settings::query.master_timeout' + - $ref: '#/components/parameters/indices.put_settings::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_settings::query.timeout' + - $ref: '#/components/parameters/indices.put_settings::query.preserve_existing' + - $ref: '#/components/parameters/indices.put_settings::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.put_settings::query.allow_no_indices' + - $ref: '#/components/parameters/indices.put_settings::query.expand_wildcards' + - $ref: '#/components/parameters/indices.put_settings::query.flat_settings' + requestBody: + $ref: '#/components/requestBodies/indices.put_settings' + responses: + '200': + $ref: '#/components/responses/indices.put_settings@200' + /_settings/{name}: + get: + operationId: indices.get_settings.1 + x-operation-group: indices.get_settings + x-version-added: '1.0' + description: Returns settings for one or more indices. + parameters: + - $ref: '#/components/parameters/indices.get_settings::path.name' + - $ref: '#/components/parameters/indices.get_settings::query.master_timeout' + - $ref: '#/components/parameters/indices.get_settings::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_settings::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_settings::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_settings::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_settings::query.flat_settings' + - $ref: '#/components/parameters/indices.get_settings::query.local' + - $ref: '#/components/parameters/indices.get_settings::query.include_defaults' + responses: + '200': + $ref: '#/components/responses/indices.get_settings@200' + /_shard_stores: + get: + operationId: indices.shard_stores.0 + x-operation-group: indices.shard_stores + x-version-added: '1.0' + description: Provides store information for shard copies of indices. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.shard_stores::query.status' + - $ref: '#/components/parameters/indices.shard_stores::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.shard_stores::query.allow_no_indices' + - $ref: '#/components/parameters/indices.shard_stores::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.shard_stores@200' + /_snapshot: + get: + operationId: snapshot.get_repository.0 + x-operation-group: snapshot.get_repository + x-version-added: '1.0' + description: Returns information about a repository. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/ + parameters: + - $ref: '#/components/parameters/snapshot.get_repository::query.master_timeout' + - $ref: '#/components/parameters/snapshot.get_repository::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.get_repository::query.local' + responses: + '200': + $ref: '#/components/responses/snapshot.get_repository@200' + /_snapshot/_status: + get: + operationId: snapshot.status.0 + x-operation-group: snapshot.status + x-version-added: '1.0' + description: Returns information about the status of a snapshot. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/ + parameters: + - $ref: '#/components/parameters/snapshot.status::query.master_timeout' + - $ref: '#/components/parameters/snapshot.status::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.status::query.ignore_unavailable' + responses: + '200': + $ref: '#/components/responses/snapshot.status@200' + /_snapshot/{repository}: + delete: + operationId: snapshot.delete_repository.0 + x-operation-group: snapshot.delete_repository + x-version-added: '1.0' + description: Deletes a repository. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/ + parameters: + - $ref: '#/components/parameters/snapshot.delete_repository::path.repository' + - $ref: '#/components/parameters/snapshot.delete_repository::query.master_timeout' + - $ref: '#/components/parameters/snapshot.delete_repository::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.delete_repository::query.timeout' + responses: + '200': + $ref: '#/components/responses/snapshot.delete_repository@200' + get: + operationId: snapshot.get_repository.1 + x-operation-group: snapshot.get_repository + x-version-added: '1.0' + description: Returns information about a repository. + parameters: + - $ref: '#/components/parameters/snapshot.get_repository::path.repository' + - $ref: '#/components/parameters/snapshot.get_repository::query.master_timeout' + - $ref: '#/components/parameters/snapshot.get_repository::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.get_repository::query.local' + responses: + '200': + $ref: '#/components/responses/snapshot.get_repository@200' + post: + operationId: snapshot.create_repository.0 + x-operation-group: snapshot.create_repository + x-version-added: '1.0' + description: Creates a repository. + parameters: + - $ref: '#/components/parameters/snapshot.create_repository::path.repository' + - $ref: '#/components/parameters/snapshot.create_repository::query.master_timeout' + - $ref: '#/components/parameters/snapshot.create_repository::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.create_repository::query.timeout' + - $ref: '#/components/parameters/snapshot.create_repository::query.verify' + requestBody: + $ref: '#/components/requestBodies/snapshot.create_repository' + responses: + '200': + $ref: '#/components/responses/snapshot.create_repository@200' + put: + operationId: snapshot.create_repository.1 + x-operation-group: snapshot.create_repository + x-version-added: '1.0' + description: Creates a repository. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ + parameters: + - $ref: '#/components/parameters/snapshot.create_repository::path.repository' + - $ref: '#/components/parameters/snapshot.create_repository::query.master_timeout' + - $ref: '#/components/parameters/snapshot.create_repository::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.create_repository::query.timeout' + - $ref: '#/components/parameters/snapshot.create_repository::query.verify' + requestBody: + $ref: '#/components/requestBodies/snapshot.create_repository' + responses: + '200': + $ref: '#/components/responses/snapshot.create_repository@200' + /_snapshot/{repository}/_cleanup: + post: + operationId: snapshot.cleanup_repository.0 + x-operation-group: snapshot.cleanup_repository + x-version-added: '1.0' + description: Removes stale data from repository. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/snapshot.cleanup_repository::path.repository' + - $ref: '#/components/parameters/snapshot.cleanup_repository::query.master_timeout' + - $ref: '#/components/parameters/snapshot.cleanup_repository::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.cleanup_repository::query.timeout' + responses: + '200': + $ref: '#/components/responses/snapshot.cleanup_repository@200' + /_snapshot/{repository}/_status: + get: + operationId: snapshot.status.1 + x-operation-group: snapshot.status + x-version-added: '1.0' + description: Returns information about the status of a snapshot. + parameters: + - $ref: '#/components/parameters/snapshot.status::path.repository' + - $ref: '#/components/parameters/snapshot.status::query.master_timeout' + - $ref: '#/components/parameters/snapshot.status::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.status::query.ignore_unavailable' + responses: + '200': + $ref: '#/components/responses/snapshot.status@200' + /_snapshot/{repository}/_verify: + post: + operationId: snapshot.verify_repository.0 + x-operation-group: snapshot.verify_repository + x-version-added: '1.0' + description: Verifies a repository. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/ + parameters: + - $ref: '#/components/parameters/snapshot.verify_repository::path.repository' + - $ref: '#/components/parameters/snapshot.verify_repository::query.master_timeout' + - $ref: '#/components/parameters/snapshot.verify_repository::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.verify_repository::query.timeout' + responses: + '200': + $ref: '#/components/responses/snapshot.verify_repository@200' + /_snapshot/{repository}/{snapshot}: + delete: + operationId: snapshot.delete.0 + x-operation-group: snapshot.delete + x-version-added: '1.0' + description: Deletes a snapshot. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/ + parameters: + - $ref: '#/components/parameters/snapshot.delete::path.repository' + - $ref: '#/components/parameters/snapshot.delete::path.snapshot' + - $ref: '#/components/parameters/snapshot.delete::query.master_timeout' + - $ref: '#/components/parameters/snapshot.delete::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/snapshot.delete@200' + get: + operationId: snapshot.get.0 + x-operation-group: snapshot.get + x-version-added: '1.0' + description: Returns information about a snapshot. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/snapshot.get::path.repository' + - $ref: '#/components/parameters/snapshot.get::path.snapshot' + - $ref: '#/components/parameters/snapshot.get::query.master_timeout' + - $ref: '#/components/parameters/snapshot.get::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.get::query.ignore_unavailable' + - $ref: '#/components/parameters/snapshot.get::query.verbose' + responses: + '200': + $ref: '#/components/responses/snapshot.get@200' + post: + operationId: snapshot.create.0 + x-operation-group: snapshot.create + x-version-added: '1.0' + description: Creates a snapshot in a repository. + parameters: + - $ref: '#/components/parameters/snapshot.create::path.repository' + - $ref: '#/components/parameters/snapshot.create::path.snapshot' + - $ref: '#/components/parameters/snapshot.create::query.master_timeout' + - $ref: '#/components/parameters/snapshot.create::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.create::query.wait_for_completion' + requestBody: + $ref: '#/components/requestBodies/snapshot.create' + responses: + '200': + $ref: '#/components/responses/snapshot.create@200' + put: + operationId: snapshot.create.1 + x-operation-group: snapshot.create + x-version-added: '1.0' + description: Creates a snapshot in a repository. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ + parameters: + - $ref: '#/components/parameters/snapshot.create::path.repository' + - $ref: '#/components/parameters/snapshot.create::path.snapshot' + - $ref: '#/components/parameters/snapshot.create::query.master_timeout' + - $ref: '#/components/parameters/snapshot.create::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.create::query.wait_for_completion' + requestBody: + $ref: '#/components/requestBodies/snapshot.create' + responses: + '200': + $ref: '#/components/responses/snapshot.create@200' + /_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}: + put: + operationId: snapshot.clone.0 + x-operation-group: snapshot.clone + x-version-added: '1.0' + description: Clones indices from one snapshot into another snapshot in the same repository. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/snapshot.clone::path.repository' + - $ref: '#/components/parameters/snapshot.clone::path.snapshot' + - $ref: '#/components/parameters/snapshot.clone::path.target_snapshot' + - $ref: '#/components/parameters/snapshot.clone::query.master_timeout' + - $ref: '#/components/parameters/snapshot.clone::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/snapshot.clone' + responses: + '200': + $ref: '#/components/responses/snapshot.clone@200' + /_snapshot/{repository}/{snapshot}/_restore: + post: + operationId: snapshot.restore.0 + x-operation-group: snapshot.restore + x-version-added: '1.0' + description: Restores a snapshot. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot/ + parameters: + - $ref: '#/components/parameters/snapshot.restore::path.repository' + - $ref: '#/components/parameters/snapshot.restore::path.snapshot' + - $ref: '#/components/parameters/snapshot.restore::query.master_timeout' + - $ref: '#/components/parameters/snapshot.restore::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.restore::query.wait_for_completion' + requestBody: + $ref: '#/components/requestBodies/snapshot.restore' + responses: + '200': + $ref: '#/components/responses/snapshot.restore@200' + /_snapshot/{repository}/{snapshot}/_status: + get: + operationId: snapshot.status.2 + x-operation-group: snapshot.status + x-version-added: '1.0' + description: Returns information about the status of a snapshot. + parameters: + - $ref: '#/components/parameters/snapshot.status::path.repository' + - $ref: '#/components/parameters/snapshot.status::path.snapshot' + - $ref: '#/components/parameters/snapshot.status::query.master_timeout' + - $ref: '#/components/parameters/snapshot.status::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.status::query.ignore_unavailable' + responses: + '200': + $ref: '#/components/responses/snapshot.status@200' + /_stats: + get: + operationId: indices.stats.0 + x-operation-group: indices.stats + x-version-added: '1.0' + description: Provides statistics on operations happening in an index. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.stats::query.completion_fields' + - $ref: '#/components/parameters/indices.stats::query.fielddata_fields' + - $ref: '#/components/parameters/indices.stats::query.fields' + - $ref: '#/components/parameters/indices.stats::query.groups' + - $ref: '#/components/parameters/indices.stats::query.level' + - $ref: '#/components/parameters/indices.stats::query.include_segment_file_sizes' + - $ref: '#/components/parameters/indices.stats::query.include_unloaded_segments' + - $ref: '#/components/parameters/indices.stats::query.expand_wildcards' + - $ref: '#/components/parameters/indices.stats::query.forbid_closed_indices' + responses: + '200': + $ref: '#/components/responses/indices.stats@200' + /_stats/{metric}: + get: + operationId: indices.stats.1 + x-operation-group: indices.stats + x-version-added: '1.0' + description: Provides statistics on operations happening in an index. + parameters: + - $ref: '#/components/parameters/indices.stats::path.metric' + - $ref: '#/components/parameters/indices.stats::query.completion_fields' + - $ref: '#/components/parameters/indices.stats::query.fielddata_fields' + - $ref: '#/components/parameters/indices.stats::query.fields' + - $ref: '#/components/parameters/indices.stats::query.groups' + - $ref: '#/components/parameters/indices.stats::query.level' + - $ref: '#/components/parameters/indices.stats::query.include_segment_file_sizes' + - $ref: '#/components/parameters/indices.stats::query.include_unloaded_segments' + - $ref: '#/components/parameters/indices.stats::query.expand_wildcards' + - $ref: '#/components/parameters/indices.stats::query.forbid_closed_indices' + responses: + '200': + $ref: '#/components/responses/indices.stats@200' + /_tasks: + get: + operationId: tasks.list.0 + x-operation-group: tasks.list + x-version-added: '1.0' + description: Returns a list of tasks. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/tasks/ + parameters: + - $ref: '#/components/parameters/tasks.list::query.nodes' + - $ref: '#/components/parameters/tasks.list::query.actions' + - $ref: '#/components/parameters/tasks.list::query.detailed' + - $ref: '#/components/parameters/tasks.list::query.parent_task_id' + - $ref: '#/components/parameters/tasks.list::query.wait_for_completion' + - $ref: '#/components/parameters/tasks.list::query.group_by' + - $ref: '#/components/parameters/tasks.list::query.timeout' + responses: + '200': + $ref: '#/components/responses/tasks.list@200' + /_tasks/_cancel: + post: + operationId: tasks.cancel.0 + x-operation-group: tasks.cancel + x-version-added: '1.0' + description: Cancels a task, if it can be cancelled through an API. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling + parameters: + - $ref: '#/components/parameters/tasks.cancel::query.nodes' + - $ref: '#/components/parameters/tasks.cancel::query.actions' + - $ref: '#/components/parameters/tasks.cancel::query.parent_task_id' + - $ref: '#/components/parameters/tasks.cancel::query.wait_for_completion' + responses: + '200': + $ref: '#/components/responses/tasks.cancel@200' + /_tasks/{task_id}: + get: + operationId: tasks.get.0 + x-operation-group: tasks.get + x-version-added: '1.0' + description: Returns information about a task. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/tasks/ + parameters: + - $ref: '#/components/parameters/tasks.get::path.task_id' + - $ref: '#/components/parameters/tasks.get::query.wait_for_completion' + - $ref: '#/components/parameters/tasks.get::query.timeout' + responses: + '200': + $ref: '#/components/responses/tasks.get@200' + /_tasks/{task_id}/_cancel: + post: + operationId: tasks.cancel.1 + x-operation-group: tasks.cancel + x-version-added: '1.0' + description: Cancels a task, if it can be cancelled through an API. + parameters: + - $ref: '#/components/parameters/tasks.cancel::path.task_id' + - $ref: '#/components/parameters/tasks.cancel::query.nodes' + - $ref: '#/components/parameters/tasks.cancel::query.actions' + - $ref: '#/components/parameters/tasks.cancel::query.parent_task_id' + - $ref: '#/components/parameters/tasks.cancel::query.wait_for_completion' + responses: + '200': + $ref: '#/components/responses/tasks.cancel@200' + /_template: + get: + operationId: indices.get_template.0 + x-operation-group: indices.get_template + x-version-added: '1.0' + description: Returns an index template. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.get_template::query.flat_settings' + - $ref: '#/components/parameters/indices.get_template::query.master_timeout' + - $ref: '#/components/parameters/indices.get_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_template::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_template@200' + /_template/{name}: + delete: + operationId: indices.delete_template.0 + x-operation-group: indices.delete_template + x-version-added: '1.0' + description: Deletes an index template. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.delete_template::path.name' + - $ref: '#/components/parameters/indices.delete_template::query.timeout' + - $ref: '#/components/parameters/indices.delete_template::query.master_timeout' + - $ref: '#/components/parameters/indices.delete_template::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/indices.delete_template@200' + get: + operationId: indices.get_template.1 + x-operation-group: indices.get_template + x-version-added: '1.0' + description: Returns an index template. + parameters: + - $ref: '#/components/parameters/indices.get_template::path.name' + - $ref: '#/components/parameters/indices.get_template::query.flat_settings' + - $ref: '#/components/parameters/indices.get_template::query.master_timeout' + - $ref: '#/components/parameters/indices.get_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_template::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_template@200' + head: + operationId: indices.exists_template.0 + x-operation-group: indices.exists_template + x-version-added: '1.0' + description: Returns information about whether a particular index template exists. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.exists_template::path.name' + - $ref: '#/components/parameters/indices.exists_template::query.flat_settings' + - $ref: '#/components/parameters/indices.exists_template::query.master_timeout' + - $ref: '#/components/parameters/indices.exists_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.exists_template::query.local' + responses: + '200': + $ref: '#/components/responses/indices.exists_template@200' + post: + operationId: indices.put_template.0 + x-operation-group: indices.put_template + x-version-added: '1.0' + description: Creates or updates an index template. + parameters: + - $ref: '#/components/parameters/indices.put_template::path.name' + - $ref: '#/components/parameters/indices.put_template::query.order' + - $ref: '#/components/parameters/indices.put_template::query.create' + - $ref: '#/components/parameters/indices.put_template::query.master_timeout' + - $ref: '#/components/parameters/indices.put_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.put_template' + responses: + '200': + $ref: '#/components/responses/indices.put_template@200' + put: + operationId: indices.put_template.1 + x-operation-group: indices.put_template + x-version-added: '1.0' + description: Creates or updates an index template. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-templates/ + parameters: + - $ref: '#/components/parameters/indices.put_template::path.name' + - $ref: '#/components/parameters/indices.put_template::query.order' + - $ref: '#/components/parameters/indices.put_template::query.create' + - $ref: '#/components/parameters/indices.put_template::query.master_timeout' + - $ref: '#/components/parameters/indices.put_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.put_template' + responses: + '200': + $ref: '#/components/responses/indices.put_template@200' + /_update_by_query/{task_id}/_rethrottle: + post: + operationId: update_by_query_rethrottle.0 + x-operation-group: update_by_query_rethrottle + x-version-added: '1.0' + description: Changes the number of requests per second for a particular Update By Query operation. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/update_by_query_rethrottle::path.task_id' + - $ref: '#/components/parameters/update_by_query_rethrottle::query.requests_per_second' + responses: + '200': + $ref: '#/components/responses/update_by_query_rethrottle@200' + /_upgrade: + get: + operationId: indices.get_upgrade.0 + x-operation-group: indices.get_upgrade + x-version-added: '1.0' + description: The _upgrade API is no longer useful and will be removed. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.get_upgrade::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_upgrade::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_upgrade::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.get_upgrade@200' + post: + operationId: indices.upgrade.0 + x-operation-group: indices.upgrade + x-version-added: '1.0' + description: The _upgrade API is no longer useful and will be removed. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.upgrade::query.allow_no_indices' + - $ref: '#/components/parameters/indices.upgrade::query.expand_wildcards' + - $ref: '#/components/parameters/indices.upgrade::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.upgrade::query.wait_for_completion' + - $ref: '#/components/parameters/indices.upgrade::query.only_ancient_segments' + responses: + '200': + $ref: '#/components/responses/indices.upgrade@200' + /_validate/query: + get: + operationId: indices.validate_query.0 + x-operation-group: indices.validate_query + x-version-added: '1.0' + description: Allows a user to validate a potentially expensive query without executing it. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.validate_query::query.explain' + - $ref: '#/components/parameters/indices.validate_query::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.validate_query::query.allow_no_indices' + - $ref: '#/components/parameters/indices.validate_query::query.expand_wildcards' + - $ref: '#/components/parameters/indices.validate_query::query.q' + - $ref: '#/components/parameters/indices.validate_query::query.analyzer' + - $ref: '#/components/parameters/indices.validate_query::query.analyze_wildcard' + - $ref: '#/components/parameters/indices.validate_query::query.default_operator' + - $ref: '#/components/parameters/indices.validate_query::query.df' + - $ref: '#/components/parameters/indices.validate_query::query.lenient' + - $ref: '#/components/parameters/indices.validate_query::query.rewrite' + - $ref: '#/components/parameters/indices.validate_query::query.all_shards' + requestBody: + $ref: '#/components/requestBodies/indices.validate_query' + responses: + '200': + $ref: '#/components/responses/indices.validate_query@200' + post: + operationId: indices.validate_query.1 + x-operation-group: indices.validate_query + x-version-added: '1.0' + description: Allows a user to validate a potentially expensive query without executing it. + parameters: + - $ref: '#/components/parameters/indices.validate_query::query.explain' + - $ref: '#/components/parameters/indices.validate_query::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.validate_query::query.allow_no_indices' + - $ref: '#/components/parameters/indices.validate_query::query.expand_wildcards' + - $ref: '#/components/parameters/indices.validate_query::query.q' + - $ref: '#/components/parameters/indices.validate_query::query.analyzer' + - $ref: '#/components/parameters/indices.validate_query::query.analyze_wildcard' + - $ref: '#/components/parameters/indices.validate_query::query.default_operator' + - $ref: '#/components/parameters/indices.validate_query::query.df' + - $ref: '#/components/parameters/indices.validate_query::query.lenient' + - $ref: '#/components/parameters/indices.validate_query::query.rewrite' + - $ref: '#/components/parameters/indices.validate_query::query.all_shards' + requestBody: + $ref: '#/components/requestBodies/indices.validate_query' + responses: + '200': + $ref: '#/components/responses/indices.validate_query@200' + /{alias}/_rollover: + post: + operationId: indices.rollover.0 + x-operation-group: indices.rollover + x-version-added: '1.0' + description: |- + Updates an alias to point to a new index when the existing index + is considered to be too large or too old. + externalDocs: + url: https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/ + parameters: + - $ref: '#/components/parameters/indices.rollover::path.alias' + - $ref: '#/components/parameters/indices.rollover::query.timeout' + - $ref: '#/components/parameters/indices.rollover::query.dry_run' + - $ref: '#/components/parameters/indices.rollover::query.master_timeout' + - $ref: '#/components/parameters/indices.rollover::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.rollover::query.wait_for_active_shards' + requestBody: + $ref: '#/components/requestBodies/indices.rollover' + responses: + '200': + $ref: '#/components/responses/indices.rollover@200' + /{alias}/_rollover/{new_index}: + post: + operationId: indices.rollover.1 + x-operation-group: indices.rollover + x-version-added: '1.0' + description: |- + Updates an alias to point to a new index when the existing index + is considered to be too large or too old. + parameters: + - $ref: '#/components/parameters/indices.rollover::path.alias' + - $ref: '#/components/parameters/indices.rollover::path.new_index' + - $ref: '#/components/parameters/indices.rollover::query.timeout' + - $ref: '#/components/parameters/indices.rollover::query.dry_run' + - $ref: '#/components/parameters/indices.rollover::query.master_timeout' + - $ref: '#/components/parameters/indices.rollover::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.rollover::query.wait_for_active_shards' + requestBody: + $ref: '#/components/requestBodies/indices.rollover' + responses: + '200': + $ref: '#/components/responses/indices.rollover@200' + /{index}: + delete: + operationId: indices.delete.0 + x-operation-group: indices.delete + x-version-added: '1.0' + description: Deletes an index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/ + parameters: + - $ref: '#/components/parameters/indices.delete::path.index' + - $ref: '#/components/parameters/indices.delete::query.timeout' + - $ref: '#/components/parameters/indices.delete::query.master_timeout' + - $ref: '#/components/parameters/indices.delete::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.delete::query.allow_no_indices' + - $ref: '#/components/parameters/indices.delete::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.delete::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.delete@200' + get: + operationId: indices.get.0 + x-operation-group: indices.get + x-version-added: '1.0' + description: Returns information about one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/get-index/ + parameters: + - $ref: '#/components/parameters/indices.get::path.index' + - $ref: '#/components/parameters/indices.get::query.local' + - $ref: '#/components/parameters/indices.get::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get::query.flat_settings' + - $ref: '#/components/parameters/indices.get::query.include_defaults' + - $ref: '#/components/parameters/indices.get::query.master_timeout' + - $ref: '#/components/parameters/indices.get::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/indices.get@200' + head: + operationId: indices.exists.0 + x-operation-group: indices.exists + x-version-added: '1.0' + description: Returns information about whether a particular index exists. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/exists/ + parameters: + - $ref: '#/components/parameters/indices.exists::path.index' + - $ref: '#/components/parameters/indices.exists::query.local' + - $ref: '#/components/parameters/indices.exists::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.exists::query.allow_no_indices' + - $ref: '#/components/parameters/indices.exists::query.expand_wildcards' + - $ref: '#/components/parameters/indices.exists::query.flat_settings' + - $ref: '#/components/parameters/indices.exists::query.include_defaults' + responses: + '200': + $ref: '#/components/responses/indices.exists@200' + put: + operationId: indices.create.0 + x-operation-group: indices.create + x-version-added: '1.0' + description: Creates an index with optional settings and mappings. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/create-index/ + parameters: + - $ref: '#/components/parameters/indices.create::path.index' + - $ref: '#/components/parameters/indices.create::query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.create::query.timeout' + - $ref: '#/components/parameters/indices.create::query.master_timeout' + - $ref: '#/components/parameters/indices.create::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.create' + responses: + '200': + $ref: '#/components/responses/indices.create@200' + /{index}/_alias: + get: + operationId: indices.get_alias.2 + x-operation-group: indices.get_alias + x-version-added: '1.0' + description: Returns an alias. + parameters: + - $ref: '#/components/parameters/indices.get_alias::path.index' + - $ref: '#/components/parameters/indices.get_alias::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_alias::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_alias::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_alias::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_alias@200' + /{index}/_alias/{name}: + delete: + operationId: indices.delete_alias.0 + x-operation-group: indices.delete_alias + x-version-added: '1.0' + description: Deletes an alias. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases + parameters: + - $ref: '#/components/parameters/indices.delete_alias::path.index' + - $ref: '#/components/parameters/indices.delete_alias::path.name' + - $ref: '#/components/parameters/indices.delete_alias::query.timeout' + - $ref: '#/components/parameters/indices.delete_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.delete_alias::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/indices.delete_alias@200' + get: + operationId: indices.get_alias.3 + x-operation-group: indices.get_alias + x-version-added: '1.0' + description: Returns an alias. + parameters: + - $ref: '#/components/parameters/indices.get_alias::path.index' + - $ref: '#/components/parameters/indices.get_alias::path.name' + - $ref: '#/components/parameters/indices.get_alias::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_alias::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_alias::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_alias::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_alias@200' + head: + operationId: indices.exists_alias.1 + x-operation-group: indices.exists_alias + x-version-added: '1.0' + description: Returns information about whether a particular alias exists. + parameters: + - $ref: '#/components/parameters/indices.exists_alias::path.index' + - $ref: '#/components/parameters/indices.exists_alias::path.name' + - $ref: '#/components/parameters/indices.exists_alias::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.exists_alias::query.allow_no_indices' + - $ref: '#/components/parameters/indices.exists_alias::query.expand_wildcards' + - $ref: '#/components/parameters/indices.exists_alias::query.local' + responses: + '200': + $ref: '#/components/responses/indices.exists_alias@200' + post: + operationId: indices.put_alias.0 + x-operation-group: indices.put_alias + x-version-added: '1.0' + description: Creates or updates an alias. + parameters: + - $ref: '#/components/parameters/indices.put_alias::path.index' + - $ref: '#/components/parameters/indices.put_alias::path.name' + - $ref: '#/components/parameters/indices.put_alias::query.timeout' + - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.put_alias' + responses: + '200': + $ref: '#/components/responses/indices.put_alias@200' + put: + operationId: indices.put_alias.1 + x-operation-group: indices.put_alias + x-version-added: '1.0' + description: Creates or updates an alias. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + parameters: + - $ref: '#/components/parameters/indices.put_alias::path.index' + - $ref: '#/components/parameters/indices.put_alias::path.name' + - $ref: '#/components/parameters/indices.put_alias::query.timeout' + - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.put_alias' + responses: + '200': + $ref: '#/components/responses/indices.put_alias@200' + /{index}/_aliases/{name}: + delete: + operationId: indices.delete_alias.1 + x-operation-group: indices.delete_alias + x-version-added: '1.0' + description: Deletes an alias. + parameters: + - $ref: '#/components/parameters/indices.delete_alias::path.index' + - $ref: '#/components/parameters/indices.delete_alias::path.name' + - $ref: '#/components/parameters/indices.delete_alias::query.timeout' + - $ref: '#/components/parameters/indices.delete_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.delete_alias::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/indices.delete_alias@200' + post: + operationId: indices.put_alias.2 + x-operation-group: indices.put_alias + x-version-added: '1.0' + description: Creates or updates an alias. + parameters: + - $ref: '#/components/parameters/indices.put_alias::path.index' + - $ref: '#/components/parameters/indices.put_alias::path.name' + - $ref: '#/components/parameters/indices.put_alias::query.timeout' + - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.put_alias' + responses: + '200': + $ref: '#/components/responses/indices.put_alias@200' + put: + operationId: indices.put_alias.3 + x-operation-group: indices.put_alias + x-version-added: '1.0' + description: Creates or updates an alias. + parameters: + - $ref: '#/components/parameters/indices.put_alias::path.index' + - $ref: '#/components/parameters/indices.put_alias::path.name' + - $ref: '#/components/parameters/indices.put_alias::query.timeout' + - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.put_alias' + responses: + '200': + $ref: '#/components/responses/indices.put_alias@200' + /{index}/_analyze: + get: + operationId: indices.analyze.2 + x-operation-group: indices.analyze + x-version-added: '1.0' + description: Performs the analysis process on a text and return the tokens breakdown of the text. + parameters: + - $ref: '#/components/parameters/indices.analyze::path.index' + - $ref: '#/components/parameters/indices.analyze::query.index' + requestBody: + $ref: '#/components/requestBodies/indices.analyze' + responses: + '200': + $ref: '#/components/responses/indices.analyze@200' + post: + operationId: indices.analyze.3 + x-operation-group: indices.analyze + x-version-added: '1.0' + description: Performs the analysis process on a text and return the tokens breakdown of the text. + parameters: + - $ref: '#/components/parameters/indices.analyze::path.index' + - $ref: '#/components/parameters/indices.analyze::query.index' + requestBody: + $ref: '#/components/requestBodies/indices.analyze' + responses: + '200': + $ref: '#/components/responses/indices.analyze@200' + /{index}/_block/{block}: + put: + operationId: indices.add_block.0 + x-operation-group: indices.add_block + x-version-added: '1.0' + description: Adds a block to an index. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.add_block::path.index' + - $ref: '#/components/parameters/indices.add_block::path.block' + - $ref: '#/components/parameters/indices.add_block::query.timeout' + - $ref: '#/components/parameters/indices.add_block::query.master_timeout' + - $ref: '#/components/parameters/indices.add_block::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.add_block::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.add_block::query.allow_no_indices' + - $ref: '#/components/parameters/indices.add_block::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.add_block@200' + /{index}/_bulk: + post: + operationId: bulk.2 + x-operation-group: bulk + x-version-added: '1.0' + description: Allows to perform multiple index/update/delete operations in a single request. + parameters: + - $ref: '#/components/parameters/bulk::path.index' + - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' + - $ref: '#/components/parameters/bulk::query.refresh' + - $ref: '#/components/parameters/bulk::query.routing' + - $ref: '#/components/parameters/bulk::query.timeout' + - $ref: '#/components/parameters/bulk::query.type' + - $ref: '#/components/parameters/bulk::query._source' + - $ref: '#/components/parameters/bulk::query._source_excludes' + - $ref: '#/components/parameters/bulk::query._source_includes' + - $ref: '#/components/parameters/bulk::query.pipeline' + - $ref: '#/components/parameters/bulk::query.require_alias' + requestBody: + $ref: '#/components/requestBodies/bulk' + responses: + '200': + $ref: '#/components/responses/bulk@200' + put: + operationId: bulk.3 + x-operation-group: bulk + x-version-added: '1.0' + description: Allows to perform multiple index/update/delete operations in a single request. + parameters: + - $ref: '#/components/parameters/bulk::path.index' + - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' + - $ref: '#/components/parameters/bulk::query.refresh' + - $ref: '#/components/parameters/bulk::query.routing' + - $ref: '#/components/parameters/bulk::query.timeout' + - $ref: '#/components/parameters/bulk::query.type' + - $ref: '#/components/parameters/bulk::query._source' + - $ref: '#/components/parameters/bulk::query._source_excludes' + - $ref: '#/components/parameters/bulk::query._source_includes' + - $ref: '#/components/parameters/bulk::query.pipeline' + - $ref: '#/components/parameters/bulk::query.require_alias' + requestBody: + $ref: '#/components/requestBodies/bulk' + responses: + '200': + $ref: '#/components/responses/bulk@200' + /{index}/_cache/clear: + post: + operationId: indices.clear_cache.1 + x-operation-group: indices.clear_cache + x-version-added: '1.0' + description: Clears all or specific caches for one or more indices. + parameters: + - $ref: '#/components/parameters/indices.clear_cache::path.index' + - $ref: '#/components/parameters/indices.clear_cache::query.fielddata' + - $ref: '#/components/parameters/indices.clear_cache::query.fields' + - $ref: '#/components/parameters/indices.clear_cache::query.query' + - $ref: '#/components/parameters/indices.clear_cache::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.clear_cache::query.allow_no_indices' + - $ref: '#/components/parameters/indices.clear_cache::query.expand_wildcards' + - $ref: '#/components/parameters/indices.clear_cache::query.index' + - $ref: '#/components/parameters/indices.clear_cache::query.request' + responses: + '200': + $ref: '#/components/responses/indices.clear_cache@200' + /{index}/_clone/{target}: + post: + operationId: indices.clone.0 + x-operation-group: indices.clone + x-version-added: '1.0' + description: Clones an index. + parameters: + - $ref: '#/components/parameters/indices.clone::path.index' + - $ref: '#/components/parameters/indices.clone::path.target' + - $ref: '#/components/parameters/indices.clone::query.timeout' + - $ref: '#/components/parameters/indices.clone::query.master_timeout' + - $ref: '#/components/parameters/indices.clone::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.clone::query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.clone::query.wait_for_completion' + - $ref: '#/components/parameters/indices.clone::query.task_execution_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.clone' + responses: + '200': + $ref: '#/components/responses/indices.clone@200' + put: + operationId: indices.clone.1 + x-operation-group: indices.clone + x-version-added: '1.0' + description: Clones an index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/clone/ + parameters: + - $ref: '#/components/parameters/indices.clone::path.index' + - $ref: '#/components/parameters/indices.clone::path.target' + - $ref: '#/components/parameters/indices.clone::query.timeout' + - $ref: '#/components/parameters/indices.clone::query.master_timeout' + - $ref: '#/components/parameters/indices.clone::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.clone::query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.clone::query.wait_for_completion' + - $ref: '#/components/parameters/indices.clone::query.task_execution_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.clone' + responses: + '200': + $ref: '#/components/responses/indices.clone@200' + /{index}/_close: + post: + operationId: indices.close.0 + x-operation-group: indices.close + x-version-added: '1.0' + description: Closes an index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/close-index/ + parameters: + - $ref: '#/components/parameters/indices.close::path.index' + - $ref: '#/components/parameters/indices.close::query.timeout' + - $ref: '#/components/parameters/indices.close::query.master_timeout' + - $ref: '#/components/parameters/indices.close::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.close::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.close::query.allow_no_indices' + - $ref: '#/components/parameters/indices.close::query.expand_wildcards' + - $ref: '#/components/parameters/indices.close::query.wait_for_active_shards' + responses: + '200': + $ref: '#/components/responses/indices.close@200' + /{index}/_count: + get: + operationId: count.2 + x-operation-group: count + x-version-added: '1.0' + description: Returns number of documents matching a query. + parameters: + - $ref: '#/components/parameters/count::path.index' + - $ref: '#/components/parameters/count::query.ignore_unavailable' + - $ref: '#/components/parameters/count::query.ignore_throttled' + - $ref: '#/components/parameters/count::query.allow_no_indices' + - $ref: '#/components/parameters/count::query.expand_wildcards' + - $ref: '#/components/parameters/count::query.min_score' + - $ref: '#/components/parameters/count::query.preference' + - $ref: '#/components/parameters/count::query.routing' + - $ref: '#/components/parameters/count::query.q' + - $ref: '#/components/parameters/count::query.analyzer' + - $ref: '#/components/parameters/count::query.analyze_wildcard' + - $ref: '#/components/parameters/count::query.default_operator' + - $ref: '#/components/parameters/count::query.df' + - $ref: '#/components/parameters/count::query.lenient' + - $ref: '#/components/parameters/count::query.terminate_after' + requestBody: + $ref: '#/components/requestBodies/count' + responses: + '200': + $ref: '#/components/responses/count@200' + post: + operationId: count.3 + x-operation-group: count + x-version-added: '1.0' + description: Returns number of documents matching a query. + parameters: + - $ref: '#/components/parameters/count::path.index' + - $ref: '#/components/parameters/count::query.ignore_unavailable' + - $ref: '#/components/parameters/count::query.ignore_throttled' + - $ref: '#/components/parameters/count::query.allow_no_indices' + - $ref: '#/components/parameters/count::query.expand_wildcards' + - $ref: '#/components/parameters/count::query.min_score' + - $ref: '#/components/parameters/count::query.preference' + - $ref: '#/components/parameters/count::query.routing' + - $ref: '#/components/parameters/count::query.q' + - $ref: '#/components/parameters/count::query.analyzer' + - $ref: '#/components/parameters/count::query.analyze_wildcard' + - $ref: '#/components/parameters/count::query.default_operator' + - $ref: '#/components/parameters/count::query.df' + - $ref: '#/components/parameters/count::query.lenient' + - $ref: '#/components/parameters/count::query.terminate_after' + requestBody: + $ref: '#/components/requestBodies/count' + responses: + '200': + $ref: '#/components/responses/count@200' + /{index}/_create/{id}: + post: + operationId: create.0 + x-operation-group: create + x-version-added: '1.0' + description: |- + Creates a new document in the index. + + Returns a 409 response when a document with a same ID already exists in the index. + parameters: + - $ref: '#/components/parameters/create::path.id' + - $ref: '#/components/parameters/create::path.index' + - $ref: '#/components/parameters/create::query.wait_for_active_shards' + - $ref: '#/components/parameters/create::query.refresh' + - $ref: '#/components/parameters/create::query.routing' + - $ref: '#/components/parameters/create::query.timeout' + - $ref: '#/components/parameters/create::query.version' + - $ref: '#/components/parameters/create::query.version_type' + - $ref: '#/components/parameters/create::query.pipeline' + requestBody: + $ref: '#/components/requestBodies/create' + responses: + '200': + $ref: '#/components/responses/create@200' + put: + operationId: create.1 + x-operation-group: create + x-version-added: '1.0' + description: |- + Creates a new document in the index. + + Returns a 409 response when a document with a same ID already exists in the index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ + parameters: + - $ref: '#/components/parameters/create::path.id' + - $ref: '#/components/parameters/create::path.index' + - $ref: '#/components/parameters/create::query.wait_for_active_shards' + - $ref: '#/components/parameters/create::query.refresh' + - $ref: '#/components/parameters/create::query.routing' + - $ref: '#/components/parameters/create::query.timeout' + - $ref: '#/components/parameters/create::query.version' + - $ref: '#/components/parameters/create::query.version_type' + - $ref: '#/components/parameters/create::query.pipeline' + requestBody: + $ref: '#/components/requestBodies/create' + responses: + '200': + $ref: '#/components/responses/create@200' + /{index}/_delete_by_query: + post: + operationId: delete_by_query.0 + x-operation-group: delete_by_query + x-version-added: '1.0' + description: Deletes documents matching the provided query. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/ + parameters: + - $ref: '#/components/parameters/delete_by_query::path.index' + - $ref: '#/components/parameters/delete_by_query::query.analyzer' + - $ref: '#/components/parameters/delete_by_query::query.analyze_wildcard' + - $ref: '#/components/parameters/delete_by_query::query.default_operator' + - $ref: '#/components/parameters/delete_by_query::query.df' + - $ref: '#/components/parameters/delete_by_query::query.from' + - $ref: '#/components/parameters/delete_by_query::query.ignore_unavailable' + - $ref: '#/components/parameters/delete_by_query::query.allow_no_indices' + - $ref: '#/components/parameters/delete_by_query::query.conflicts' + - $ref: '#/components/parameters/delete_by_query::query.expand_wildcards' + - $ref: '#/components/parameters/delete_by_query::query.lenient' + - $ref: '#/components/parameters/delete_by_query::query.preference' + - $ref: '#/components/parameters/delete_by_query::query.q' + - $ref: '#/components/parameters/delete_by_query::query.routing' + - $ref: '#/components/parameters/delete_by_query::query.scroll' + - $ref: '#/components/parameters/delete_by_query::query.search_type' + - $ref: '#/components/parameters/delete_by_query::query.search_timeout' + - $ref: '#/components/parameters/delete_by_query::query.size' + - $ref: '#/components/parameters/delete_by_query::query.max_docs' + - $ref: '#/components/parameters/delete_by_query::query.sort' + - $ref: '#/components/parameters/delete_by_query::query._source' + - $ref: '#/components/parameters/delete_by_query::query._source_excludes' + - $ref: '#/components/parameters/delete_by_query::query._source_includes' + - $ref: '#/components/parameters/delete_by_query::query.terminate_after' + - $ref: '#/components/parameters/delete_by_query::query.stats' + - $ref: '#/components/parameters/delete_by_query::query.version' + - $ref: '#/components/parameters/delete_by_query::query.request_cache' + - $ref: '#/components/parameters/delete_by_query::query.refresh' + - $ref: '#/components/parameters/delete_by_query::query.timeout' + - $ref: '#/components/parameters/delete_by_query::query.wait_for_active_shards' + - $ref: '#/components/parameters/delete_by_query::query.scroll_size' + - $ref: '#/components/parameters/delete_by_query::query.wait_for_completion' + - $ref: '#/components/parameters/delete_by_query::query.requests_per_second' + - $ref: '#/components/parameters/delete_by_query::query.slices' + requestBody: + $ref: '#/components/requestBodies/delete_by_query' + responses: + '200': + $ref: '#/components/responses/delete_by_query@200' + /{index}/_doc: + post: + operationId: index.0 + x-operation-group: index + x-version-added: '1.0' + description: Creates or updates a document in an index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ + parameters: + - $ref: '#/components/parameters/index::path.index' + - $ref: '#/components/parameters/index::query.wait_for_active_shards' + - $ref: '#/components/parameters/index::query.op_type' + - $ref: '#/components/parameters/index::query.refresh' + - $ref: '#/components/parameters/index::query.routing' + - $ref: '#/components/parameters/index::query.timeout' + - $ref: '#/components/parameters/index::query.version' + - $ref: '#/components/parameters/index::query.version_type' + - $ref: '#/components/parameters/index::query.if_seq_no' + - $ref: '#/components/parameters/index::query.if_primary_term' + - $ref: '#/components/parameters/index::query.pipeline' + - $ref: '#/components/parameters/index::query.require_alias' + requestBody: + $ref: '#/components/requestBodies/index' + responses: + '200': + $ref: '#/components/responses/index@200' + /{index}/_doc/{id}: + delete: + operationId: delete.0 + x-operation-group: delete + x-version-added: '1.0' + description: Removes a document from the index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/delete-document/ + parameters: + - $ref: '#/components/parameters/delete::path.id' + - $ref: '#/components/parameters/delete::path.index' + - $ref: '#/components/parameters/delete::query.wait_for_active_shards' + - $ref: '#/components/parameters/delete::query.refresh' + - $ref: '#/components/parameters/delete::query.routing' + - $ref: '#/components/parameters/delete::query.timeout' + - $ref: '#/components/parameters/delete::query.if_seq_no' + - $ref: '#/components/parameters/delete::query.if_primary_term' + - $ref: '#/components/parameters/delete::query.version' + - $ref: '#/components/parameters/delete::query.version_type' + responses: + '200': + $ref: '#/components/responses/delete@200' + get: + operationId: get.0 + x-operation-group: get + x-version-added: '1.0' + description: Returns a document. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ + parameters: + - $ref: '#/components/parameters/get::path.id' + - $ref: '#/components/parameters/get::path.index' + - $ref: '#/components/parameters/get::query.stored_fields' + - $ref: '#/components/parameters/get::query.preference' + - $ref: '#/components/parameters/get::query.realtime' + - $ref: '#/components/parameters/get::query.refresh' + - $ref: '#/components/parameters/get::query.routing' + - $ref: '#/components/parameters/get::query._source' + - $ref: '#/components/parameters/get::query._source_excludes' + - $ref: '#/components/parameters/get::query._source_includes' + - $ref: '#/components/parameters/get::query.version' + - $ref: '#/components/parameters/get::query.version_type' + responses: + '200': + $ref: '#/components/responses/get@200' + head: + operationId: exists.0 + x-operation-group: exists + x-version-added: '1.0' + description: Returns information about whether a document exists in an index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ + parameters: + - $ref: '#/components/parameters/exists::path.id' + - $ref: '#/components/parameters/exists::path.index' + - $ref: '#/components/parameters/exists::query.stored_fields' + - $ref: '#/components/parameters/exists::query.preference' + - $ref: '#/components/parameters/exists::query.realtime' + - $ref: '#/components/parameters/exists::query.refresh' + - $ref: '#/components/parameters/exists::query.routing' + - $ref: '#/components/parameters/exists::query._source' + - $ref: '#/components/parameters/exists::query._source_excludes' + - $ref: '#/components/parameters/exists::query._source_includes' + - $ref: '#/components/parameters/exists::query.version' + - $ref: '#/components/parameters/exists::query.version_type' + responses: + '200': + $ref: '#/components/responses/exists@200' + post: + operationId: index.1 + x-operation-group: index + x-version-added: '1.0' + description: Creates or updates a document in an index. + parameters: + - $ref: '#/components/parameters/index::path.id' + - $ref: '#/components/parameters/index::path.index' + - $ref: '#/components/parameters/index::query.wait_for_active_shards' + - $ref: '#/components/parameters/index::query.op_type' + - $ref: '#/components/parameters/index::query.refresh' + - $ref: '#/components/parameters/index::query.routing' + - $ref: '#/components/parameters/index::query.timeout' + - $ref: '#/components/parameters/index::query.version' + - $ref: '#/components/parameters/index::query.version_type' + - $ref: '#/components/parameters/index::query.if_seq_no' + - $ref: '#/components/parameters/index::query.if_primary_term' + - $ref: '#/components/parameters/index::query.pipeline' + - $ref: '#/components/parameters/index::query.require_alias' + requestBody: + $ref: '#/components/requestBodies/index' + responses: + '200': + $ref: '#/components/responses/index@200' + put: + operationId: index.2 + x-operation-group: index + x-version-added: '1.0' + description: Creates or updates a document in an index. + parameters: + - $ref: '#/components/parameters/index::path.id' + - $ref: '#/components/parameters/index::path.index' + - $ref: '#/components/parameters/index::query.wait_for_active_shards' + - $ref: '#/components/parameters/index::query.op_type' + - $ref: '#/components/parameters/index::query.refresh' + - $ref: '#/components/parameters/index::query.routing' + - $ref: '#/components/parameters/index::query.timeout' + - $ref: '#/components/parameters/index::query.version' + - $ref: '#/components/parameters/index::query.version_type' + - $ref: '#/components/parameters/index::query.if_seq_no' + - $ref: '#/components/parameters/index::query.if_primary_term' + - $ref: '#/components/parameters/index::query.pipeline' + - $ref: '#/components/parameters/index::query.require_alias' + requestBody: + $ref: '#/components/requestBodies/index' + responses: + '200': + $ref: '#/components/responses/index@200' + /{index}/_explain/{id}: + get: + operationId: explain.0 + x-operation-group: explain + x-version-added: '1.0' + description: Returns information about why a specific matches (or doesn't match) a query. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/explain/ + parameters: + - $ref: '#/components/parameters/explain::path.id' + - $ref: '#/components/parameters/explain::path.index' + - $ref: '#/components/parameters/explain::query.analyze_wildcard' + - $ref: '#/components/parameters/explain::query.analyzer' + - $ref: '#/components/parameters/explain::query.default_operator' + - $ref: '#/components/parameters/explain::query.df' + - $ref: '#/components/parameters/explain::query.stored_fields' + - $ref: '#/components/parameters/explain::query.lenient' + - $ref: '#/components/parameters/explain::query.preference' + - $ref: '#/components/parameters/explain::query.q' + - $ref: '#/components/parameters/explain::query.routing' + - $ref: '#/components/parameters/explain::query._source' + - $ref: '#/components/parameters/explain::query._source_excludes' + - $ref: '#/components/parameters/explain::query._source_includes' + requestBody: + $ref: '#/components/requestBodies/explain' + responses: + '200': + $ref: '#/components/responses/explain@200' + post: + operationId: explain.1 + x-operation-group: explain + x-version-added: '1.0' + description: Returns information about why a specific matches (or doesn't match) a query. + parameters: + - $ref: '#/components/parameters/explain::path.id' + - $ref: '#/components/parameters/explain::path.index' + - $ref: '#/components/parameters/explain::query.analyze_wildcard' + - $ref: '#/components/parameters/explain::query.analyzer' + - $ref: '#/components/parameters/explain::query.default_operator' + - $ref: '#/components/parameters/explain::query.df' + - $ref: '#/components/parameters/explain::query.stored_fields' + - $ref: '#/components/parameters/explain::query.lenient' + - $ref: '#/components/parameters/explain::query.preference' + - $ref: '#/components/parameters/explain::query.q' + - $ref: '#/components/parameters/explain::query.routing' + - $ref: '#/components/parameters/explain::query._source' + - $ref: '#/components/parameters/explain::query._source_excludes' + - $ref: '#/components/parameters/explain::query._source_includes' + requestBody: + $ref: '#/components/requestBodies/explain' + responses: + '200': + $ref: '#/components/responses/explain@200' + /{index}/_field_caps: + get: + operationId: field_caps.2 + x-operation-group: field_caps + x-version-added: '1.0' + description: Returns the information about the capabilities of fields among multiple indices. + parameters: + - $ref: '#/components/parameters/field_caps::path.index' + - $ref: '#/components/parameters/field_caps::query.fields' + - $ref: '#/components/parameters/field_caps::query.ignore_unavailable' + - $ref: '#/components/parameters/field_caps::query.allow_no_indices' + - $ref: '#/components/parameters/field_caps::query.expand_wildcards' + - $ref: '#/components/parameters/field_caps::query.include_unmapped' + requestBody: + $ref: '#/components/requestBodies/field_caps' + responses: + '200': + $ref: '#/components/responses/field_caps@200' + post: + operationId: field_caps.3 + x-operation-group: field_caps + x-version-added: '1.0' + description: Returns the information about the capabilities of fields among multiple indices. + parameters: + - $ref: '#/components/parameters/field_caps::path.index' + - $ref: '#/components/parameters/field_caps::query.fields' + - $ref: '#/components/parameters/field_caps::query.ignore_unavailable' + - $ref: '#/components/parameters/field_caps::query.allow_no_indices' + - $ref: '#/components/parameters/field_caps::query.expand_wildcards' + - $ref: '#/components/parameters/field_caps::query.include_unmapped' + requestBody: + $ref: '#/components/requestBodies/field_caps' + responses: + '200': + $ref: '#/components/responses/field_caps@200' + /{index}/_flush: + get: + operationId: indices.flush.2 + x-operation-group: indices.flush + x-version-added: '1.0' + description: Performs the flush operation on one or more indices. + parameters: + - $ref: '#/components/parameters/indices.flush::path.index' + - $ref: '#/components/parameters/indices.flush::query.force' + - $ref: '#/components/parameters/indices.flush::query.wait_if_ongoing' + - $ref: '#/components/parameters/indices.flush::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.flush::query.allow_no_indices' + - $ref: '#/components/parameters/indices.flush::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.flush@200' + post: + operationId: indices.flush.3 + x-operation-group: indices.flush + x-version-added: '1.0' + description: Performs the flush operation on one or more indices. + parameters: + - $ref: '#/components/parameters/indices.flush::path.index' + - $ref: '#/components/parameters/indices.flush::query.force' + - $ref: '#/components/parameters/indices.flush::query.wait_if_ongoing' + - $ref: '#/components/parameters/indices.flush::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.flush::query.allow_no_indices' + - $ref: '#/components/parameters/indices.flush::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.flush@200' + /{index}/_forcemerge: + post: + operationId: indices.forcemerge.1 + x-operation-group: indices.forcemerge + x-version-added: '1.0' + description: Performs the force merge operation on one or more indices. + parameters: + - $ref: '#/components/parameters/indices.forcemerge::path.index' + - $ref: '#/components/parameters/indices.forcemerge::query.flush' + - $ref: '#/components/parameters/indices.forcemerge::query.primary_only' + - $ref: '#/components/parameters/indices.forcemerge::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.forcemerge::query.allow_no_indices' + - $ref: '#/components/parameters/indices.forcemerge::query.expand_wildcards' + - $ref: '#/components/parameters/indices.forcemerge::query.max_num_segments' + - $ref: '#/components/parameters/indices.forcemerge::query.only_expunge_deletes' + - $ref: '#/components/parameters/indices.forcemerge::query.wait_for_completion' + responses: + '200': + $ref: '#/components/responses/indices.forcemerge@200' + /{index}/_mapping: + get: + operationId: indices.get_mapping.1 + x-operation-group: indices.get_mapping + x-version-added: '1.0' + description: Returns mappings for one or more indices. + parameters: + - $ref: '#/components/parameters/indices.get_mapping::path.index' + - $ref: '#/components/parameters/indices.get_mapping::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_mapping::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_mapping::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_mapping::query.master_timeout' + - $ref: '#/components/parameters/indices.get_mapping::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_mapping::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_mapping@200' + post: + operationId: indices.put_mapping.0 + x-operation-group: indices.put_mapping + x-version-added: '1.0' + description: Updates the index mappings. + parameters: + - $ref: '#/components/parameters/indices.put_mapping::path.index' + - $ref: '#/components/parameters/indices.put_mapping::query.timeout' + - $ref: '#/components/parameters/indices.put_mapping::query.master_timeout' + - $ref: '#/components/parameters/indices.put_mapping::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_mapping::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.put_mapping::query.allow_no_indices' + - $ref: '#/components/parameters/indices.put_mapping::query.expand_wildcards' + - $ref: '#/components/parameters/indices.put_mapping::query.write_index_only' + requestBody: + $ref: '#/components/requestBodies/indices.put_mapping' + responses: + '200': + $ref: '#/components/responses/indices.put_mapping@200' + put: + operationId: indices.put_mapping.1 + x-operation-group: indices.put_mapping + x-version-added: '1.0' + description: Updates the index mappings. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/ + parameters: + - $ref: '#/components/parameters/indices.put_mapping::path.index' + - $ref: '#/components/parameters/indices.put_mapping::query.timeout' + - $ref: '#/components/parameters/indices.put_mapping::query.master_timeout' + - $ref: '#/components/parameters/indices.put_mapping::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_mapping::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.put_mapping::query.allow_no_indices' + - $ref: '#/components/parameters/indices.put_mapping::query.expand_wildcards' + - $ref: '#/components/parameters/indices.put_mapping::query.write_index_only' + requestBody: + $ref: '#/components/requestBodies/indices.put_mapping' + responses: + '200': + $ref: '#/components/responses/indices.put_mapping@200' + /{index}/_mapping/field/{fields}: + get: + operationId: indices.get_field_mapping.1 + x-operation-group: indices.get_field_mapping + x-version-added: '1.0' + description: Returns mapping for one or more fields. + parameters: + - $ref: '#/components/parameters/indices.get_field_mapping::path.index' + - $ref: '#/components/parameters/indices.get_field_mapping::path.fields' + - $ref: '#/components/parameters/indices.get_field_mapping::query.include_defaults' + - $ref: '#/components/parameters/indices.get_field_mapping::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_field_mapping::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_field_mapping::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_field_mapping::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_field_mapping@200' + /{index}/_mget: + get: + operationId: mget.2 + x-operation-group: mget + x-version-added: '1.0' + description: Allows to get multiple documents in one request. + parameters: + - $ref: '#/components/parameters/mget::path.index' + - $ref: '#/components/parameters/mget::query.stored_fields' + - $ref: '#/components/parameters/mget::query.preference' + - $ref: '#/components/parameters/mget::query.realtime' + - $ref: '#/components/parameters/mget::query.refresh' + - $ref: '#/components/parameters/mget::query.routing' + - $ref: '#/components/parameters/mget::query._source' + - $ref: '#/components/parameters/mget::query._source_excludes' + - $ref: '#/components/parameters/mget::query._source_includes' + requestBody: + $ref: '#/components/requestBodies/mget' + responses: + '200': + $ref: '#/components/responses/mget@200' + post: + operationId: mget.3 + x-operation-group: mget + x-version-added: '1.0' + description: Allows to get multiple documents in one request. + parameters: + - $ref: '#/components/parameters/mget::path.index' + - $ref: '#/components/parameters/mget::query.stored_fields' + - $ref: '#/components/parameters/mget::query.preference' + - $ref: '#/components/parameters/mget::query.realtime' + - $ref: '#/components/parameters/mget::query.refresh' + - $ref: '#/components/parameters/mget::query.routing' + - $ref: '#/components/parameters/mget::query._source' + - $ref: '#/components/parameters/mget::query._source_excludes' + - $ref: '#/components/parameters/mget::query._source_includes' + requestBody: + $ref: '#/components/requestBodies/mget' + responses: + '200': + $ref: '#/components/responses/mget@200' + /{index}/_msearch: + get: + operationId: msearch.2 + x-operation-group: msearch + x-version-added: '1.0' + description: Allows to execute several search operations in one request. + parameters: + - $ref: '#/components/parameters/msearch::path.index' + - $ref: '#/components/parameters/msearch::query.search_type' + - $ref: '#/components/parameters/msearch::query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch::query.typed_keys' + - $ref: '#/components/parameters/msearch::query.pre_filter_shard_size' + - $ref: '#/components/parameters/msearch::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/msearch::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/msearch' + responses: + '200': + $ref: '#/components/responses/msearch@200' + post: + operationId: msearch.3 + x-operation-group: msearch + x-version-added: '1.0' + description: Allows to execute several search operations in one request. + parameters: + - $ref: '#/components/parameters/msearch::path.index' + - $ref: '#/components/parameters/msearch::query.search_type' + - $ref: '#/components/parameters/msearch::query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch::query.typed_keys' + - $ref: '#/components/parameters/msearch::query.pre_filter_shard_size' + - $ref: '#/components/parameters/msearch::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/msearch::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/msearch' + responses: + '200': + $ref: '#/components/responses/msearch@200' + /{index}/_msearch/template: + get: + operationId: msearch_template.2 + x-operation-group: msearch_template + x-version-added: '1.0' + description: Allows to execute several search template operations in one request. + parameters: + - $ref: '#/components/parameters/msearch_template::path.index' + - $ref: '#/components/parameters/msearch_template::query.search_type' + - $ref: '#/components/parameters/msearch_template::query.typed_keys' + - $ref: '#/components/parameters/msearch_template::query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch_template::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch_template::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/msearch_template' + responses: + '200': + $ref: '#/components/responses/msearch_template@200' + post: + operationId: msearch_template.3 + x-operation-group: msearch_template + x-version-added: '1.0' + description: Allows to execute several search template operations in one request. + parameters: + - $ref: '#/components/parameters/msearch_template::path.index' + - $ref: '#/components/parameters/msearch_template::query.search_type' + - $ref: '#/components/parameters/msearch_template::query.typed_keys' + - $ref: '#/components/parameters/msearch_template::query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch_template::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch_template::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/msearch_template' + responses: + '200': + $ref: '#/components/responses/msearch_template@200' + /{index}/_mtermvectors: + get: + operationId: mtermvectors.2 + x-operation-group: mtermvectors + x-version-added: '1.0' + description: Returns multiple termvectors in one request. + parameters: + - $ref: '#/components/parameters/mtermvectors::path.index' + - $ref: '#/components/parameters/mtermvectors::query.ids' + - $ref: '#/components/parameters/mtermvectors::query.term_statistics' + - $ref: '#/components/parameters/mtermvectors::query.field_statistics' + - $ref: '#/components/parameters/mtermvectors::query.fields' + - $ref: '#/components/parameters/mtermvectors::query.offsets' + - $ref: '#/components/parameters/mtermvectors::query.positions' + - $ref: '#/components/parameters/mtermvectors::query.payloads' + - $ref: '#/components/parameters/mtermvectors::query.preference' + - $ref: '#/components/parameters/mtermvectors::query.routing' + - $ref: '#/components/parameters/mtermvectors::query.realtime' + - $ref: '#/components/parameters/mtermvectors::query.version' + - $ref: '#/components/parameters/mtermvectors::query.version_type' + requestBody: + $ref: '#/components/requestBodies/mtermvectors' + responses: + '200': + $ref: '#/components/responses/mtermvectors@200' + post: + operationId: mtermvectors.3 + x-operation-group: mtermvectors + x-version-added: '1.0' + description: Returns multiple termvectors in one request. + parameters: + - $ref: '#/components/parameters/mtermvectors::path.index' + - $ref: '#/components/parameters/mtermvectors::query.ids' + - $ref: '#/components/parameters/mtermvectors::query.term_statistics' + - $ref: '#/components/parameters/mtermvectors::query.field_statistics' + - $ref: '#/components/parameters/mtermvectors::query.fields' + - $ref: '#/components/parameters/mtermvectors::query.offsets' + - $ref: '#/components/parameters/mtermvectors::query.positions' + - $ref: '#/components/parameters/mtermvectors::query.payloads' + - $ref: '#/components/parameters/mtermvectors::query.preference' + - $ref: '#/components/parameters/mtermvectors::query.routing' + - $ref: '#/components/parameters/mtermvectors::query.realtime' + - $ref: '#/components/parameters/mtermvectors::query.version' + - $ref: '#/components/parameters/mtermvectors::query.version_type' + requestBody: + $ref: '#/components/requestBodies/mtermvectors' + responses: + '200': + $ref: '#/components/responses/mtermvectors@200' + /{index}/_open: + post: + operationId: indices.open.0 + x-operation-group: indices.open + x-version-added: '1.0' + description: Opens an index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/open-index/ + parameters: + - $ref: '#/components/parameters/indices.open::path.index' + - $ref: '#/components/parameters/indices.open::query.timeout' + - $ref: '#/components/parameters/indices.open::query.master_timeout' + - $ref: '#/components/parameters/indices.open::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.open::query.allow_no_indices' + - $ref: '#/components/parameters/indices.open::query.expand_wildcards' + - $ref: '#/components/parameters/indices.open::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.open::query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.open::query.wait_for_completion' + - $ref: '#/components/parameters/indices.open::query.task_execution_timeout' + responses: + '200': + $ref: '#/components/responses/indices.open@200' + /{index}/_rank_eval: + get: + operationId: rank_eval.2 + x-operation-group: rank_eval + x-version-added: '1.0' + description: Allows to evaluate the quality of ranked search results over a set of typical search queries. + parameters: + - $ref: '#/components/parameters/rank_eval::path.index' + - $ref: '#/components/parameters/rank_eval::query.ignore_unavailable' + - $ref: '#/components/parameters/rank_eval::query.allow_no_indices' + - $ref: '#/components/parameters/rank_eval::query.expand_wildcards' + - $ref: '#/components/parameters/rank_eval::query.search_type' + requestBody: + $ref: '#/components/requestBodies/rank_eval' + responses: + '200': + $ref: '#/components/responses/rank_eval@200' + post: + operationId: rank_eval.3 + x-operation-group: rank_eval + x-version-added: '1.0' + description: Allows to evaluate the quality of ranked search results over a set of typical search queries. + parameters: + - $ref: '#/components/parameters/rank_eval::path.index' + - $ref: '#/components/parameters/rank_eval::query.ignore_unavailable' + - $ref: '#/components/parameters/rank_eval::query.allow_no_indices' + - $ref: '#/components/parameters/rank_eval::query.expand_wildcards' + - $ref: '#/components/parameters/rank_eval::query.search_type' + requestBody: + $ref: '#/components/requestBodies/rank_eval' + responses: + '200': + $ref: '#/components/responses/rank_eval@200' + /{index}/_recovery: + get: + operationId: indices.recovery.1 + x-operation-group: indices.recovery + x-version-added: '1.0' + description: Returns information about ongoing index shard recoveries. + parameters: + - $ref: '#/components/parameters/indices.recovery::path.index' + - $ref: '#/components/parameters/indices.recovery::query.detailed' + - $ref: '#/components/parameters/indices.recovery::query.active_only' + responses: + '200': + $ref: '#/components/responses/indices.recovery@200' + /{index}/_refresh: + get: + operationId: indices.refresh.2 + x-operation-group: indices.refresh + x-version-added: '1.0' + description: Performs the refresh operation in one or more indices. + parameters: + - $ref: '#/components/parameters/indices.refresh::path.index' + - $ref: '#/components/parameters/indices.refresh::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.refresh::query.allow_no_indices' + - $ref: '#/components/parameters/indices.refresh::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.refresh@200' + post: + operationId: indices.refresh.3 + x-operation-group: indices.refresh + x-version-added: '1.0' + description: Performs the refresh operation in one or more indices. + parameters: + - $ref: '#/components/parameters/indices.refresh::path.index' + - $ref: '#/components/parameters/indices.refresh::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.refresh::query.allow_no_indices' + - $ref: '#/components/parameters/indices.refresh::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.refresh@200' + /{index}/_search: + get: + operationId: search.2 + x-operation-group: search + x-version-added: '1.0' + description: Returns results matching a query. + parameters: + - $ref: '#/components/parameters/search::path.index' + - $ref: '#/components/parameters/search::query.analyzer' + - $ref: '#/components/parameters/search::query.analyze_wildcard' + - $ref: '#/components/parameters/search::query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/search::query.default_operator' + - $ref: '#/components/parameters/search::query.df' + - $ref: '#/components/parameters/search::query.explain' + - $ref: '#/components/parameters/search::query.stored_fields' + - $ref: '#/components/parameters/search::query.docvalue_fields' + - $ref: '#/components/parameters/search::query.from' + - $ref: '#/components/parameters/search::query.ignore_unavailable' + - $ref: '#/components/parameters/search::query.ignore_throttled' + - $ref: '#/components/parameters/search::query.allow_no_indices' + - $ref: '#/components/parameters/search::query.expand_wildcards' + - $ref: '#/components/parameters/search::query.lenient' + - $ref: '#/components/parameters/search::query.preference' + - $ref: '#/components/parameters/search::query.q' + - $ref: '#/components/parameters/search::query.routing' + - $ref: '#/components/parameters/search::query.scroll' + - $ref: '#/components/parameters/search::query.search_type' + - $ref: '#/components/parameters/search::query.size' + - $ref: '#/components/parameters/search::query.sort' + - $ref: '#/components/parameters/search::query._source' + - $ref: '#/components/parameters/search::query._source_excludes' + - $ref: '#/components/parameters/search::query._source_includes' + - $ref: '#/components/parameters/search::query.terminate_after' + - $ref: '#/components/parameters/search::query.stats' + - $ref: '#/components/parameters/search::query.suggest_field' + - $ref: '#/components/parameters/search::query.suggest_mode' + - $ref: '#/components/parameters/search::query.suggest_size' + - $ref: '#/components/parameters/search::query.suggest_text' + - $ref: '#/components/parameters/search::query.timeout' + - $ref: '#/components/parameters/search::query.track_scores' + - $ref: '#/components/parameters/search::query.track_total_hits' + - $ref: '#/components/parameters/search::query.allow_partial_search_results' + - $ref: '#/components/parameters/search::query.typed_keys' + - $ref: '#/components/parameters/search::query.version' + - $ref: '#/components/parameters/search::query.seq_no_primary_term' + - $ref: '#/components/parameters/search::query.request_cache' + - $ref: '#/components/parameters/search::query.batched_reduce_size' + - $ref: '#/components/parameters/search::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/search::query.pre_filter_shard_size' + - $ref: '#/components/parameters/search::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search::query.search_pipeline' + - $ref: '#/components/parameters/search::query.include_named_queries_score' + requestBody: + $ref: '#/components/requestBodies/search' + responses: + '200': + $ref: '#/components/responses/search@200' + post: + operationId: search.3 + x-operation-group: search + x-version-added: '1.0' + description: Returns results matching a query. + parameters: + - $ref: '#/components/parameters/search::path.index' + - $ref: '#/components/parameters/search::query.analyzer' + - $ref: '#/components/parameters/search::query.analyze_wildcard' + - $ref: '#/components/parameters/search::query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/search::query.default_operator' + - $ref: '#/components/parameters/search::query.df' + - $ref: '#/components/parameters/search::query.explain' + - $ref: '#/components/parameters/search::query.stored_fields' + - $ref: '#/components/parameters/search::query.docvalue_fields' + - $ref: '#/components/parameters/search::query.from' + - $ref: '#/components/parameters/search::query.ignore_unavailable' + - $ref: '#/components/parameters/search::query.ignore_throttled' + - $ref: '#/components/parameters/search::query.allow_no_indices' + - $ref: '#/components/parameters/search::query.expand_wildcards' + - $ref: '#/components/parameters/search::query.lenient' + - $ref: '#/components/parameters/search::query.preference' + - $ref: '#/components/parameters/search::query.q' + - $ref: '#/components/parameters/search::query.routing' + - $ref: '#/components/parameters/search::query.scroll' + - $ref: '#/components/parameters/search::query.search_type' + - $ref: '#/components/parameters/search::query.size' + - $ref: '#/components/parameters/search::query.sort' + - $ref: '#/components/parameters/search::query._source' + - $ref: '#/components/parameters/search::query._source_excludes' + - $ref: '#/components/parameters/search::query._source_includes' + - $ref: '#/components/parameters/search::query.terminate_after' + - $ref: '#/components/parameters/search::query.stats' + - $ref: '#/components/parameters/search::query.suggest_field' + - $ref: '#/components/parameters/search::query.suggest_mode' + - $ref: '#/components/parameters/search::query.suggest_size' + - $ref: '#/components/parameters/search::query.suggest_text' + - $ref: '#/components/parameters/search::query.timeout' + - $ref: '#/components/parameters/search::query.track_scores' + - $ref: '#/components/parameters/search::query.track_total_hits' + - $ref: '#/components/parameters/search::query.allow_partial_search_results' + - $ref: '#/components/parameters/search::query.typed_keys' + - $ref: '#/components/parameters/search::query.version' + - $ref: '#/components/parameters/search::query.seq_no_primary_term' + - $ref: '#/components/parameters/search::query.request_cache' + - $ref: '#/components/parameters/search::query.batched_reduce_size' + - $ref: '#/components/parameters/search::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/search::query.pre_filter_shard_size' + - $ref: '#/components/parameters/search::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search::query.search_pipeline' + - $ref: '#/components/parameters/search::query.include_named_queries_score' + requestBody: + $ref: '#/components/requestBodies/search' + responses: + '200': + $ref: '#/components/responses/search@200' + /{index}/_search/point_in_time: + post: + operationId: create_pit.0 + x-operation-group: create_pit + x-version-added: '2.4' + description: Creates point in time context. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#create-a-pit + parameters: + - $ref: '#/components/parameters/create_pit::path.index' + - $ref: '#/components/parameters/create_pit::query.allow_partial_pit_creation' + - $ref: '#/components/parameters/create_pit::query.keep_alive' + - $ref: '#/components/parameters/create_pit::query.preference' + - $ref: '#/components/parameters/create_pit::query.routing' + - $ref: '#/components/parameters/create_pit::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/create_pit@200' + /{index}/_search/template: + get: + operationId: search_template.2 + x-operation-group: search_template + x-version-added: '1.0' + description: Allows to use the Mustache language to pre-render a search definition. + parameters: + - $ref: '#/components/parameters/search_template::path.index' + - $ref: '#/components/parameters/search_template::query.ignore_unavailable' + - $ref: '#/components/parameters/search_template::query.ignore_throttled' + - $ref: '#/components/parameters/search_template::query.allow_no_indices' + - $ref: '#/components/parameters/search_template::query.expand_wildcards' + - $ref: '#/components/parameters/search_template::query.preference' + - $ref: '#/components/parameters/search_template::query.routing' + - $ref: '#/components/parameters/search_template::query.scroll' + - $ref: '#/components/parameters/search_template::query.search_type' + - $ref: '#/components/parameters/search_template::query.explain' + - $ref: '#/components/parameters/search_template::query.profile' + - $ref: '#/components/parameters/search_template::query.typed_keys' + - $ref: '#/components/parameters/search_template::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search_template::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/search_template' + responses: + '200': + $ref: '#/components/responses/search_template@200' + post: + operationId: search_template.3 + x-operation-group: search_template + x-version-added: '1.0' + description: Allows to use the Mustache language to pre-render a search definition. + parameters: + - $ref: '#/components/parameters/search_template::path.index' + - $ref: '#/components/parameters/search_template::query.ignore_unavailable' + - $ref: '#/components/parameters/search_template::query.ignore_throttled' + - $ref: '#/components/parameters/search_template::query.allow_no_indices' + - $ref: '#/components/parameters/search_template::query.expand_wildcards' + - $ref: '#/components/parameters/search_template::query.preference' + - $ref: '#/components/parameters/search_template::query.routing' + - $ref: '#/components/parameters/search_template::query.scroll' + - $ref: '#/components/parameters/search_template::query.search_type' + - $ref: '#/components/parameters/search_template::query.explain' + - $ref: '#/components/parameters/search_template::query.profile' + - $ref: '#/components/parameters/search_template::query.typed_keys' + - $ref: '#/components/parameters/search_template::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search_template::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/search_template' + responses: + '200': + $ref: '#/components/responses/search_template@200' + /{index}/_search_shards: + get: + operationId: search_shards.2 + x-operation-group: search_shards + x-version-added: '1.0' + description: Returns information about the indices and shards that a search request would be executed against. + parameters: + - $ref: '#/components/parameters/search_shards::path.index' + - $ref: '#/components/parameters/search_shards::query.preference' + - $ref: '#/components/parameters/search_shards::query.routing' + - $ref: '#/components/parameters/search_shards::query.local' + - $ref: '#/components/parameters/search_shards::query.ignore_unavailable' + - $ref: '#/components/parameters/search_shards::query.allow_no_indices' + - $ref: '#/components/parameters/search_shards::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/search_shards@200' + post: + operationId: search_shards.3 + x-operation-group: search_shards + x-version-added: '1.0' + description: Returns information about the indices and shards that a search request would be executed against. + parameters: + - $ref: '#/components/parameters/search_shards::path.index' + - $ref: '#/components/parameters/search_shards::query.preference' + - $ref: '#/components/parameters/search_shards::query.routing' + - $ref: '#/components/parameters/search_shards::query.local' + - $ref: '#/components/parameters/search_shards::query.ignore_unavailable' + - $ref: '#/components/parameters/search_shards::query.allow_no_indices' + - $ref: '#/components/parameters/search_shards::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/search_shards@200' + /{index}/_segments: + get: + operationId: indices.segments.1 + x-operation-group: indices.segments + x-version-added: '1.0' + description: Provides low-level information about segments in a Lucene index. + parameters: + - $ref: '#/components/parameters/indices.segments::path.index' + - $ref: '#/components/parameters/indices.segments::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.segments::query.allow_no_indices' + - $ref: '#/components/parameters/indices.segments::query.expand_wildcards' + - $ref: '#/components/parameters/indices.segments::query.verbose' + responses: + '200': + $ref: '#/components/responses/indices.segments@200' + /{index}/_settings: + get: + operationId: indices.get_settings.2 + x-operation-group: indices.get_settings + x-version-added: '1.0' + description: Returns settings for one or more indices. + parameters: + - $ref: '#/components/parameters/indices.get_settings::path.index' + - $ref: '#/components/parameters/indices.get_settings::query.master_timeout' + - $ref: '#/components/parameters/indices.get_settings::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_settings::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_settings::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_settings::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_settings::query.flat_settings' + - $ref: '#/components/parameters/indices.get_settings::query.local' + - $ref: '#/components/parameters/indices.get_settings::query.include_defaults' + responses: + '200': + $ref: '#/components/responses/indices.get_settings@200' + put: + operationId: indices.put_settings.1 + x-operation-group: indices.put_settings + x-version-added: '1.0' + description: Updates the index settings. + parameters: + - $ref: '#/components/parameters/indices.put_settings::path.index' + - $ref: '#/components/parameters/indices.put_settings::query.master_timeout' + - $ref: '#/components/parameters/indices.put_settings::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_settings::query.timeout' + - $ref: '#/components/parameters/indices.put_settings::query.preserve_existing' + - $ref: '#/components/parameters/indices.put_settings::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.put_settings::query.allow_no_indices' + - $ref: '#/components/parameters/indices.put_settings::query.expand_wildcards' + - $ref: '#/components/parameters/indices.put_settings::query.flat_settings' + requestBody: + $ref: '#/components/requestBodies/indices.put_settings' + responses: + '200': + $ref: '#/components/responses/indices.put_settings@200' + /{index}/_settings/{name}: + get: + operationId: indices.get_settings.3 + x-operation-group: indices.get_settings + x-version-added: '1.0' + description: Returns settings for one or more indices. + parameters: + - $ref: '#/components/parameters/indices.get_settings::path.index' + - $ref: '#/components/parameters/indices.get_settings::path.name' + - $ref: '#/components/parameters/indices.get_settings::query.master_timeout' + - $ref: '#/components/parameters/indices.get_settings::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_settings::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_settings::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_settings::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_settings::query.flat_settings' + - $ref: '#/components/parameters/indices.get_settings::query.local' + - $ref: '#/components/parameters/indices.get_settings::query.include_defaults' + responses: + '200': + $ref: '#/components/responses/indices.get_settings@200' + /{index}/_shard_stores: + get: + operationId: indices.shard_stores.1 + x-operation-group: indices.shard_stores + x-version-added: '1.0' + description: Provides store information for shard copies of indices. + parameters: + - $ref: '#/components/parameters/indices.shard_stores::path.index' + - $ref: '#/components/parameters/indices.shard_stores::query.status' + - $ref: '#/components/parameters/indices.shard_stores::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.shard_stores::query.allow_no_indices' + - $ref: '#/components/parameters/indices.shard_stores::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.shard_stores@200' + /{index}/_shrink/{target}: + post: + operationId: indices.shrink.0 + x-operation-group: indices.shrink + x-version-added: '1.0' + description: Allow to shrink an existing index into a new index with fewer primary shards. + parameters: + - $ref: '#/components/parameters/indices.shrink::path.index' + - $ref: '#/components/parameters/indices.shrink::path.target' + - $ref: '#/components/parameters/indices.shrink::query.copy_settings' + - $ref: '#/components/parameters/indices.shrink::query.timeout' + - $ref: '#/components/parameters/indices.shrink::query.master_timeout' + - $ref: '#/components/parameters/indices.shrink::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.shrink::query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.shrink::query.wait_for_completion' + - $ref: '#/components/parameters/indices.shrink::query.task_execution_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.shrink' + responses: + '200': + $ref: '#/components/responses/indices.shrink@200' + put: + operationId: indices.shrink.1 + x-operation-group: indices.shrink + x-version-added: '1.0' + description: Allow to shrink an existing index into a new index with fewer primary shards. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/ + parameters: + - $ref: '#/components/parameters/indices.shrink::path.index' + - $ref: '#/components/parameters/indices.shrink::path.target' + - $ref: '#/components/parameters/indices.shrink::query.copy_settings' + - $ref: '#/components/parameters/indices.shrink::query.timeout' + - $ref: '#/components/parameters/indices.shrink::query.master_timeout' + - $ref: '#/components/parameters/indices.shrink::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.shrink::query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.shrink::query.wait_for_completion' + - $ref: '#/components/parameters/indices.shrink::query.task_execution_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.shrink' + responses: + '200': + $ref: '#/components/responses/indices.shrink@200' + /{index}/_source/{id}: + get: + operationId: get_source.0 + x-operation-group: get_source + x-version-added: '1.0' + description: Returns the source of a document. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ + parameters: + - $ref: '#/components/parameters/get_source::path.id' + - $ref: '#/components/parameters/get_source::path.index' + - $ref: '#/components/parameters/get_source::query.preference' + - $ref: '#/components/parameters/get_source::query.realtime' + - $ref: '#/components/parameters/get_source::query.refresh' + - $ref: '#/components/parameters/get_source::query.routing' + - $ref: '#/components/parameters/get_source::query._source' + - $ref: '#/components/parameters/get_source::query._source_excludes' + - $ref: '#/components/parameters/get_source::query._source_includes' + - $ref: '#/components/parameters/get_source::query.version' + - $ref: '#/components/parameters/get_source::query.version_type' + responses: + '200': + $ref: '#/components/responses/get_source@200' + head: + operationId: exists_source.0 + x-operation-group: exists_source + x-version-added: '1.0' + description: Returns information about whether a document source exists in an index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ + parameters: + - $ref: '#/components/parameters/exists_source::path.id' + - $ref: '#/components/parameters/exists_source::path.index' + - $ref: '#/components/parameters/exists_source::query.preference' + - $ref: '#/components/parameters/exists_source::query.realtime' + - $ref: '#/components/parameters/exists_source::query.refresh' + - $ref: '#/components/parameters/exists_source::query.routing' + - $ref: '#/components/parameters/exists_source::query._source' + - $ref: '#/components/parameters/exists_source::query._source_excludes' + - $ref: '#/components/parameters/exists_source::query._source_includes' + - $ref: '#/components/parameters/exists_source::query.version' + - $ref: '#/components/parameters/exists_source::query.version_type' + responses: + '200': + $ref: '#/components/responses/exists_source@200' + /{index}/_split/{target}: + post: + operationId: indices.split.0 + x-operation-group: indices.split + x-version-added: '1.0' + description: Allows you to split an existing index into a new index with more primary shards. + parameters: + - $ref: '#/components/parameters/indices.split::path.index' + - $ref: '#/components/parameters/indices.split::path.target' + - $ref: '#/components/parameters/indices.split::query.copy_settings' + - $ref: '#/components/parameters/indices.split::query.timeout' + - $ref: '#/components/parameters/indices.split::query.master_timeout' + - $ref: '#/components/parameters/indices.split::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.split::query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.split::query.wait_for_completion' + - $ref: '#/components/parameters/indices.split::query.task_execution_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.split' + responses: + '200': + $ref: '#/components/responses/indices.split@200' + put: + operationId: indices.split.1 + x-operation-group: indices.split + x-version-added: '1.0' + description: Allows you to split an existing index into a new index with more primary shards. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/split/ + parameters: + - $ref: '#/components/parameters/indices.split::path.index' + - $ref: '#/components/parameters/indices.split::path.target' + - $ref: '#/components/parameters/indices.split::query.copy_settings' + - $ref: '#/components/parameters/indices.split::query.timeout' + - $ref: '#/components/parameters/indices.split::query.master_timeout' + - $ref: '#/components/parameters/indices.split::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.split::query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.split::query.wait_for_completion' + - $ref: '#/components/parameters/indices.split::query.task_execution_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.split' + responses: + '200': + $ref: '#/components/responses/indices.split@200' + /{index}/_stats: + get: + operationId: indices.stats.2 + x-operation-group: indices.stats + x-version-added: '1.0' + description: Provides statistics on operations happening in an index. + parameters: + - $ref: '#/components/parameters/indices.stats::path.index' + - $ref: '#/components/parameters/indices.stats::query.completion_fields' + - $ref: '#/components/parameters/indices.stats::query.fielddata_fields' + - $ref: '#/components/parameters/indices.stats::query.fields' + - $ref: '#/components/parameters/indices.stats::query.groups' + - $ref: '#/components/parameters/indices.stats::query.level' + - $ref: '#/components/parameters/indices.stats::query.include_segment_file_sizes' + - $ref: '#/components/parameters/indices.stats::query.include_unloaded_segments' + - $ref: '#/components/parameters/indices.stats::query.expand_wildcards' + - $ref: '#/components/parameters/indices.stats::query.forbid_closed_indices' + responses: + '200': + $ref: '#/components/responses/indices.stats@200' + /{index}/_stats/{metric}: + get: + operationId: indices.stats.3 + x-operation-group: indices.stats + x-version-added: '1.0' + description: Provides statistics on operations happening in an index. + parameters: + - $ref: '#/components/parameters/indices.stats::path.index' + - $ref: '#/components/parameters/indices.stats::path.metric' + - $ref: '#/components/parameters/indices.stats::query.completion_fields' + - $ref: '#/components/parameters/indices.stats::query.fielddata_fields' + - $ref: '#/components/parameters/indices.stats::query.fields' + - $ref: '#/components/parameters/indices.stats::query.groups' + - $ref: '#/components/parameters/indices.stats::query.level' + - $ref: '#/components/parameters/indices.stats::query.include_segment_file_sizes' + - $ref: '#/components/parameters/indices.stats::query.include_unloaded_segments' + - $ref: '#/components/parameters/indices.stats::query.expand_wildcards' + - $ref: '#/components/parameters/indices.stats::query.forbid_closed_indices' + responses: + '200': + $ref: '#/components/responses/indices.stats@200' + /{index}/_termvectors: + get: + operationId: termvectors.0 + x-operation-group: termvectors + x-version-added: '1.0' + description: Returns information and statistics about terms in the fields of a particular document. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/termvectors::path.index' + - $ref: '#/components/parameters/termvectors::query.term_statistics' + - $ref: '#/components/parameters/termvectors::query.field_statistics' + - $ref: '#/components/parameters/termvectors::query.fields' + - $ref: '#/components/parameters/termvectors::query.offsets' + - $ref: '#/components/parameters/termvectors::query.positions' + - $ref: '#/components/parameters/termvectors::query.payloads' + - $ref: '#/components/parameters/termvectors::query.preference' + - $ref: '#/components/parameters/termvectors::query.routing' + - $ref: '#/components/parameters/termvectors::query.realtime' + - $ref: '#/components/parameters/termvectors::query.version' + - $ref: '#/components/parameters/termvectors::query.version_type' + requestBody: + $ref: '#/components/requestBodies/termvectors' + responses: + '200': + $ref: '#/components/responses/termvectors@200' + post: + operationId: termvectors.1 + x-operation-group: termvectors + x-version-added: '1.0' + description: Returns information and statistics about terms in the fields of a particular document. + parameters: + - $ref: '#/components/parameters/termvectors::path.index' + - $ref: '#/components/parameters/termvectors::query.term_statistics' + - $ref: '#/components/parameters/termvectors::query.field_statistics' + - $ref: '#/components/parameters/termvectors::query.fields' + - $ref: '#/components/parameters/termvectors::query.offsets' + - $ref: '#/components/parameters/termvectors::query.positions' + - $ref: '#/components/parameters/termvectors::query.payloads' + - $ref: '#/components/parameters/termvectors::query.preference' + - $ref: '#/components/parameters/termvectors::query.routing' + - $ref: '#/components/parameters/termvectors::query.realtime' + - $ref: '#/components/parameters/termvectors::query.version' + - $ref: '#/components/parameters/termvectors::query.version_type' + requestBody: + $ref: '#/components/requestBodies/termvectors' + responses: + '200': + $ref: '#/components/responses/termvectors@200' + /{index}/_termvectors/{id}: + get: + operationId: termvectors.2 + x-operation-group: termvectors + x-version-added: '1.0' + description: Returns information and statistics about terms in the fields of a particular document. + parameters: + - $ref: '#/components/parameters/termvectors::path.index' + - $ref: '#/components/parameters/termvectors::path.id' + - $ref: '#/components/parameters/termvectors::query.term_statistics' + - $ref: '#/components/parameters/termvectors::query.field_statistics' + - $ref: '#/components/parameters/termvectors::query.fields' + - $ref: '#/components/parameters/termvectors::query.offsets' + - $ref: '#/components/parameters/termvectors::query.positions' + - $ref: '#/components/parameters/termvectors::query.payloads' + - $ref: '#/components/parameters/termvectors::query.preference' + - $ref: '#/components/parameters/termvectors::query.routing' + - $ref: '#/components/parameters/termvectors::query.realtime' + - $ref: '#/components/parameters/termvectors::query.version' + - $ref: '#/components/parameters/termvectors::query.version_type' + requestBody: + $ref: '#/components/requestBodies/termvectors' + responses: + '200': + $ref: '#/components/responses/termvectors@200' + post: + operationId: termvectors.3 + x-operation-group: termvectors + x-version-added: '1.0' + description: Returns information and statistics about terms in the fields of a particular document. + parameters: + - $ref: '#/components/parameters/termvectors::path.index' + - $ref: '#/components/parameters/termvectors::path.id' + - $ref: '#/components/parameters/termvectors::query.term_statistics' + - $ref: '#/components/parameters/termvectors::query.field_statistics' + - $ref: '#/components/parameters/termvectors::query.fields' + - $ref: '#/components/parameters/termvectors::query.offsets' + - $ref: '#/components/parameters/termvectors::query.positions' + - $ref: '#/components/parameters/termvectors::query.payloads' + - $ref: '#/components/parameters/termvectors::query.preference' + - $ref: '#/components/parameters/termvectors::query.routing' + - $ref: '#/components/parameters/termvectors::query.realtime' + - $ref: '#/components/parameters/termvectors::query.version' + - $ref: '#/components/parameters/termvectors::query.version_type' + requestBody: + $ref: '#/components/requestBodies/termvectors' + responses: + '200': + $ref: '#/components/responses/termvectors@200' + /{index}/_update/{id}: + post: + operationId: update.0 + x-operation-group: update + x-version-added: '1.0' + description: Updates a document with a script or partial document. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/update-document/ + parameters: + - $ref: '#/components/parameters/update::path.id' + - $ref: '#/components/parameters/update::path.index' + - $ref: '#/components/parameters/update::query.wait_for_active_shards' + - $ref: '#/components/parameters/update::query._source' + - $ref: '#/components/parameters/update::query._source_excludes' + - $ref: '#/components/parameters/update::query._source_includes' + - $ref: '#/components/parameters/update::query.lang' + - $ref: '#/components/parameters/update::query.refresh' + - $ref: '#/components/parameters/update::query.retry_on_conflict' + - $ref: '#/components/parameters/update::query.routing' + - $ref: '#/components/parameters/update::query.timeout' + - $ref: '#/components/parameters/update::query.if_seq_no' + - $ref: '#/components/parameters/update::query.if_primary_term' + - $ref: '#/components/parameters/update::query.require_alias' + requestBody: + $ref: '#/components/requestBodies/update' + responses: + '200': + $ref: '#/components/responses/update@200' + /{index}/_update_by_query: + post: + operationId: update_by_query.0 + x-operation-group: update_by_query + x-version-added: '1.0' + description: |- + Performs an update on every document in the index without changing the source, + for example to pick up a mapping change. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/update-by-query/ + parameters: + - $ref: '#/components/parameters/update_by_query::path.index' + - $ref: '#/components/parameters/update_by_query::query.analyzer' + - $ref: '#/components/parameters/update_by_query::query.analyze_wildcard' + - $ref: '#/components/parameters/update_by_query::query.default_operator' + - $ref: '#/components/parameters/update_by_query::query.df' + - $ref: '#/components/parameters/update_by_query::query.from' + - $ref: '#/components/parameters/update_by_query::query.ignore_unavailable' + - $ref: '#/components/parameters/update_by_query::query.allow_no_indices' + - $ref: '#/components/parameters/update_by_query::query.conflicts' + - $ref: '#/components/parameters/update_by_query::query.expand_wildcards' + - $ref: '#/components/parameters/update_by_query::query.lenient' + - $ref: '#/components/parameters/update_by_query::query.pipeline' + - $ref: '#/components/parameters/update_by_query::query.preference' + - $ref: '#/components/parameters/update_by_query::query.q' + - $ref: '#/components/parameters/update_by_query::query.routing' + - $ref: '#/components/parameters/update_by_query::query.scroll' + - $ref: '#/components/parameters/update_by_query::query.search_type' + - $ref: '#/components/parameters/update_by_query::query.search_timeout' + - $ref: '#/components/parameters/update_by_query::query.size' + - $ref: '#/components/parameters/update_by_query::query.max_docs' + - $ref: '#/components/parameters/update_by_query::query.sort' + - $ref: '#/components/parameters/update_by_query::query._source' + - $ref: '#/components/parameters/update_by_query::query._source_excludes' + - $ref: '#/components/parameters/update_by_query::query._source_includes' + - $ref: '#/components/parameters/update_by_query::query.terminate_after' + - $ref: '#/components/parameters/update_by_query::query.stats' + - $ref: '#/components/parameters/update_by_query::query.version' + - $ref: '#/components/parameters/update_by_query::query.request_cache' + - $ref: '#/components/parameters/update_by_query::query.refresh' + - $ref: '#/components/parameters/update_by_query::query.timeout' + - $ref: '#/components/parameters/update_by_query::query.wait_for_active_shards' + - $ref: '#/components/parameters/update_by_query::query.scroll_size' + - $ref: '#/components/parameters/update_by_query::query.wait_for_completion' + - $ref: '#/components/parameters/update_by_query::query.requests_per_second' + - $ref: '#/components/parameters/update_by_query::query.slices' + requestBody: + $ref: '#/components/requestBodies/update_by_query' + responses: + '200': + $ref: '#/components/responses/update_by_query@200' + /{index}/_upgrade: + get: + operationId: indices.get_upgrade.1 + x-operation-group: indices.get_upgrade + x-version-added: '1.0' + description: The _upgrade API is no longer useful and will be removed. + parameters: + - $ref: '#/components/parameters/indices.get_upgrade::path.index' + - $ref: '#/components/parameters/indices.get_upgrade::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_upgrade::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_upgrade::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.get_upgrade@200' + post: + operationId: indices.upgrade.1 + x-operation-group: indices.upgrade + x-version-added: '1.0' + description: The _upgrade API is no longer useful and will be removed. + parameters: + - $ref: '#/components/parameters/indices.upgrade::path.index' + - $ref: '#/components/parameters/indices.upgrade::query.allow_no_indices' + - $ref: '#/components/parameters/indices.upgrade::query.expand_wildcards' + - $ref: '#/components/parameters/indices.upgrade::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.upgrade::query.wait_for_completion' + - $ref: '#/components/parameters/indices.upgrade::query.only_ancient_segments' + responses: + '200': + $ref: '#/components/responses/indices.upgrade@200' + /{index}/_validate/query: + get: + operationId: indices.validate_query.2 + x-operation-group: indices.validate_query + x-version-added: '1.0' + description: Allows a user to validate a potentially expensive query without executing it. + parameters: + - $ref: '#/components/parameters/indices.validate_query::path.index' + - $ref: '#/components/parameters/indices.validate_query::query.explain' + - $ref: '#/components/parameters/indices.validate_query::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.validate_query::query.allow_no_indices' + - $ref: '#/components/parameters/indices.validate_query::query.expand_wildcards' + - $ref: '#/components/parameters/indices.validate_query::query.q' + - $ref: '#/components/parameters/indices.validate_query::query.analyzer' + - $ref: '#/components/parameters/indices.validate_query::query.analyze_wildcard' + - $ref: '#/components/parameters/indices.validate_query::query.default_operator' + - $ref: '#/components/parameters/indices.validate_query::query.df' + - $ref: '#/components/parameters/indices.validate_query::query.lenient' + - $ref: '#/components/parameters/indices.validate_query::query.rewrite' + - $ref: '#/components/parameters/indices.validate_query::query.all_shards' + requestBody: + $ref: '#/components/requestBodies/indices.validate_query' + responses: + '200': + $ref: '#/components/responses/indices.validate_query@200' + post: + operationId: indices.validate_query.3 + x-operation-group: indices.validate_query + x-version-added: '1.0' + description: Allows a user to validate a potentially expensive query without executing it. + parameters: + - $ref: '#/components/parameters/indices.validate_query::path.index' + - $ref: '#/components/parameters/indices.validate_query::query.explain' + - $ref: '#/components/parameters/indices.validate_query::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.validate_query::query.allow_no_indices' + - $ref: '#/components/parameters/indices.validate_query::query.expand_wildcards' + - $ref: '#/components/parameters/indices.validate_query::query.q' + - $ref: '#/components/parameters/indices.validate_query::query.analyzer' + - $ref: '#/components/parameters/indices.validate_query::query.analyze_wildcard' + - $ref: '#/components/parameters/indices.validate_query::query.default_operator' + - $ref: '#/components/parameters/indices.validate_query::query.df' + - $ref: '#/components/parameters/indices.validate_query::query.lenient' + - $ref: '#/components/parameters/indices.validate_query::query.rewrite' + - $ref: '#/components/parameters/indices.validate_query::query.all_shards' + requestBody: + $ref: '#/components/requestBodies/indices.validate_query' + responses: + '200': + $ref: '#/components/responses/indices.validate_query@200' +components: + parameters: + bulk::path.index: + in: path + name: index + description: Name of the data stream, index, or index alias to perform bulk actions on. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + bulk::query._source: + in: query + name: _source + description: '`true` or `false` to return the `_source` field or not, or a list of fields to return.' + schema: + $ref: '#/components/schemas/_core.search:SourceConfigParam' + style: form + bulk::query._source_excludes: + in: query + name: _source_excludes + description: A comma-separated list of source fields to exclude from the response. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + bulk::query._source_includes: + in: query + name: _source_includes + description: A comma-separated list of source fields to include in the response. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + bulk::query.pipeline: + in: query + name: pipeline + description: |- + ID of the pipeline to use to preprocess incoming documents. + If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. + If a final pipeline is configured it will always run, regardless of the value of this parameter. + schema: + type: string + style: form + bulk::query.refresh: + in: query + name: refresh + description: |- + If `true`, Opensearch 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. + Valid values: `true`, `false`, `wait_for`. + schema: + $ref: '#/components/schemas/_common:Refresh' + style: form + bulk::query.require_alias: + in: query + name: require_alias + description: If `true`, the request’s actions must target an index alias. + schema: + type: boolean + style: form + bulk::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + bulk::query.timeout: + in: query + name: timeout + description: 'Period each action waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.' + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + bulk::query.type: + name: type + in: query + description: Default document type for items which don't provide one. + schema: + type: string + description: Default document type for items which don't provide one. + bulk::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + cat.aliases::path.name: + in: path + name: name + description: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + cat.aliases::query.expand_wildcards: + in: query + name: expand_wildcards + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + cat.aliases::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.aliases::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.aliases::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.aliases::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.aliases::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.aliases::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.all_pit_segments::query.bytes: + name: bytes + in: query + description: The unit in which to display byte values. + schema: + $ref: '#/components/schemas/_common:Bytes' + cat.all_pit_segments::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.all_pit_segments::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.all_pit_segments::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.all_pit_segments::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.all_pit_segments::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.allocation::path.node_id: + in: path + name: node_id + description: Comma-separated list of node identifiers or names used to limit the returned information. + required: true + schema: + $ref: '#/components/schemas/_common:NodeIds' + style: simple + cat.allocation::query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '#/components/schemas/_common:Bytes' + style: form + cat.allocation::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cat.allocation::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.allocation::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.allocation::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.allocation::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.allocation::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.allocation::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.allocation::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.cluster_manager::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cat.cluster_manager::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.cluster_manager::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.cluster_manager::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.cluster_manager::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.cluster_manager::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.cluster_manager::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.cluster_manager::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.count::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + cat.count::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.count::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.count::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.count::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.count::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.fielddata::path.fields: + in: path + name: fields + description: |- + Comma-separated list of fields used to limit returned information. + To retrieve all fields, omit this parameter. + required: true + schema: + $ref: '#/components/schemas/_common:Fields' + style: simple + cat.fielddata::query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '#/components/schemas/_common:Bytes' + style: form + cat.fielddata::query.fields: + in: query + name: fields + description: Comma-separated list of fields used to limit returned information. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + cat.fielddata::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.fielddata::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.fielddata::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.fielddata::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.fielddata::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.health::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.health::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.health::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.health::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.health::query.time: + in: query + name: time + description: The unit used to display time values. + schema: + $ref: '#/components/schemas/_common:TimeUnit' + style: form + cat.health::query.ts: + in: query + name: ts + description: If true, returns `HH:MM:SS` and Unix epoch timestamps. + schema: + type: boolean + style: form + cat.health::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.help::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.help::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.indices::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + cat.indices::query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '#/components/schemas/_common:Bytes' + style: form + cat.indices::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cat.indices::query.expand_wildcards: + in: query + name: expand_wildcards + description: The type of index that wildcard patterns can match. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + cat.indices::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.indices::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.indices::query.health: + in: query + name: health + description: The health status used to limit returned indices. By default, the response includes indices of any health status. + schema: + $ref: '#/components/schemas/_common:HealthStatus' + style: form + cat.indices::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.indices::query.include_unloaded_segments: + in: query + name: include_unloaded_segments + description: If true, the response includes information from segments that are not loaded into memory. + schema: + type: boolean + style: form + cat.indices::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.indices::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.indices::query.pri: + in: query + name: pri + description: If true, the response only includes information from primary shards. + schema: + type: boolean + style: form + cat.indices::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.indices::query.time: + in: query + name: time + description: The unit used to display time values. + schema: + $ref: '#/components/schemas/_common:TimeUnit' + style: form + cat.indices::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.master::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cat.master::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.master::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.master::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.master::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.master::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.master::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.master::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.nodeattrs::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cat.nodeattrs::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.nodeattrs::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.nodeattrs::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.nodeattrs::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.nodeattrs::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.nodeattrs::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.nodeattrs::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.nodes::query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '#/components/schemas/_common:Bytes' + style: form + cat.nodes::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cat.nodes::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.nodes::query.full_id: + in: query + name: full_id + description: If `true`, return the full node ID. If `false`, return the shortened node ID. + schema: + oneOf: + - type: boolean + - type: string + style: form + cat.nodes::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.nodes::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.nodes::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + x-version-deprecated: '1.0' + x-deprecation-message: This parameter does not cause this API to act locally. + deprecated: true + cat.nodes::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.nodes::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.nodes::query.time: + name: time + in: query + description: The unit in which to display time values. + schema: + $ref: '#/components/schemas/_common:TimeUnit' + cat.nodes::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.pending_tasks::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cat.pending_tasks::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.pending_tasks::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.pending_tasks::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.pending_tasks::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.pending_tasks::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.pending_tasks::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.pending_tasks::query.time: + name: time + in: query + description: The unit in which to display time values. + schema: + $ref: '#/components/schemas/_common:TimeUnit' + cat.pending_tasks::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.pit_segments::query.bytes: + name: bytes + in: query + description: The unit in which to display byte values. + schema: + $ref: '#/components/schemas/_common:Bytes' + cat.pit_segments::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.pit_segments::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.pit_segments::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.pit_segments::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.pit_segments::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.plugins::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cat.plugins::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.plugins::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.plugins::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.plugins::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.plugins::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.plugins::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.plugins::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.recovery::path.index: + in: path + name: index + description: |- + A 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`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + cat.recovery::query.active_only: + in: query + name: active_only + description: If `true`, the response only includes ongoing shard recoveries. + schema: + type: boolean + style: form + cat.recovery::query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '#/components/schemas/_common:Bytes' + style: form + cat.recovery::query.detailed: + in: query + name: detailed + description: If `true`, the response includes detailed information about shard recoveries. + schema: + type: boolean + style: form + cat.recovery::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.recovery::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.recovery::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.recovery::query.index: + name: index + in: query + description: Comma-separated list or wildcard expression of index names to limit the returned information. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list or wildcard expression of index names to limit the returned information. + explode: true + cat.recovery::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.recovery::query.time: + name: time + in: query + description: The unit in which to display time values. + schema: + $ref: '#/components/schemas/_common:TimeUnit' + cat.recovery::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.repositories::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cat.repositories::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.repositories::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.repositories::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.repositories::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.repositories::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.repositories::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.repositories::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.segment_replication::path.index: + name: index + in: path + description: Comma-separated list or wildcard expression of index names to limit the returned information. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Comma-separated list or wildcard expression of index names to limit the returned information. + x-data-type: array + required: true + cat.segment_replication::query.active_only: + name: active_only + in: query + description: If `true`, the response only includes ongoing segment replication events. + schema: + type: boolean + default: false + description: If `true`, the response only includes ongoing segment replication events. + cat.segment_replication::query.allow_no_indices: + name: allow_no_indices + in: 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). + schema: + type: boolean + 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). + cat.segment_replication::query.bytes: + name: bytes + in: query + description: The unit in which to display byte values. + schema: + $ref: '#/components/schemas/_common:Bytes' + cat.segment_replication::query.completed_only: + name: completed_only + in: query + description: If `true`, the response only includes latest completed segment replication events. + schema: + type: boolean + default: false + description: If `true`, the response only includes latest completed segment replication events. + cat.segment_replication::query.detailed: + name: detailed + in: query + description: If `true`, the response includes detailed information about segment replications. + schema: + type: boolean + default: false + description: If `true`, the response includes detailed information about segment replications. + cat.segment_replication::query.expand_wildcards: + name: expand_wildcards + in: query + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + cat.segment_replication::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.segment_replication::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.segment_replication::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.segment_replication::query.ignore_throttled: + name: ignore_throttled + in: query + description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + schema: + type: boolean + description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + cat.segment_replication::query.ignore_unavailable: + name: ignore_unavailable + in: query + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + schema: + type: boolean + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + cat.segment_replication::query.index: + name: index + in: query + description: Comma-separated list or wildcard expression of index names to limit the returned information. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list or wildcard expression of index names to limit the returned information. + explode: true + cat.segment_replication::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.segment_replication::query.shards: + name: shards + in: query + description: Comma-separated list of shards to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of shards to display. + explode: true + cat.segment_replication::query.time: + name: time + in: query + description: The unit in which to display time values. + schema: + $ref: '#/components/schemas/_common:TimeUnit' + cat.segment_replication::query.timeout: + name: timeout + in: query + description: Operation timeout. + schema: + $ref: '#/components/schemas/_common:Duration' + cat.segment_replication::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.segments::path.index: + in: path + name: index + description: |- + A 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`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + cat.segments::query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '#/components/schemas/_common:Bytes' + style: form + cat.segments::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cat.segments::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.segments::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.segments::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.segments::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.segments::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.segments::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.shards::path.index: + in: path + name: index + description: |- + A 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`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + cat.shards::query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '#/components/schemas/_common:Bytes' + style: form + cat.shards::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cat.shards::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.shards::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.shards::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.shards::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.shards::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.shards::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.shards::query.time: + name: time + in: query + description: The unit in which to display time values. + schema: + $ref: '#/components/schemas/_common:TimeUnit' + cat.shards::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.snapshots::path.repository: + in: path + name: repository + description: |- + A comma-separated list of snapshot repositories used to limit the request. + Accepts wildcard expressions. + `_all` returns all repositories. + If any repository fails during the request, Opensearch returns an error. + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + cat.snapshots::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cat.snapshots::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.snapshots::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.snapshots::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.snapshots::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `true`, the response does not include information from unavailable snapshots. + schema: + type: boolean + style: form + cat.snapshots::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.snapshots::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.snapshots::query.time: + name: time + in: query + description: The unit in which to display time values. + schema: + $ref: '#/components/schemas/_common:TimeUnit' + cat.snapshots::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.tasks::query.actions: + in: query + name: actions + description: The task action names, which are used to limit the response. + schema: + type: array + items: + type: string + style: form + cat.tasks::query.detailed: + in: query + name: detailed + description: If `true`, the response includes detailed information about shard recoveries. + schema: + type: boolean + style: form + cat.tasks::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.tasks::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.tasks::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.tasks::query.nodes: + name: nodes + in: query + description: 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. + style: form + schema: + type: array + items: + type: string + description: 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. + explode: true + cat.tasks::query.parent_task_id: + in: query + name: parent_task_id + description: The parent task identifier, which is used to limit the response. + schema: + type: string + style: form + cat.tasks::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.tasks::query.time: + name: time + in: query + description: The unit in which to display time values. + schema: + $ref: '#/components/schemas/_common:TimeUnit' + cat.tasks::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.templates::path.name: + in: path + name: name + description: |- + The name of the template to return. + Accepts wildcard expressions. If omitted, all templates are returned. + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + cat.templates::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cat.templates::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.templates::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.templates::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.templates::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.templates::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.templates::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.templates::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.thread_pool::path.thread_pool_patterns: + in: path + name: thread_pool_patterns + description: |- + A comma-separated list of thread pool names used to limit the request. + Accepts wildcard expressions. + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + cat.thread_pool::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cat.thread_pool::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.thread_pool::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.thread_pool::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.thread_pool::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.thread_pool::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.thread_pool::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.thread_pool::query.size: + name: size + in: query + description: The multiplier in which to display values. + schema: + type: integer + description: The multiplier in which to display values. + format: int32 + cat.thread_pool::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + clear_scroll::path.scroll_id: + in: path + name: scroll_id + description: |- + Comma-separated list of scroll IDs to clear. + To clear all scroll IDs, use `_all`. + required: true + schema: + $ref: '#/components/schemas/_common:ScrollIds' + style: simple + cluster.allocation_explain::query.include_disk_info: + in: query + name: include_disk_info + description: If true, returns information about disk usage and shard sizes. + schema: + type: boolean + style: form + cluster.allocation_explain::query.include_yes_decisions: + in: query + name: include_yes_decisions + description: If true, returns YES decisions in explanation. + schema: + type: boolean + style: form + cluster.delete_component_template::path.name: + in: path + name: name + description: Comma-separated list or wildcard expression of component template names used to limit the request. + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + cluster.delete_component_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cluster.delete_component_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.delete_component_template::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + cluster.delete_voting_config_exclusions::query.wait_for_removal: + in: query + name: wait_for_removal + description: |- + 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. + schema: + type: boolean + style: form + cluster.exists_component_template::path.name: + in: path + name: name + description: |- + Comma-separated list of component template names used to limit the request. + Wildcard (*) expressions are supported. + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + cluster.exists_component_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cluster.exists_component_template::query.local: + in: query + name: local + description: |- + If true, the request retrieves information from the local node only. + Defaults to false, which means information is retrieved from the master node. + schema: + type: boolean + style: form + cluster.exists_component_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.get_component_template::path.name: + in: path + name: name + description: |- + Comma-separated list of component template names used to limit the request. + Wildcard (`*`) expressions are supported. + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + cluster.get_component_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cluster.get_component_template::query.local: + in: query + name: local + description: |- + If `true`, the request retrieves information from the local node only. + If `false`, information is retrieved from the master node. + schema: + type: boolean + style: form + cluster.get_component_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.get_decommission_awareness::path.awareness_attribute_name: + name: awareness_attribute_name + in: path + description: Awareness attribute name. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Awareness attribute name. + required: true + cluster.get_settings::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cluster.get_settings::query.flat_settings: + in: query + name: flat_settings + description: If `true`, returns settings in flat format. + schema: + type: boolean + style: form + cluster.get_settings::query.include_defaults: + in: query + name: include_defaults + description: If `true`, returns default cluster settings from the local node. + schema: + type: boolean + style: form + cluster.get_settings::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.get_settings::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + cluster.get_weighted_routing::path.attribute: + name: attribute + in: path + description: Awareness attribute name. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Awareness attribute name. + required: true + cluster.health::path.index: + in: path + name: index + 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 *. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + cluster.health::query.awareness_attribute: + name: awareness_attribute + in: query + description: The awareness attribute for which the health is required. + schema: + type: string + description: The awareness attribute for which the health is required. + cluster.health::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cluster.health::query.expand_wildcards: + in: query + name: expand_wildcards + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + cluster.health::query.level: + in: query + name: level + description: Can be one of cluster, indices or shards. Controls the details level of the health information returned. + schema: + $ref: '#/components/schemas/_common:Level' + style: form + cluster.health::query.local: + in: query + name: local + description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + schema: + type: boolean + style: form + cluster.health::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.health::query.timeout: + in: query + name: timeout + description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + cluster.health::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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. + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + cluster.health::query.wait_for_events: + in: query + name: wait_for_events + description: Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. + schema: + $ref: '#/components/schemas/_common:WaitForEvents' + style: form + cluster.health::query.wait_for_no_initializing_shards: + in: query + name: wait_for_no_initializing_shards + description: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards. + schema: + type: boolean + style: form + cluster.health::query.wait_for_no_relocating_shards: + in: query + name: wait_for_no_relocating_shards + description: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards. + schema: + type: boolean + style: form + cluster.health::query.wait_for_nodes: + in: query + name: wait_for_nodes + 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. + schema: + $ref: '#/components/schemas/_common:HealthStatus' + style: form + cluster.pending_tasks::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cluster.pending_tasks::query.local: + in: query + name: local + description: |- + If `true`, the request retrieves information from the local node only. + If `false`, information is retrieved from the master node. + schema: + type: boolean + style: form + cluster.pending_tasks::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.post_voting_config_exclusions::query.node_ids: + in: query + name: node_ids + description: |- + 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. + schema: + $ref: '#/components/schemas/_common:Ids' + style: form + cluster.post_voting_config_exclusions::query.node_names: + in: query + name: node_names + description: |- + 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. + schema: + $ref: '#/components/schemas/_common:Names' + style: form + cluster.post_voting_config_exclusions::query.timeout: + in: query + name: timeout + description: |- + 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. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + cluster.put_component_template::path.name: + in: path + name: name + description: |- + Name of the component template to create. + Opensearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. + Opensearch Agent uses these templates to configure backing indices for its data streams. + If you use Opensearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. + If you don’t use Opensearch Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + cluster.put_component_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cluster.put_component_template::query.create: + in: query + name: create + description: If `true`, this request cannot replace or update existing component templates. + schema: + type: boolean + style: form + cluster.put_component_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.put_component_template::query.timeout: + name: timeout + in: query + description: Operation timeout. + schema: + $ref: '#/components/schemas/_common:Duration' + cluster.put_decommission_awareness::path.awareness_attribute_name: + name: awareness_attribute_name + in: path + description: Awareness attribute name. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Awareness attribute name. + required: true + cluster.put_decommission_awareness::path.awareness_attribute_value: + name: awareness_attribute_value + in: path + description: Awareness attribute value. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Awareness attribute value. + required: true + cluster.put_settings::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cluster.put_settings::query.flat_settings: + in: query + name: flat_settings + description: 'Return settings in flat format (default: false)' + schema: + type: boolean + style: form + cluster.put_settings::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.put_settings::query.timeout: + in: query + name: timeout + description: Explicit operation timeout + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + cluster.put_weighted_routing::path.attribute: + name: attribute + in: path + description: Awareness attribute name. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Awareness attribute name. + required: true + cluster.reroute::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cluster.reroute::query.dry_run: + in: query + name: dry_run + description: If true, then the request simulates the operation only and returns the resulting state. + schema: + type: boolean + style: form + cluster.reroute::query.explain: + in: query + name: explain + description: If true, then the response contains an explanation of why the commands can or cannot be executed. + schema: + type: boolean + style: form + cluster.reroute::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.reroute::query.metric: + in: query + name: metric + description: Limits the information returned to the specified metrics. + schema: + $ref: '#/components/schemas/_common:Metrics' + style: form + cluster.reroute::query.retry_failed: + in: query + name: retry_failed + description: If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. + schema: + type: boolean + style: form + cluster.reroute::query.timeout: + in: query + name: timeout + description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + cluster.state::path.index: + in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + cluster.state::path.metric: + in: path + name: metric + description: Limit the information returned to the specified metrics + required: true + schema: + $ref: '#/components/schemas/_common:Metrics' + style: simple + cluster.state::query.allow_no_indices: + in: query + name: allow_no_indices + 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) + schema: + type: boolean + style: form + cluster.state::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + cluster.state::query.expand_wildcards: + in: query + name: expand_wildcards + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + cluster.state::query.flat_settings: + in: query + name: flat_settings + description: 'Return settings in flat format (default: false)' + schema: + type: boolean + style: form + cluster.state::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: Whether specified concrete indices should be ignored when unavailable (missing or closed) + schema: + type: boolean + style: form + cluster.state::query.local: + in: query + name: local + description: 'Return local information, do not retrieve the state from master node (default: false)' + schema: + type: boolean + style: form + cluster.state::query.master_timeout: + in: query + name: master_timeout + description: Specify timeout for connection to master + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.state::query.wait_for_metadata_version: + in: query + name: wait_for_metadata_version + description: Wait for the metadata version to be equal or greater than the specified metadata version + schema: + $ref: '#/components/schemas/_common:VersionNumber' + style: form + cluster.state::query.wait_for_timeout: + in: query + name: wait_for_timeout + description: The maximum time to wait for wait_for_metadata_version before timing out + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + cluster.stats::path.node_id: + in: path + name: node_id + description: Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. + required: true + schema: + $ref: '#/components/schemas/_common:NodeIds' + style: simple + cluster.stats::query.flat_settings: + in: query + name: flat_settings + description: If `true`, returns settings in flat format. + schema: + type: boolean + style: form + cluster.stats::query.timeout: + in: query + name: timeout + 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. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + count::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases to search. + Supports wildcards (`*`). + To search all data streams and indices, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + count::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + count::query.analyze_wildcard: + in: query + name: analyze_wildcard + description: |- + If `true`, wildcard and prefix queries are analyzed. + This parameter can only be used when the `q` query string parameter is specified. + schema: + type: boolean + style: form + count::query.analyzer: + in: query + name: analyzer + description: |- + Analyzer to use for the query string. + This parameter can only be used when the `q` query string parameter is specified. + schema: + type: string + style: form + count::query.default_operator: + in: query + name: default_operator + description: |- + The default operator for query string query: `AND` or `OR`. + This parameter can only be used when the `q` query string parameter is specified. + schema: + $ref: '#/components/schemas/_common.query_dsl:Operator' + style: form + count::query.df: + in: query + name: df + description: |- + Field to use as default where no field prefix is given in the query string. + This parameter can only be used when the `q` query string parameter is specified. + schema: + type: string + style: form + count::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + count::query.ignore_throttled: + in: query + name: ignore_throttled + description: If `true`, concrete, expanded or aliased indices are ignored when frozen. + schema: + type: boolean + style: form + count::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + count::query.lenient: + in: query + name: lenient + description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + schema: + type: boolean + style: form + count::query.min_score: + in: query + name: min_score + description: Sets the minimum `_score` value that documents must have to be included in the result. + schema: + type: number + style: form + count::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + count::query.q: + in: query + name: q + description: Query in the Lucene query string syntax. + schema: + type: string + style: form + count::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + count::query.terminate_after: + in: query + name: terminate_after + description: |- + Maximum number of documents to collect for each shard. + If a query reaches this limit, Opensearch terminates the query early. + Opensearch collects documents before sorting. + schema: + type: number + style: form + create::path.id: + in: path + name: id + description: Unique identifier for the document. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + create::path.index: + in: path + name: index + description: |- + Name of the data stream or index to target. + If the target doesn’t exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. + If the target doesn’t exist and doesn’t match a data stream template, this request creates the index. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + create::query.pipeline: + in: query + name: pipeline + description: |- + ID of the pipeline to use to preprocess incoming documents. + If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. + If a final pipeline is configured it will always run, regardless of the value of this parameter. + schema: + type: string + style: form + create::query.refresh: + in: query + name: refresh + description: |- + If `true`, Opensearch 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. + Valid values: `true`, `false`, `wait_for`. + schema: + $ref: '#/components/schemas/_common:Refresh' + style: form + create::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + create::query.timeout: + in: query + name: timeout + description: 'Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.' + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + create::query.version: + in: query + name: version + description: |- + Explicit version number for concurrency control. + The specified version must match the current version of the document for the request to succeed. + schema: + $ref: '#/components/schemas/_common:VersionNumber' + style: form + create::query.version_type: + in: query + name: version_type + description: 'Specific version type: `external`, `external_gte`.' + schema: + $ref: '#/components/schemas/_common:VersionType' + style: form + create::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + create_pit::path.index: + name: index + in: path + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + x-data-type: array + required: true + create_pit::query.allow_partial_pit_creation: + name: allow_partial_pit_creation + in: query + description: Allow if point in time can be created with partial failures. + schema: + type: boolean + description: Allow if point in time can be created with partial failures. + create_pit::query.expand_wildcards: + name: expand_wildcards + in: query + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + create_pit::query.keep_alive: + name: keep_alive + in: query + description: Specify the keep alive for point in time. + schema: + $ref: '#/components/schemas/_common:Duration' + create_pit::query.preference: + name: preference + in: query + description: Specify the node or shard the operation should be performed on. + schema: + type: string + default: random + description: Specify the node or shard the operation should be performed on. + create_pit::query.routing: + name: routing + in: query + description: Comma-separated list of specific routing values. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of specific routing values. + explode: true + dangling_indices.delete_dangling_index::path.index_uuid: + in: path + name: index_uuid + description: The UUID of the dangling index + required: true + schema: + $ref: '#/components/schemas/_common:Uuid' + style: simple + dangling_indices.delete_dangling_index::query.accept_data_loss: + in: query + name: accept_data_loss + description: Must be set to true in order to delete the dangling index + required: true + schema: + type: boolean + style: form + dangling_indices.delete_dangling_index::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + dangling_indices.delete_dangling_index::query.master_timeout: + in: query + name: master_timeout + description: Specify timeout for connection to master + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + dangling_indices.delete_dangling_index::query.timeout: + in: query + name: timeout + description: Explicit operation timeout + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + dangling_indices.import_dangling_index::path.index_uuid: + in: path + name: index_uuid + description: The UUID of the dangling index + required: true + schema: + $ref: '#/components/schemas/_common:Uuid' + style: simple + dangling_indices.import_dangling_index::query.accept_data_loss: + in: query + name: accept_data_loss + description: Must be set to true in order to import the dangling index + required: true + schema: + type: boolean + style: form + dangling_indices.import_dangling_index::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + dangling_indices.import_dangling_index::query.master_timeout: + in: query + name: master_timeout + description: Specify timeout for connection to master + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + dangling_indices.import_dangling_index::query.timeout: + in: query + name: timeout + description: Explicit operation timeout + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + delete::path.id: + in: path + name: id + description: Unique identifier for the document. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + delete::path.index: + in: path + name: index + description: Name of the target index. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + delete::query.if_primary_term: + in: query + name: if_primary_term + description: Only perform the operation if the document has this primary term. + schema: + type: number + style: form + delete::query.if_seq_no: + in: query + name: if_seq_no + description: Only perform the operation if the document has this sequence number. + schema: + $ref: '#/components/schemas/_common:SequenceNumber' + style: form + delete::query.refresh: + in: query + name: refresh + description: |- + If `true`, Opensearch 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. + Valid values: `true`, `false`, `wait_for`. + schema: + $ref: '#/components/schemas/_common:Refresh' + style: form + delete::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + delete::query.timeout: + in: query + name: timeout + description: Period to wait for active shards. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + delete::query.version: + in: query + name: version + description: |- + Explicit version number for concurrency control. + The specified version must match the current version of the document for the request to succeed. + schema: + $ref: '#/components/schemas/_common:VersionNumber' + style: form + delete::query.version_type: + in: query + name: version_type + description: 'Specific version type: `external`, `external_gte`.' + schema: + $ref: '#/components/schemas/_common:VersionType' + style: form + delete::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + delete_by_query::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases to search. + Supports wildcards (`*`). + To search all data streams or indices, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + delete_by_query::query._source: + name: _source + in: query + description: True or false to return the _source field or not, or a list of fields to return. + style: form + schema: + type: array + items: + type: string + description: True or false to return the _source field or not, or a list of fields to return. + explode: true + delete_by_query::query._source_excludes: + name: _source_excludes + in: query + description: List of fields to exclude from the returned _source field. + style: form + schema: + type: array + items: + type: string + description: List of fields to exclude from the returned _source field. + explode: true + delete_by_query::query._source_includes: + name: _source_includes + in: query + description: List of fields to extract and return from the _source field. + style: form + schema: + type: array + items: + type: string + description: List of fields to extract and return from the _source field. + explode: true + delete_by_query::query.allow_no_indices: + in: query + name: allow_no_indices + 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`. + schema: + type: boolean + style: form + delete_by_query::query.analyze_wildcard: + in: query + name: analyze_wildcard + description: If `true`, wildcard and prefix queries are analyzed. + schema: + type: boolean + style: form + delete_by_query::query.analyzer: + in: query + name: analyzer + description: Analyzer to use for the query string. + schema: + type: string + style: form + delete_by_query::query.conflicts: + in: query + name: conflicts + description: 'What to do if delete by query hits version conflicts: `abort` or `proceed`.' + schema: + $ref: '#/components/schemas/_common:Conflicts' + style: form + delete_by_query::query.default_operator: + in: query + name: default_operator + description: 'The default operator for query string query: `AND` or `OR`.' + schema: + $ref: '#/components/schemas/_common.query_dsl:Operator' + style: form + delete_by_query::query.df: + in: query + name: df + description: Field to use as default where no field prefix is given in the query string. + schema: + type: string + style: form + delete_by_query::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + delete_by_query::query.from: + in: query + name: from + description: 'Starting offset (default: 0)' + schema: + type: number + style: form + delete_by_query::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + delete_by_query::query.lenient: + in: query + name: lenient + description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + schema: + type: boolean + style: form + delete_by_query::query.max_docs: + in: query + name: max_docs + description: |- + Maximum number of documents to process. + Defaults to all documents. + schema: + type: number + style: form + delete_by_query::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + delete_by_query::query.q: + in: query + name: q + description: Query in the Lucene query string syntax. + schema: + type: string + style: form + delete_by_query::query.refresh: + in: query + name: refresh + description: If `true`, Opensearch refreshes all shards involved in the delete by query after the request completes. + schema: + type: boolean + style: form + delete_by_query::query.request_cache: + in: query + name: request_cache + description: |- + If `true`, the request cache is used for this request. + Defaults to the index-level setting. + schema: + type: boolean + style: form + delete_by_query::query.requests_per_second: + in: query + name: requests_per_second + description: The throttle for this request in sub-requests per second. + schema: + type: number + style: form + delete_by_query::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + delete_by_query::query.scroll: + in: query + name: scroll + description: Period to retain the search context for scrolling. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + delete_by_query::query.scroll_size: + in: query + name: scroll_size + description: Size of the scroll request that powers the operation. + schema: + type: number + style: form + delete_by_query::query.search_timeout: + in: query + name: search_timeout + description: |- + Explicit timeout for each search request. + Defaults to no timeout. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + delete_by_query::query.search_type: + in: query + name: search_type + description: |- + The type of the search operation. + Available options: `query_then_fetch`, `dfs_query_then_fetch`. + schema: + $ref: '#/components/schemas/_common:SearchType' + style: form + delete_by_query::query.size: + name: size + in: query + description: Deprecated, please use `max_docs` instead. + schema: + type: integer + description: Deprecated, please use `max_docs` instead. + format: int32 + delete_by_query::query.slices: + in: query + name: slices + description: The number of slices this task should be divided into. + schema: + $ref: '#/components/schemas/_common:Slices' + style: form + delete_by_query::query.sort: + in: query + name: sort + description: A comma-separated list of : pairs. + schema: + type: array + items: + type: string + style: form + delete_by_query::query.stats: + in: query + name: stats + description: Specific `tag` of the request for logging and statistical purposes. + schema: + type: array + items: + type: string + style: form + delete_by_query::query.terminate_after: + in: query + name: terminate_after + description: |- + Maximum number of documents to collect for each shard. + If a query reaches this limit, Opensearch terminates the query early. + Opensearch collects documents before sorting. + Use with caution. + Opensearch applies this parameter to each shard handling the request. + When possible, let Opensearch perform early termination automatically. + Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + schema: + type: number + style: form + delete_by_query::query.timeout: + in: query + name: timeout + description: Period each deletion request waits for active shards. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + delete_by_query::query.version: + in: query + name: version + description: If `true`, returns the document version as part of a hit. + schema: + type: boolean + style: form + delete_by_query::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + delete_by_query::query.wait_for_completion: + in: query + name: wait_for_completion + description: If `true`, the request blocks until the operation is complete. + schema: + type: boolean + style: form + delete_by_query_rethrottle::path.task_id: + in: path + name: task_id + description: The ID for the task. + required: true + schema: + $ref: '#/components/schemas/_common:TaskId' + style: simple + delete_by_query_rethrottle::query.requests_per_second: + in: query + name: requests_per_second + description: The throttle for this request in sub-requests per second. + schema: + type: number + style: form + delete_script::path.id: + in: path + name: id + description: Identifier for the stored script or search template. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + delete_script::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + delete_script::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + delete_script::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + exists::path.id: + in: path + name: id + description: Identifier of the document. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + exists::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases. + Supports wildcards (`*`). + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + exists::query._source: + in: query + name: _source + description: '`true` or `false` to return the `_source` field or not, or a list of fields to return.' + schema: + $ref: '#/components/schemas/_core.search:SourceConfigParam' + style: form + exists::query._source_excludes: + in: query + name: _source_excludes + description: A comma-separated list of source fields to exclude in the response. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + exists::query._source_includes: + in: query + name: _source_includes + description: A comma-separated list of source fields to include in the response. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + exists::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + exists::query.realtime: + in: query + name: realtime + description: If `true`, the request is real-time as opposed to near-real-time. + schema: + type: boolean + style: form + exists::query.refresh: + in: query + name: refresh + description: If `true`, Opensearch refreshes all shards involved in the delete by query after the request completes. + schema: + type: boolean + style: form + exists::query.routing: + in: query + name: routing + description: Target the specified primary shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + exists::query.stored_fields: + in: query + name: stored_fields + description: |- + 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. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + exists::query.version: + in: query + name: version + description: |- + Explicit version number for concurrency control. + The specified version must match the current version of the document for the request to succeed. + schema: + $ref: '#/components/schemas/_common:VersionNumber' + style: form + exists::query.version_type: + in: query + name: version_type + description: 'Specific version type: `external`, `external_gte`.' + schema: + $ref: '#/components/schemas/_common:VersionType' + style: form + exists_source::path.id: + in: path + name: id + description: Identifier of the document. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + exists_source::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases. + Supports wildcards (`*`). + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + exists_source::query._source: + in: query + name: _source + description: '`true` or `false` to return the `_source` field or not, or a list of fields to return.' + schema: + $ref: '#/components/schemas/_core.search:SourceConfigParam' + style: form + exists_source::query._source_excludes: + in: query + name: _source_excludes + description: A comma-separated list of source fields to exclude in the response. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + exists_source::query._source_includes: + in: query + name: _source_includes + description: A comma-separated list of source fields to include in the response. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + exists_source::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + exists_source::query.realtime: + in: query + name: realtime + description: If true, the request is real-time as opposed to near-real-time. + schema: + type: boolean + style: form + exists_source::query.refresh: + in: query + name: refresh + description: If `true`, Opensearch refreshes all shards involved in the delete by query after the request completes. + schema: + type: boolean + style: form + exists_source::query.routing: + in: query + name: routing + description: Target the specified primary shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + exists_source::query.version: + in: query + name: version + description: |- + Explicit version number for concurrency control. + The specified version must match the current version of the document for the request to succeed. + schema: + $ref: '#/components/schemas/_common:VersionNumber' + style: form + exists_source::query.version_type: + in: query + name: version_type + description: 'Specific version type: `external`, `external_gte`.' + schema: + $ref: '#/components/schemas/_common:VersionType' + style: form + explain::path.id: + in: path + name: id + description: Defines the document ID. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + explain::path.index: + in: path + name: index + description: |- + Index names used to limit the request. + Only a single index name can be provided to this parameter. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + explain::query._source: + in: query + name: _source + description: True or false to return the `_source` field or not, or a list of fields to return. + schema: + $ref: '#/components/schemas/_core.search:SourceConfigParam' + style: form + explain::query._source_excludes: + in: query + name: _source_excludes + description: A comma-separated list of source fields to exclude from the response. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + explain::query._source_includes: + in: query + name: _source_includes + description: A comma-separated list of source fields to include in the response. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + explain::query.analyze_wildcard: + in: query + name: analyze_wildcard + description: If `true`, wildcard and prefix queries are analyzed. + schema: + type: boolean + style: form + explain::query.analyzer: + in: query + name: analyzer + description: |- + Analyzer to use for the query string. + This parameter can only be used when the `q` query string parameter is specified. + schema: + type: string + style: form + explain::query.default_operator: + in: query + name: default_operator + description: 'The default operator for query string query: `AND` or `OR`.' + schema: + $ref: '#/components/schemas/_common.query_dsl:Operator' + style: form + explain::query.df: + in: query + name: df + description: Field to use as default where no field prefix is given in the query string. + schema: + type: string + style: form + explain::query.lenient: + in: query + name: lenient + description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + schema: + type: boolean + style: form + explain::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + explain::query.q: + in: query + name: q + description: Query in the Lucene query string syntax. + schema: + type: string + style: form + explain::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + explain::query.stored_fields: + in: query + name: stored_fields + description: A comma-separated list of stored fields to return in the response. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + field_caps::path.index: + in: path + name: index + 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. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + field_caps::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + field_caps::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + field_caps::query.fields: + in: query + name: fields + description: Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + field_caps::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `true`, missing or closed indices are not included in the response. + schema: + type: boolean + style: form + field_caps::query.include_unmapped: + in: query + name: include_unmapped + description: If true, unmapped fields are included in the response. + schema: + type: boolean + style: form + get::path.id: + in: path + name: id + description: Unique identifier of the document. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + get::path.index: + in: path + name: index + description: Name of the index that contains the document. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + get::query._source: + in: query + name: _source + description: True or false to return the _source field or not, or a list of fields to return. + schema: + $ref: '#/components/schemas/_core.search:SourceConfigParam' + style: form + get::query._source_excludes: + in: query + name: _source_excludes + description: A comma-separated list of source fields to exclude in the response. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + get::query._source_includes: + in: query + name: _source_includes + description: A comma-separated list of source fields to include in the response. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + get::query.preference: + in: query + name: preference + description: Specifies the node or shard the operation should be performed on. Random by default. + schema: + type: string + style: form + get::query.realtime: + in: query + name: realtime + description: If `true`, the request is real-time as opposed to near-real-time. + schema: + type: boolean + style: form + get::query.refresh: + in: query + name: refresh + description: If true, Opensearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + schema: + type: boolean + style: form + get::query.routing: + in: query + name: routing + description: Target the specified primary shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + get::query.stored_fields: + in: query + name: stored_fields + description: |- + 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. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + get::query.version: + in: query + name: version + description: Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + schema: + $ref: '#/components/schemas/_common:VersionNumber' + style: form + get::query.version_type: + in: query + name: version_type + description: 'Specific version type: internal, external, external_gte.' + schema: + $ref: '#/components/schemas/_common:VersionType' + style: form + get_script::path.id: + in: path + name: id + description: Identifier for the stored script or search template. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + get_script::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + get_script::query.master_timeout: + in: query + name: master_timeout + description: Specify timeout for connection to master + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + get_source::path.id: + in: path + name: id + description: Unique identifier of the document. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + get_source::path.index: + in: path + name: index + description: Name of the index that contains the document. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + get_source::query._source: + in: query + name: _source + description: True or false to return the _source field or not, or a list of fields to return. + schema: + $ref: '#/components/schemas/_core.search:SourceConfigParam' + style: form + get_source::query._source_excludes: + in: query + name: _source_excludes + description: A comma-separated list of source fields to exclude in the response. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + get_source::query._source_includes: + in: query + name: _source_includes + description: A comma-separated list of source fields to include in the response. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + get_source::query.preference: + in: query + name: preference + description: Specifies the node or shard the operation should be performed on. Random by default. + schema: + type: string + style: form + get_source::query.realtime: + in: query + name: realtime + description: Boolean) If true, the request is real-time as opposed to near-real-time. + schema: + type: boolean + style: form + get_source::query.refresh: + in: query + name: refresh + description: If true, Opensearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes. + schema: + type: boolean + style: form + get_source::query.routing: + in: query + name: routing + description: Target the specified primary shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + get_source::query.version: + in: query + name: version + description: Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + schema: + $ref: '#/components/schemas/_common:VersionNumber' + style: form + get_source::query.version_type: + in: query + name: version_type + description: 'Specific version type: internal, external, external_gte.' + schema: + $ref: '#/components/schemas/_common:VersionType' + style: form + index::path.id: + in: path + name: id + description: Unique identifier for the document. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + index::path.index: + in: path + name: index + description: Name of the data stream or index to target. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + index::query.if_primary_term: + in: query + name: if_primary_term + description: Only perform the operation if the document has this primary term. + schema: + type: number + style: form + index::query.if_seq_no: + in: query + name: if_seq_no + description: Only perform the operation if the document has this sequence number. + schema: + $ref: '#/components/schemas/_common:SequenceNumber' + style: form + index::query.op_type: + in: query + name: op_type + description: |- + Set to create to only index the document if it does not already exist (put if absent). + If a document with the specified `_id` already exists, the indexing operation will fail. + Same as using the `/_create` endpoint. + Valid values: `index`, `create`. + If document id is specified, it defaults to `index`. + Otherwise, it defaults to `create`. + schema: + $ref: '#/components/schemas/_common:OpType' + style: form + index::query.pipeline: + in: query + name: pipeline + description: |- + ID of the pipeline to use to preprocess incoming documents. + If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. + If a final pipeline is configured it will always run, regardless of the value of this parameter. + schema: + type: string + style: form + index::query.refresh: + in: query + name: refresh + description: |- + If `true`, Opensearch 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. + Valid values: `true`, `false`, `wait_for`. + schema: + $ref: '#/components/schemas/_common:Refresh' + style: form + index::query.require_alias: + in: query + name: require_alias + description: If `true`, the destination must be an index alias. + schema: + type: boolean + style: form + index::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + index::query.timeout: + in: query + name: timeout + description: 'Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.' + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + index::query.version: + in: query + name: version + description: |- + Explicit version number for concurrency control. + The specified version must match the current version of the document for the request to succeed. + schema: + $ref: '#/components/schemas/_common:VersionNumber' + style: form + index::query.version_type: + in: query + name: version_type + description: 'Specific version type: `external`, `external_gte`.' + schema: + $ref: '#/components/schemas/_common:VersionType' + style: form + index::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + indices.add_block::path.block: + in: path + name: block + description: The block to add (one of read, write, read_only or metadata) + required: true + schema: + $ref: '#/components/schemas/indices.add_block:IndicesBlockOptions' + style: simple + indices.add_block::path.index: + in: path + name: index + description: A comma separated list of indices to add a block to + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + indices.add_block::query.allow_no_indices: + in: query + name: allow_no_indices + 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) + schema: + type: boolean + style: form + indices.add_block::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.add_block::query.expand_wildcards: + in: query + name: expand_wildcards + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.add_block::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: Whether specified concrete indices should be ignored when unavailable (missing or closed) + schema: + type: boolean + style: form + indices.add_block::query.master_timeout: + in: query + name: master_timeout + description: Specify timeout for connection to master + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.add_block::query.timeout: + in: query + name: timeout + description: Explicit operation timeout + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + indices.analyze::path.index: + in: path + name: index + description: |- + Index used to derive the analyzer. + If specified, the `analyzer` or field parameter overrides this value. + If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + indices.analyze::query.index: + name: index + in: query + description: The name of the index to scope the operation. + schema: + type: string + description: The name of the index to scope the operation. + indices.clear_cache::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.clear_cache::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.clear_cache::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.clear_cache::query.fielddata: + in: query + name: fielddata + description: |- + If `true`, clears the fields cache. + Use the `fields` parameter to clear the cache of specific fields only. + schema: + type: boolean + style: form + indices.clear_cache::query.fields: + in: query + name: fields + description: Comma-separated list of field names used to limit the `fielddata` parameter. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + indices.clear_cache::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.clear_cache::query.index: + name: index + in: query + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + explode: true + indices.clear_cache::query.query: + in: query + name: query + description: If `true`, clears the query cache. + schema: + type: boolean + style: form + indices.clear_cache::query.request: + in: query + name: request + description: If `true`, clears the request cache. + schema: + type: boolean + style: form + indices.clone::path.index: + in: path + name: index + description: Name of the source index to clone. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + indices.clone::path.target: + in: path + name: target + description: Name of the target index to create. + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + indices.clone::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.clone::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.clone::query.task_execution_timeout: + name: task_execution_timeout + in: query + description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + schema: + $ref: '#/components/schemas/_common:Duration' + indices.clone::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + indices.clone::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + indices.clone::query.wait_for_completion: + name: wait_for_completion + in: query + description: Should this request wait until the operation has completed before returning. + schema: + type: boolean + default: true + description: Should this request wait until the operation has completed before returning. + indices.close::path.index: + in: path + name: index + description: Comma-separated list or wildcard expression of index names used to limit the request. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.close::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.close::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.close::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.close::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.close::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.close::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + indices.close::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + indices.create::path.index: + in: path + name: index + description: Name of the index you wish to create. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + indices.create::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.create::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.create::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + indices.create::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + indices.create_data_stream::path.name: + in: path + name: name + description: |- + Name of the data stream, which must meet the following criteria: + Lowercase only; + Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `#`, `:`, or a space character; + Cannot start with `-`, `_`, `+`, or `.ds-`; + Cannot be `.` or `..`; + Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster. + required: true + schema: + $ref: '#/components/schemas/_common:DataStreamName' + style: simple + indices.data_streams_stats::path.name: + in: path + name: name + description: |- + Comma-separated list of data streams used to limit the request. + Wildcard expressions (`*`) are supported. + To target all data streams in a cluster, omit this parameter or use `*`. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + indices.delete::path.index: + in: path + name: index + description: |- + Comma-separated list of indices to delete. + You cannot specify index aliases. + By default, this parameter does not support wildcards (`*`) or `_all`. + To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.delete::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.delete::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.delete::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.delete::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.delete::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.delete::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + indices.delete_alias::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams or indices used to limit the request. + Supports wildcards (`*`). + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.delete_alias::path.name: + in: path + name: name + description: |- + Comma-separated list of aliases to remove. + Supports wildcards (`*`). To remove all aliases, use `*` or `_all`. + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + indices.delete_alias::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.delete_alias::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.delete_alias::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + indices.delete_data_stream::path.name: + in: path + name: name + description: Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported. + required: true + schema: + $ref: '#/components/schemas/_common:DataStreamNames' + style: simple + indices.delete_index_template::path.name: + in: path + name: name + description: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + indices.delete_index_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.delete_index_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.delete_index_template::query.timeout: + in: query + name: timeout + description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + indices.delete_template::path.name: + in: path + name: name + description: |- + The name of the legacy index template to delete. + Wildcard (`*`) expressions are supported. + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + indices.delete_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.delete_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.delete_template::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + indices.exists::path.index: + in: path + name: index + description: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.exists::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.exists::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.exists::query.flat_settings: + in: query + name: flat_settings + description: If `true`, returns settings in flat format. + schema: + type: boolean + style: form + indices.exists::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.exists::query.include_defaults: + in: query + name: include_defaults + description: If `true`, return all default settings in the response. + schema: + type: boolean + style: form + indices.exists::query.local: + in: query + name: local + description: If `true`, the request retrieves information from the local node only. + schema: + type: boolean + style: form + indices.exists_alias::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). + To target all data streams and indices, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.exists_alias::path.name: + in: path + name: name + description: Comma-separated list of aliases to check. Supports wildcards (`*`). + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + indices.exists_alias::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.exists_alias::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.exists_alias::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. + schema: + type: boolean + style: form + indices.exists_alias::query.local: + in: query + name: local + description: If `true`, the request retrieves information from the local node only. + schema: + type: boolean + style: form + indices.exists_index_template::path.name: + in: path + name: name + description: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + indices.exists_index_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.exists_index_template::query.flat_settings: + name: flat_settings + in: query + description: Return settings in flat format. + schema: + type: boolean + default: false + description: Return settings in flat format. + indices.exists_index_template::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + indices.exists_index_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.exists_template::path.name: + in: path + name: name + description: The comma separated names of the index templates + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + indices.exists_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.exists_template::query.flat_settings: + in: query + name: flat_settings + description: 'Return settings in flat format (default: false)' + schema: + type: boolean + style: form + indices.exists_template::query.local: + in: query + name: local + description: 'Return local information, do not retrieve the state from master node (default: false)' + schema: + type: boolean + style: form + indices.exists_template::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.flush::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases to flush. + Supports wildcards (`*`). + To flush all data streams and indices, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.flush::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.flush::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.flush::query.force: + in: query + name: force + description: If `true`, the request forces a flush even if there are no changes to commit to the index. + schema: + type: boolean + style: form + indices.flush::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.flush::query.wait_if_ongoing: + in: query + name: wait_if_ongoing + description: |- + If `true`, the flush operation blocks until execution when another flush operation is running. + If `false`, Opensearch returns an error if you request a flush when another flush operation is running. + schema: + type: boolean + style: form + indices.forcemerge::path.index: + in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.forcemerge::query.allow_no_indices: + in: query + name: allow_no_indices + 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) + schema: + type: boolean + style: form + indices.forcemerge::query.expand_wildcards: + in: query + name: expand_wildcards + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.forcemerge::query.flush: + in: query + name: flush + description: 'Specify whether the index should be flushed after performing the operation (default: true)' + schema: + type: boolean + style: form + indices.forcemerge::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: Whether specified concrete indices should be ignored when unavailable (missing or closed) + schema: + type: boolean + style: form + indices.forcemerge::query.max_num_segments: + in: query + name: max_num_segments + description: 'The number of segments the index should be merged into (default: dynamic)' + schema: + type: number + style: form + indices.forcemerge::query.only_expunge_deletes: + in: query + name: only_expunge_deletes + description: Specify whether the operation should only expunge deleted documents + schema: + type: boolean + style: form + indices.forcemerge::query.primary_only: + name: primary_only + in: query + description: Specify whether the operation should only perform on primary shards. Defaults to false. + schema: + type: boolean + default: false + description: Specify whether the operation should only perform on primary shards. Defaults to false. + indices.forcemerge::query.wait_for_completion: + in: query + name: wait_for_completion + description: Should the request wait until the force merge is completed. + schema: + type: boolean + style: form + indices.get::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and index aliases used to limit the request. + Wildcard expressions (*) are supported. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.get::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.get::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.get::query.expand_wildcards: + in: query + name: expand_wildcards + 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. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.get::query.flat_settings: + in: query + name: flat_settings + description: If true, returns settings in flat format. + schema: + type: boolean + style: form + indices.get::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If false, requests that target a missing index return an error. + schema: + type: boolean + style: form + indices.get::query.include_defaults: + in: query + name: include_defaults + description: If true, return all default settings in the response. + schema: + type: boolean + style: form + indices.get::query.local: + in: query + name: local + description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + schema: + type: boolean + style: form + indices.get::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.get_alias::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams or indices used to limit the request. + Supports wildcards (`*`). + To target all data streams and indices, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.get_alias::path.name: + in: path + name: name + description: |- + Comma-separated list of aliases to retrieve. + Supports wildcards (`*`). + To retrieve all aliases, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + indices.get_alias::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.get_alias::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.get_alias::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.get_alias::query.local: + in: query + name: local + description: If `true`, the request retrieves information from the local node only. + schema: + type: boolean + style: form + indices.get_data_stream::path.name: + in: path + name: name + description: |- + Comma-separated list of data stream names used to limit the request. + Wildcard (`*`) expressions are supported. If omitted, all data streams are returned. + required: true + schema: + $ref: '#/components/schemas/_common:DataStreamNames' + style: simple + indices.get_field_mapping::path.fields: + in: path + name: fields + description: Comma-separated list or wildcard expression of fields used to limit returned information. + required: true + schema: + $ref: '#/components/schemas/_common:Fields' + style: simple + indices.get_field_mapping::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.get_field_mapping::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.get_field_mapping::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.get_field_mapping::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.get_field_mapping::query.include_defaults: + in: query + name: include_defaults + description: If `true`, return all default settings in the response. + schema: + type: boolean + style: form + indices.get_field_mapping::query.local: + in: query + name: local + description: If `true`, the request retrieves information from the local node only. + schema: + type: boolean + style: form + indices.get_index_template::path.name: + in: path + name: name + description: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + indices.get_index_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.get_index_template::query.flat_settings: + in: query + name: flat_settings + description: If true, returns settings in flat format. + schema: + type: boolean + style: form + indices.get_index_template::query.local: + in: query + name: local + description: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + schema: + type: boolean + style: form + indices.get_index_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.get_mapping::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.get_mapping::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.get_mapping::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.get_mapping::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.get_mapping::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.get_mapping::query.local: + in: query + name: local + description: If `true`, the request retrieves information from the local node only. + schema: + type: boolean + style: form + indices.get_mapping::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.get_settings::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.get_settings::path.name: + in: path + name: name + description: Comma-separated list or wildcard expression of settings to retrieve. + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + indices.get_settings::query.allow_no_indices: + in: query + name: allow_no_indices + 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`. + schema: + type: boolean + style: form + indices.get_settings::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.get_settings::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.get_settings::query.flat_settings: + in: query + name: flat_settings + description: If `true`, returns settings in flat format. + schema: + type: boolean + style: form + indices.get_settings::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.get_settings::query.include_defaults: + in: query + name: include_defaults + description: If `true`, return all default settings in the response. + schema: + type: boolean + style: form + indices.get_settings::query.local: + in: query + name: local + description: |- + If `true`, the request retrieves information from the local node only. If + `false`, information is retrieved from the master node. + schema: + type: boolean + style: form + indices.get_settings::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.get_template::path.name: + in: path + name: name + description: |- + Comma-separated list of index template names used to limit the request. + Wildcard (`*`) expressions are supported. + To return all index templates, omit this parameter or use a value of `_all` or `*`. + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + indices.get_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.get_template::query.flat_settings: + in: query + name: flat_settings + description: If `true`, returns settings in flat format. + schema: + type: boolean + style: form + indices.get_template::query.local: + in: query + name: local + description: If `true`, the request retrieves information from the local node only. + schema: + type: boolean + style: form + indices.get_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.get_upgrade::path.index: + name: index + in: path + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + x-data-type: array + required: true + indices.get_upgrade::query.allow_no_indices: + name: allow_no_indices + in: 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). + schema: + type: boolean + 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). + indices.get_upgrade::query.expand_wildcards: + name: expand_wildcards + in: query + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + indices.get_upgrade::query.ignore_unavailable: + name: ignore_unavailable + in: query + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + schema: + type: boolean + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + indices.open::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases used to limit the request. + Supports wildcards (`*`). + By default, you must explicitly name the indices you using to limit the request. + To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. + You can update this setting in the `opensearch.yml` file or using the cluster update settings API. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.open::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.open::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.open::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.open::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.open::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.open::query.task_execution_timeout: + name: task_execution_timeout + in: query + description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + schema: + $ref: '#/components/schemas/_common:Duration' + indices.open::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + indices.open::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + indices.open::query.wait_for_completion: + name: wait_for_completion + in: query + description: Should this request wait until the operation has completed before returning. + schema: + type: boolean + default: true + description: Should this request wait until the operation has completed before returning. + indices.put_alias::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams or indices to add. + Supports wildcards (`*`). + Wildcard patterns that match both data streams and indices return an error. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.put_alias::path.name: + in: path + name: name + description: |- + Alias to update. + If the alias doesn’t exist, the request creates it. + Index alias names support date math. + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + indices.put_alias::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.put_alias::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.put_alias::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + indices.put_index_template::path.name: + in: path + name: name + description: Index or template name + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + indices.put_index_template::query.cause: + name: cause + in: query + description: User defined reason for creating/updating the index template. + schema: + type: string + default: 'false' + description: User defined reason for creating/updating the index template. + indices.put_index_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.put_index_template::query.create: + in: query + name: create + description: If `true`, this request cannot replace or update existing index templates. + schema: + type: boolean + style: form + indices.put_index_template::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + indices.put_mapping::path.index: + in: path + name: index + 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. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.put_mapping::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.put_mapping::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.put_mapping::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.put_mapping::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.put_mapping::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.put_mapping::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + indices.put_mapping::query.write_index_only: + in: query + name: write_index_only + description: If `true`, the mappings are applied only to the current write index for the target. + schema: + type: boolean + style: form + indices.put_settings::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.put_settings::query.allow_no_indices: + in: query + name: allow_no_indices + 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`. + schema: + type: boolean + style: form + indices.put_settings::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.put_settings::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.put_settings::query.flat_settings: + in: query + name: flat_settings + description: If `true`, returns settings in flat format. + schema: + type: boolean + style: form + indices.put_settings::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `true`, returns settings in flat format. + schema: + type: boolean + style: form + indices.put_settings::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.put_settings::query.preserve_existing: + in: query + name: preserve_existing + description: If `true`, existing index settings remain unchanged. + schema: + type: boolean + style: form + indices.put_settings::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. If no response is received before the + timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + indices.put_template::path.name: + in: path + name: name + description: The name of the template + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + indices.put_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.put_template::query.create: + in: query + name: create + description: If true, this request cannot replace or update existing index templates. + schema: + type: boolean + style: form + indices.put_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.put_template::query.order: + in: query + name: order + description: |- + Order in which Opensearch 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. + schema: + type: number + style: form + indices.recovery::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.recovery::query.active_only: + in: query + name: active_only + description: If `true`, the response only includes ongoing shard recoveries. + schema: + type: boolean + style: form + indices.recovery::query.detailed: + in: query + name: detailed + description: If `true`, the response includes detailed information about shard recoveries. + schema: + type: boolean + style: form + indices.refresh::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.refresh::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.refresh::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.refresh::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.resolve_index::path.name: + in: path + name: name + description: |- + Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. + Resources on remote clusters can be specified using the ``:`` syntax. + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + indices.resolve_index::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.rollover::path.alias: + in: path + name: alias + description: Name of the data stream or index alias to roll over. + required: true + schema: + $ref: '#/components/schemas/_common:IndexAlias' + style: simple + indices.rollover::path.new_index: + in: path + name: new_index + description: |- + Name of the index to create. + Supports date math. + Data streams do not support this parameter. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + indices.rollover::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.rollover::query.dry_run: + in: query + name: dry_run + description: If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. + schema: + type: boolean + style: form + indices.rollover::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.rollover::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + indices.rollover::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + indices.segments::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.segments::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.segments::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.segments::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.segments::query.verbose: + in: query + name: verbose + description: If `true`, the request returns a verbose response. + schema: + type: boolean + style: form + indices.shard_stores::path.index: + in: path + name: index + description: List of data streams, indices, and aliases used to limit the request. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.shard_stores::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.shard_stores::query.expand_wildcards: + in: query + name: expand_wildcards + 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. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.shard_stores::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If true, missing or closed indices are not included in the response. + schema: + type: boolean + style: form + indices.shard_stores::query.status: + in: query + name: status + description: List of shard health statuses used to limit the request. + schema: + oneOf: + - $ref: '#/components/schemas/indices.shard_stores:ShardStoreStatus' + - type: array + items: + $ref: '#/components/schemas/indices.shard_stores:ShardStoreStatus' + style: form + indices.shrink::path.index: + in: path + name: index + description: Name of the source index to shrink. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + indices.shrink::path.target: + in: path + name: target + description: Name of the target index to create. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + indices.shrink::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.shrink::query.copy_settings: + name: copy_settings + in: query + description: whether or not to copy settings from the source index. + schema: + type: boolean + default: false + description: whether or not to copy settings from the source index. + indices.shrink::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.shrink::query.task_execution_timeout: + name: task_execution_timeout + in: query + description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + schema: + $ref: '#/components/schemas/_common:Duration' + indices.shrink::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + indices.shrink::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + indices.shrink::query.wait_for_completion: + name: wait_for_completion + in: query + description: Should this request wait until the operation has completed before returning. + schema: + type: boolean + default: true + description: Should this request wait until the operation has completed before returning. + indices.simulate_index_template::path.name: + in: path + name: name + description: Index or template name to simulate + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + indices.simulate_index_template::query.cause: + name: cause + in: query + description: User defined reason for dry-run creating the new template for simulation purposes. + schema: + type: string + default: 'false' + description: User defined reason for dry-run creating the new template for simulation purposes. + indices.simulate_index_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.simulate_index_template::query.create: + in: query + name: create + 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. + schema: + type: boolean + style: form + indices.simulate_index_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.simulate_template::path.name: + in: path + name: name + 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. + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + indices.simulate_template::query.cause: + name: cause + in: query + description: User defined reason for dry-run creating the new template for simulation purposes. + schema: + type: string + default: 'false' + description: User defined reason for dry-run creating the new template for simulation purposes. + indices.simulate_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.simulate_template::query.create: + in: query + name: create + 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. + schema: + type: boolean + style: form + indices.simulate_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.split::path.index: + in: path + name: index + description: Name of the source index to split. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + indices.split::path.target: + in: path + name: target + description: Name of the target index to create. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + indices.split::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.split::query.copy_settings: + name: copy_settings + in: query + description: whether or not to copy settings from the source index. + schema: + type: boolean + default: false + description: whether or not to copy settings from the source index. + indices.split::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.split::query.task_execution_timeout: + name: task_execution_timeout + in: query + description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + schema: + $ref: '#/components/schemas/_common:Duration' + indices.split::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + indices.split::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + indices.split::query.wait_for_completion: + name: wait_for_completion + in: query + description: Should this request wait until the operation has completed before returning. + schema: + type: boolean + default: true + description: Should this request wait until the operation has completed before returning. + indices.stats::path.index: + in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.stats::path.metric: + in: path + name: metric + description: Limit the information returned the specific metrics. + required: true + schema: + $ref: '#/components/schemas/_common:Metrics' + style: simple + indices.stats::query.completion_fields: + in: query + name: completion_fields + description: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + indices.stats::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.stats::query.fielddata_fields: + in: query + name: fielddata_fields + description: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + indices.stats::query.fields: + in: query + name: fields + description: Comma-separated list or wildcard expressions of fields to include in the statistics. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + indices.stats::query.forbid_closed_indices: + in: query + name: forbid_closed_indices + description: If true, statistics are not collected from closed indices. + schema: + type: boolean + style: form + indices.stats::query.groups: + in: query + name: groups + description: Comma-separated list of search groups to include in the search statistics. + schema: + oneOf: + - type: string + - type: array + items: + type: string + style: form + indices.stats::query.include_segment_file_sizes: + in: query + name: include_segment_file_sizes + description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + schema: + type: boolean + style: form + indices.stats::query.include_unloaded_segments: + in: query + name: include_unloaded_segments + description: If true, the response includes information from segments that are not loaded into memory. + schema: + type: boolean + style: form + indices.stats::query.level: + in: query + name: level + description: Indicates whether statistics are aggregated at the cluster, index, or shard level. + schema: + $ref: '#/components/schemas/_common:Level' + style: form + indices.update_aliases::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + indices.update_aliases::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.update_aliases::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + indices.upgrade::path.index: + name: index + in: path + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + x-data-type: array + required: true + indices.upgrade::query.allow_no_indices: + name: allow_no_indices + in: 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). + schema: + type: boolean + 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). + indices.upgrade::query.expand_wildcards: + name: expand_wildcards + in: query + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + indices.upgrade::query.ignore_unavailable: + name: ignore_unavailable + in: query + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + schema: + type: boolean + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + indices.upgrade::query.only_ancient_segments: + name: only_ancient_segments + in: query + description: If true, only ancient (an older Lucene major release) segments will be upgraded. + schema: + type: boolean + description: If true, only ancient (an older Lucene major release) segments will be upgraded. + indices.upgrade::query.wait_for_completion: + name: wait_for_completion + in: query + description: Should this request wait until the operation has completed before returning. + schema: + type: boolean + default: false + description: Should this request wait until the operation has completed before returning. + indices.validate_query::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases to search. + Supports wildcards (`*`). + To search all data streams or indices, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + indices.validate_query::query.all_shards: + in: query + name: all_shards + description: If `true`, the validation is executed on all shards instead of one random shard per index. + schema: + type: boolean + style: form + indices.validate_query::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.validate_query::query.analyze_wildcard: + in: query + name: analyze_wildcard + description: If `true`, wildcard and prefix queries are analyzed. + schema: + type: boolean + style: form + indices.validate_query::query.analyzer: + in: query + name: analyzer + description: |- + Analyzer to use for the query string. + This parameter can only be used when the `q` query string parameter is specified. + schema: + type: string + style: form + indices.validate_query::query.default_operator: + in: query + name: default_operator + description: 'The default operator for query string query: `AND` or `OR`.' + schema: + $ref: '#/components/schemas/_common.query_dsl:Operator' + style: form + indices.validate_query::query.df: + in: query + name: df + description: |- + Field to use as default where no field prefix is given in the query string. + This parameter can only be used when the `q` query string parameter is specified. + schema: + type: string + style: form + indices.validate_query::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + indices.validate_query::query.explain: + in: query + name: explain + description: If `true`, the response returns detailed information if an error has occurred. + schema: + type: boolean + style: form + indices.validate_query::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.validate_query::query.lenient: + in: query + name: lenient + description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + schema: + type: boolean + style: form + indices.validate_query::query.q: + in: query + name: q + description: Query in the Lucene query string syntax. + schema: + type: string + style: form + indices.validate_query::query.rewrite: + in: query + name: rewrite + description: If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. + schema: + type: boolean + style: form + ingest.delete_pipeline::path.id: + in: path + name: id + description: |- + Pipeline ID or wildcard expression of pipeline IDs used to limit the request. + To delete all ingest pipelines in a cluster, use a value of `*`. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + ingest.delete_pipeline::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + ingest.delete_pipeline::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + ingest.delete_pipeline::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + ingest.get_pipeline::path.id: + in: path + name: id + description: |- + Comma-separated list of pipeline IDs to retrieve. + Wildcard (`*`) expressions are supported. + To get all ingest pipelines, omit this parameter or use `*`. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + ingest.get_pipeline::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + ingest.get_pipeline::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + ingest.put_pipeline::path.id: + in: path + name: id + description: ID of the ingest pipeline to create or update. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + ingest.put_pipeline::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + ingest.put_pipeline::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + ingest.put_pipeline::query.timeout: + in: query + name: timeout + description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + ingest.simulate::path.id: + in: path + name: id + description: |- + Pipeline to test. + If you don’t specify a `pipeline` in the request body, this parameter is required. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + ingest.simulate::query.verbose: + in: query + name: verbose + description: If `true`, the response includes output data for each processor in the executed pipeline. + schema: + type: boolean + style: form + knn.delete_model::path.model_id: + name: model_id + in: path + description: The id of the model. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: The id of the model. + required: true + knn.get_model::path.model_id: + name: model_id + in: path + description: The id of the model. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: The id of the model. + required: true + knn.search_models::query._source: + name: _source + in: query + description: True or false to return the _source field or not, or a list of fields to return. + style: form + schema: + type: array + items: + type: string + description: True or false to return the _source field or not, or a list of fields to return. + explode: true + knn.search_models::query._source_excludes: + name: _source_excludes + in: query + description: List of fields to exclude from the returned _source field. + style: form + schema: + type: array + items: + type: string + description: List of fields to exclude from the returned _source field. + explode: true + knn.search_models::query._source_includes: + name: _source_includes + in: query + description: List of fields to extract and return from the _source field. + style: form + schema: + type: array + items: + type: string + description: List of fields to extract and return from the _source field. + explode: true + knn.search_models::query.allow_no_indices: + name: allow_no_indices + in: 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). + schema: + type: boolean + 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). + knn.search_models::query.allow_partial_search_results: + name: allow_partial_search_results + in: query + description: Indicate if an error should be returned if there is a partial search failure or timeout. + schema: + type: boolean + default: true + description: Indicate if an error should be returned if there is a partial search failure or timeout. + knn.search_models::query.analyze_wildcard: + name: analyze_wildcard + in: query + description: Specify whether wildcard and prefix queries should be analyzed. + schema: + type: boolean + default: false + description: Specify whether wildcard and prefix queries should be analyzed. + knn.search_models::query.analyzer: + name: analyzer + in: query + description: The analyzer to use for the query string. + schema: + type: string + description: The analyzer to use for the query string. + knn.search_models::query.batched_reduce_size: + name: batched_reduce_size + in: query + 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. + schema: + type: integer + default: 512 + 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. + format: int32 + knn.search_models::query.ccs_minimize_roundtrips: + name: ccs_minimize_roundtrips + in: query + description: Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution. + schema: + type: boolean + default: true + description: Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution. + knn.search_models::query.default_operator: + name: default_operator + in: query + description: The default operator for query string query (AND or OR). + schema: + $ref: '#/components/schemas/knn._common:DefaultOperator' + knn.search_models::query.df: + name: df + in: query + description: The field to use as default where no field prefix is given in the query string. + schema: + type: string + description: The field to use as default where no field prefix is given in the query string. + knn.search_models::query.docvalue_fields: + name: docvalue_fields + in: query + description: Comma-separated list of fields to return as the docvalue representation of a field for each hit. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of fields to return as the docvalue representation of a field for each hit. + explode: true + knn.search_models::query.expand_wildcards: + name: expand_wildcards + in: query + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + knn.search_models::query.explain: + name: explain + in: query + description: Specify whether to return detailed information about score computation as part of a hit. + schema: + type: boolean + description: Specify whether to return detailed information about score computation as part of a hit. + knn.search_models::query.from: + name: from + in: query + description: Starting offset. + schema: + type: integer + default: 0 + description: Starting offset. + format: int32 + knn.search_models::query.ignore_throttled: + name: ignore_throttled + in: query + description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + schema: + type: boolean + description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + knn.search_models::query.ignore_unavailable: + name: ignore_unavailable + in: query + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + schema: + type: boolean + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + knn.search_models::query.lenient: + name: lenient + in: query + description: Specify whether format-based query failures (such as providing text to a numeric field) should be ignored. + schema: + type: boolean + description: Specify whether format-based query failures (such as providing text to a numeric field) should be ignored. + knn.search_models::query.max_concurrent_shard_requests: + name: max_concurrent_shard_requests + in: query + 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. + schema: + type: integer + default: 5 + 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. + format: int32 + knn.search_models::query.pre_filter_shard_size: + name: pre_filter_shard_size + in: query + description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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. + schema: + type: integer + description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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. + format: int32 + knn.search_models::query.preference: + name: preference + in: query + description: Specify the node or shard the operation should be performed on. + schema: + type: string + default: random + description: Specify the node or shard the operation should be performed on. + knn.search_models::query.q: + name: q + in: query + description: Query in the Lucene query string syntax. + schema: + type: string + description: Query in the Lucene query string syntax. + knn.search_models::query.request_cache: + name: request_cache + in: query + description: Specify if request cache should be used for this request or not, defaults to index level setting. + schema: + type: boolean + description: Specify if request cache should be used for this request or not, defaults to index level setting. + knn.search_models::query.rest_total_hits_as_int: + name: rest_total_hits_as_int + in: query + description: Indicates whether hits.total should be rendered as an integer or an object in the rest search response. + schema: + type: boolean + default: false + description: Indicates whether hits.total should be rendered as an integer or an object in the rest search response. + knn.search_models::query.routing: + name: routing + in: query + description: Comma-separated list of specific routing values. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of specific routing values. + explode: true + knn.search_models::query.scroll: + name: scroll + in: query + description: Specify how long a consistent view of the index should be maintained for scrolled search. + schema: + $ref: '#/components/schemas/_common:Duration' + knn.search_models::query.search_type: + name: search_type + in: query + description: Search operation type. + schema: + $ref: '#/components/schemas/knn._common:SearchType' + knn.search_models::query.seq_no_primary_term: + name: seq_no_primary_term + in: query + description: Specify whether to return sequence number and primary term of the last modification of each hit. + schema: + type: boolean + description: Specify whether to return sequence number and primary term of the last modification of each hit. + knn.search_models::query.size: + name: size + in: query + description: Number of hits to return. + schema: + type: integer + default: 10 + description: Number of hits to return. + format: int32 + knn.search_models::query.sort: + name: sort + in: query + description: Comma-separated list of : pairs. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of : pairs. + explode: true + knn.search_models::query.stats: + name: stats + in: query + description: Specific 'tag' of the request for logging and statistical purposes. + style: form + schema: + type: array + items: + type: string + description: Specific 'tag' of the request for logging and statistical purposes. + explode: true + knn.search_models::query.stored_fields: + name: stored_fields + in: query + description: Comma-separated list of stored fields to return. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of stored fields to return. + explode: true + knn.search_models::query.suggest_field: + name: suggest_field + in: query + description: Specify which field to use for suggestions. + schema: + type: string + description: Specify which field to use for suggestions. + knn.search_models::query.suggest_mode: + name: suggest_mode + in: query + description: Specify suggest mode. + schema: + $ref: '#/components/schemas/knn._common:SuggestMode' + knn.search_models::query.suggest_size: + name: suggest_size + in: query + description: How many suggestions to return in response. + schema: + type: integer + description: How many suggestions to return in response. + format: int32 + knn.search_models::query.suggest_text: + name: suggest_text + in: query + description: The source text for which the suggestions should be returned. + schema: + type: string + description: The source text for which the suggestions should be returned. + knn.search_models::query.terminate_after: + name: terminate_after + in: query + description: The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. + schema: + type: integer + description: The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. + format: int32 + knn.search_models::query.timeout: + name: timeout + in: query + description: Operation timeout. + schema: + $ref: '#/components/schemas/_common:Duration' + knn.search_models::query.track_scores: + name: track_scores + in: query + description: Whether to calculate and return scores even if they are not used for sorting. + schema: + type: boolean + description: Whether to calculate and return scores even if they are not used for sorting. + knn.search_models::query.track_total_hits: + name: track_total_hits + in: query + description: Indicate if the number of documents that match the query should be tracked. + schema: + type: boolean + description: Indicate if the number of documents that match the query should be tracked. + knn.search_models::query.typed_keys: + name: typed_keys + in: query + description: Specify whether aggregation and suggester names should be prefixed by their respective types in the response. + schema: + type: boolean + description: Specify whether aggregation and suggester names should be prefixed by their respective types in the response. + knn.search_models::query.version: + name: version + in: query + description: Whether to return document version as part of a hit. + schema: + type: boolean + description: Whether to return document version as part of a hit. + knn.stats::path.node_id: + name: node_id + in: path + description: 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. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: 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. + x-data-type: array + required: true + knn.stats::path.stat: + name: stat + in: path + description: Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats. + x-enum-options: + - circuit_breaker_triggered + - total_load_time + - eviction_count + - hit_count + - miss_count + - graph_memory_usage + - graph_memory_usage_percentage + - graph_index_requests + - graph_index_errors + - graph_query_requests + - graph_query_errors + - knn_query_requests + - cache_capacity_reached + - load_success_count + - load_exception_count + - indices_in_cache + - script_compilations + - script_compilation_errors + - script_query_requests + - script_query_errors + - nmslib_initialized + - faiss_initialized + - model_index_status + - indexing_from_model_degraded + - training_requests + - training_errors + - training_memory_usage + - training_memory_usage_percentage + x-data-type: array + required: true + knn.stats::query.timeout: + name: timeout + in: query + description: Operation timeout. + schema: + $ref: '#/components/schemas/_common:Duration' + knn.train_model::path.model_id: + name: model_id + in: path + description: The id of the model. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: The id of the model. + required: true + knn.train_model::query.preference: + name: preference + in: query + description: Preferred node to execute training. + schema: + type: string + description: Preferred node to execute training. + knn.warmup::path.index: + name: index + in: path + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + x-data-type: array + required: true + mget::path.index: + in: path + name: index + 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. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + mget::query._source: + in: query + name: _source + description: True or false to return the `_source` field or not, or a list of fields to return. + schema: + $ref: '#/components/schemas/_core.search:SourceConfigParam' + style: form + mget::query._source_excludes: + in: query + name: _source_excludes + description: |- + 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. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + mget::query._source_includes: + in: query + name: _source_includes + description: |- + 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. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + mget::query.preference: + in: query + name: preference + description: Specifies the node or shard the operation should be performed on. Random by default. + schema: + type: string + style: form + mget::query.realtime: + in: query + name: realtime + description: If `true`, the request is real-time as opposed to near-real-time. + schema: + type: boolean + style: form + mget::query.refresh: + in: query + name: refresh + description: If `true`, the request refreshes relevant shards before retrieving documents. + schema: + type: boolean + style: form + mget::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + mget::query.stored_fields: + in: query + name: stored_fields + description: If `true`, retrieves the document fields stored in the index rather than the document `_source`. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + msearch::path.index: + in: path + name: index + description: Comma-separated list of data streams, indices, and index aliases to search. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + msearch::query.ccs_minimize_roundtrips: + in: query + name: ccs_minimize_roundtrips + description: If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. + schema: + type: boolean + style: form + msearch::query.max_concurrent_searches: + in: query + name: max_concurrent_searches + description: Maximum number of concurrent searches the multi search API can execute. + schema: + type: number + style: form + msearch::query.max_concurrent_shard_requests: + in: query + name: max_concurrent_shard_requests + description: Maximum number of concurrent shard requests that each sub-search request executes per node. + schema: + type: number + style: form + msearch::query.pre_filter_shard_size: + in: query + name: pre_filter_shard_size + description: 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. + schema: + type: number + style: form + msearch::query.rest_total_hits_as_int: + in: query + name: rest_total_hits_as_int + description: If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + schema: + type: boolean + style: form + msearch::query.search_type: + in: query + name: search_type + description: Indicates whether global term and document frequencies should be used when scoring returned documents. + schema: + $ref: '#/components/schemas/_common:SearchType' + style: form + msearch::query.typed_keys: + in: query + name: typed_keys + description: Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. + schema: + type: boolean + style: form + msearch_template::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases to search. + Supports wildcards (`*`). + To search all data streams and indices, omit this parameter or use `*`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + msearch_template::query.ccs_minimize_roundtrips: + in: query + name: ccs_minimize_roundtrips + description: If `true`, network round-trips are minimized for cross-cluster search requests. + schema: + type: boolean + style: form + msearch_template::query.max_concurrent_searches: + in: query + name: max_concurrent_searches + description: Maximum number of concurrent searches the API can run. + schema: + type: number + style: form + msearch_template::query.rest_total_hits_as_int: + in: query + name: rest_total_hits_as_int + description: |- + If `true`, the response returns `hits.total` as an integer. + If `false`, it returns `hits.total` as an object. + schema: + type: boolean + style: form + msearch_template::query.search_type: + in: query + name: search_type + description: |- + The type of the search operation. + Available options: `query_then_fetch`, `dfs_query_then_fetch`. + schema: + $ref: '#/components/schemas/_common:SearchType' + style: form + msearch_template::query.typed_keys: + in: query + name: typed_keys + description: If `true`, the response prefixes aggregation and suggester names with their respective types. + schema: + type: boolean + style: form + mtermvectors::path.index: + in: path + name: index + description: Name of the index that contains the documents. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + mtermvectors::query.field_statistics: + in: query + name: field_statistics + description: If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + schema: + type: boolean + style: form + mtermvectors::query.fields: + in: query + name: fields + description: |- + Comma-separated list or wildcard expressions of fields to include in the statistics. + Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + mtermvectors::query.ids: + in: query + name: ids + description: A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body + schema: + type: array + items: + $ref: '#/components/schemas/_common:Id' + style: form + mtermvectors::query.offsets: + in: query + name: offsets + description: If `true`, the response includes term offsets. + schema: + type: boolean + style: form + mtermvectors::query.payloads: + in: query + name: payloads + description: If `true`, the response includes term payloads. + schema: + type: boolean + style: form + mtermvectors::query.positions: + in: query + name: positions + description: If `true`, the response includes term positions. + schema: + type: boolean + style: form + mtermvectors::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + mtermvectors::query.realtime: + in: query + name: realtime + description: If true, the request is real-time as opposed to near-real-time. + schema: + type: boolean + style: form + mtermvectors::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + mtermvectors::query.term_statistics: + in: query + name: term_statistics + description: If true, the response includes term frequency and document frequency. + schema: + type: boolean + style: form + mtermvectors::query.version: + in: query + name: version + description: If `true`, returns the document version as part of a hit. + schema: + $ref: '#/components/schemas/_common:VersionNumber' + style: form + mtermvectors::query.version_type: + in: query + name: version_type + description: Specific version type. + schema: + $ref: '#/components/schemas/_common:VersionType' + style: form + nodes.hot_threads::path.node_id: + name: node_id + in: path + description: 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. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: 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. + x-data-type: array + required: true + nodes.hot_threads::query.ignore_idle_threads: + name: ignore_idle_threads + in: query + description: Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue. + schema: + type: boolean + default: true + description: Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue. + nodes.hot_threads::query.interval: + name: interval + in: query + description: The interval for the second sampling of threads. + schema: + $ref: '#/components/schemas/_common:Duration' + nodes.hot_threads::query.snapshots: + name: snapshots + in: query + description: Number of samples of thread stacktrace. + schema: + type: integer + default: 10 + description: Number of samples of thread stacktrace. + format: int32 + nodes.hot_threads::query.threads: + name: threads + in: query + description: Specify the number of threads to provide information for. + schema: + type: integer + default: 3 + description: Specify the number of threads to provide information for. + format: int32 + nodes.hot_threads::query.timeout: + name: timeout + in: query + description: Operation timeout. + schema: + $ref: '#/components/schemas/_common:Duration' + nodes.hot_threads::query.type: + name: type + in: query + description: The type to sample. + schema: + $ref: '#/components/schemas/nodes._common:SampleType' + nodes.info::path.metric: + in: path + name: metric + description: Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. + required: true + schema: + $ref: '#/components/schemas/_common:Metrics' + style: simple + nodes.info::path.node_id: + in: path + name: node_id + description: Comma-separated list of node IDs or names used to limit returned information. + required: true + schema: + $ref: '#/components/schemas/_common:NodeIds' + style: simple + nodes.info::query.flat_settings: + in: query + name: flat_settings + description: If true, returns settings in flat format. + schema: + type: boolean + style: form + nodes.info::query.timeout: + in: query + name: timeout + description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + nodes.reload_secure_settings::path.node_id: + in: path + name: node_id + description: The names of particular nodes in the cluster to target. + required: true + schema: + $ref: '#/components/schemas/_common:NodeIds' + style: simple + nodes.reload_secure_settings::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + nodes.stats::path.index_metric: + in: path + name: index_metric + description: Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified. + required: true + schema: + $ref: '#/components/schemas/_common:Metrics' + style: simple + nodes.stats::path.metric: + in: path + name: metric + description: Limit the information returned to the specified metrics + required: true + schema: + $ref: '#/components/schemas/_common:Metrics' + style: simple + nodes.stats::path.node_id: + in: path + name: node_id + description: Comma-separated list of node IDs or names used to limit returned information. + required: true + schema: + $ref: '#/components/schemas/_common:NodeIds' + style: simple + nodes.stats::query.completion_fields: + in: query + name: completion_fields + description: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + nodes.stats::query.fielddata_fields: + in: query + name: fielddata_fields + description: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + nodes.stats::query.fields: + in: query + name: fields + description: Comma-separated list or wildcard expressions of fields to include in the statistics. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + nodes.stats::query.groups: + in: query + name: groups + description: Comma-separated list of search groups to include in the search statistics. + schema: + type: boolean + style: form + nodes.stats::query.include_segment_file_sizes: + in: query + name: include_segment_file_sizes + description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + schema: + type: boolean + style: form + nodes.stats::query.level: + in: query + name: level + description: Indicates whether statistics are aggregated at the cluster, index, or shard level. + schema: + $ref: '#/components/schemas/_common:Level' + style: form + nodes.stats::query.timeout: + in: query + name: timeout + description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + nodes.stats::query.types: + in: query + name: types + description: A comma-separated list of document types for the indexing index metric. + schema: + type: array + items: + type: string + style: form + nodes.usage::path.metric: + in: path + name: metric + description: |- + Limits the information returned to the specific metrics. + A comma-separated list of the following options: `_all`, `rest_actions`. + required: true + schema: + $ref: '#/components/schemas/_common:Metrics' + style: simple + nodes.usage::path.node_id: + in: path + name: node_id + 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 + required: true + schema: + $ref: '#/components/schemas/_common:NodeIds' + style: simple + nodes.usage::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + notifications.delete_config::path.config_id: + name: config_id + in: path + schema: + type: string + required: true + notifications.delete_config::query.config_id: + name: config_id + in: query + description: A channel ID. + schema: + type: string + description: A channel ID. + notifications.delete_config::query.config_id_list: + name: config_id_list + in: query + description: A comma-separated list of channel IDs. + schema: + type: string + description: A comma-separated list of channel IDs. + notifications.get_config::path.config_id: + name: config_id + in: path + schema: + type: string + required: true + notifications.get_config::query.chime.url: + name: chime.url + in: query + schema: + type: string + notifications.get_config::query.chime.url.keyword: + name: chime.url.keyword + in: query + schema: + type: string + notifications.get_config::query.config_type: + name: config_type + in: query + description: Type of notification configuration. + schema: + $ref: '#/components/schemas/notifications._common:NotificationConfigType' + notifications.get_config::query.created_time_ms: + name: created_time_ms + in: query + schema: + type: integer + format: int64 + notifications.get_config::query.description: + name: description + in: query + schema: + type: string + notifications.get_config::query.description.keyword: + name: description.keyword + in: query + schema: + type: string + notifications.get_config::query.email.email_account_id: + name: email.email_account_id + in: query + schema: + type: string + notifications.get_config::query.email.email_group_id_list: + name: email.email_group_id_list + in: query + schema: + type: string + notifications.get_config::query.email.recipient_list.recipient: + name: email.recipient_list.recipient + in: query + schema: + type: string + notifications.get_config::query.email.recipient_list.recipient.keyword: + name: email.recipient_list.recipient.keyword + in: query + schema: + type: string + notifications.get_config::query.email_group.recipient_list.recipient: + name: email_group.recipient_list.recipient + in: query + schema: + type: string + notifications.get_config::query.email_group.recipient_list.recipient.keyword: + name: email_group.recipient_list.recipient.keyword + in: query + schema: + type: string + notifications.get_config::query.is_enabled: + name: is_enabled + in: query + schema: + type: boolean + notifications.get_config::query.last_updated_time_ms: + name: last_updated_time_ms + in: query + schema: + type: integer + format: int64 + notifications.get_config::query.microsoft_teams.url: + name: microsoft_teams.url + in: query + schema: + type: string + notifications.get_config::query.microsoft_teams.url.keyword: + name: microsoft_teams.url.keyword + in: query + schema: + type: string + notifications.get_config::query.name: + name: name + in: query + schema: + type: string + notifications.get_config::query.name.keyword: + name: name.keyword + in: query + schema: + type: string + notifications.get_config::query.query: + name: query + in: query + schema: + type: string + notifications.get_config::query.ses_account.from_address: + name: ses_account.from_address + in: query + schema: + type: string + notifications.get_config::query.ses_account.from_address.keyword: + name: ses_account.from_address.keyword + in: query + schema: + type: string + notifications.get_config::query.ses_account.region: + name: ses_account.region + in: query + schema: + type: string + notifications.get_config::query.ses_account.role_arn: + name: ses_account.role_arn + in: query + schema: + type: string + notifications.get_config::query.ses_account.role_arn.keyword: + name: ses_account.role_arn.keyword + in: query + schema: + type: string + notifications.get_config::query.slack.url: + name: slack.url + in: query + schema: + type: string + notifications.get_config::query.slack.url.keyword: + name: slack.url.keyword + in: query + schema: + type: string + notifications.get_config::query.smtp_account.from_address: + name: smtp_account.from_address + in: query + schema: + type: string + notifications.get_config::query.smtp_account.from_address.keyword: + name: smtp_account.from_address.keyword + in: query + schema: + type: string + notifications.get_config::query.smtp_account.host: + name: smtp_account.host + in: query + schema: + type: string + notifications.get_config::query.smtp_account.host.keyword: + name: smtp_account.host.keyword + in: query + schema: + type: string + notifications.get_config::query.smtp_account.method: + name: smtp_account.method + in: query + schema: + type: string + notifications.get_config::query.sns.role_arn: + name: sns.role_arn + in: query + schema: + type: string + notifications.get_config::query.sns.role_arn.keyword: + name: sns.role_arn.keyword + in: query + schema: + type: string + notifications.get_config::query.sns.topic_arn: + name: sns.topic_arn + in: query + schema: + type: string + notifications.get_config::query.sns.topic_arn.keyword: + name: sns.topic_arn.keyword + in: query + schema: + type: string + notifications.get_config::query.text_query: + name: text_query + in: query + schema: + type: string + notifications.get_config::query.webhook.url: + name: webhook.url + in: query + schema: + type: string + notifications.get_config::query.webhook.url.keyword: + name: webhook.url.keyword + in: query + schema: + type: string + notifications.send_test::path.config_id: + name: config_id + in: path + schema: + type: string + required: true + notifications.update_config::path.config_id: + name: config_id + in: path + schema: + type: string + required: true + put_script::path.context: + in: path + name: context + description: |- + Context in which the script or search template should run. + To prevent errors, the API immediately compiles the script or template in this context. + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + put_script::path.id: + in: path + name: id + description: |- + Identifier for the stored script or search template. + Must be unique within the cluster. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + put_script::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + put_script::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + put_script::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + rank_eval::path.index: + in: path + name: index + 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 `*`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + rank_eval::query.allow_no_indices: + in: query + name: allow_no_indices + 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`. + schema: + type: boolean + style: form + rank_eval::query.expand_wildcards: + in: query + name: expand_wildcards + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + rank_eval::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `true`, missing or closed indices are not included in the response. + schema: + type: boolean + style: form + rank_eval::query.search_type: + in: query + name: search_type + description: Search operation type + schema: + type: string + style: form + reindex::query.max_docs: + name: max_docs + in: query + description: 'Maximum number of documents to process (default: all documents).' + schema: + type: integer + description: 'Maximum number of documents to process (default: all documents).' + format: int32 + reindex::query.refresh: + in: query + name: refresh + description: If `true`, the request refreshes affected shards to make this operation visible to search. + schema: + type: boolean + style: form + reindex::query.requests_per_second: + in: query + name: requests_per_second + description: |- + The throttle for this request in sub-requests per second. + Defaults to no throttle. + schema: + type: number + style: form + reindex::query.scroll: + in: query + name: scroll + description: Specifies how long a consistent view of the index should be maintained for scrolled search. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + reindex::query.slices: + in: query + name: slices + description: |- + The number of slices this task should be divided into. + Defaults to 1 slice, meaning the task isn’t sliced into subtasks. + schema: + $ref: '#/components/schemas/_common:Slices' + style: form + reindex::query.timeout: + in: query + name: timeout + description: Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + reindex::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + reindex::query.wait_for_completion: + in: query + name: wait_for_completion + description: If `true`, the request blocks until the operation is complete. + schema: + type: boolean + style: form + reindex_rethrottle::path.task_id: + in: path + name: task_id + description: Identifier for the task. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + reindex_rethrottle::query.requests_per_second: + in: query + name: requests_per_second + description: The throttle for this request in sub-requests per second. + schema: + type: number + style: form + remote_store.restore::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + remote_store.restore::query.wait_for_completion: + name: wait_for_completion + in: query + description: Should this request wait until the operation has completed before returning. + schema: + type: boolean + default: false + description: Should this request wait until the operation has completed before returning. + render_search_template::path.id: + in: path + name: id + description: |- + ID of the search template to render. + If no `source` is specified, this or the `id` request body parameter is required. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + scroll::path.scroll_id: + in: path + name: scroll_id + description: The scroll ID + required: true + deprecated: true + schema: + $ref: '#/components/schemas/_common:ScrollId' + style: simple + scroll::query.rest_total_hits_as_int: + in: query + name: rest_total_hits_as_int + 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. + schema: + type: boolean + style: form + scroll::query.scroll: + in: query + name: scroll + description: Period to retain the search context for scrolling. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + scroll::query.scroll_id: + in: query + name: scroll_id + description: The scroll ID for scrolled search + deprecated: true + schema: + $ref: '#/components/schemas/_common:ScrollId' + style: form + search::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases to search. + Supports wildcards (`*`). + To search all data streams and indices, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + search::query._source: + in: query + name: _source + description: |- + Indicates which source fields are returned for matching documents. + These fields are returned in the `hits._source` property of the search response. + Valid values are: + `true` to return the entire document source; + `false` to not return the document source; + `` to return the source fields that are specified as a comma-separated list (supports wildcard (`*`) patterns). + schema: + $ref: '#/components/schemas/_core.search:SourceConfigParam' + style: form + search::query._source_excludes: + in: query + name: _source_excludes + description: |- + 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. + If the `_source` parameter is `false`, this parameter is ignored. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + search::query._source_includes: + in: query + name: _source_includes + description: |- + 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. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + search::query.allow_no_indices: + in: query + name: allow_no_indices + 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`. + schema: + type: boolean + style: form + search::query.allow_partial_search_results: + in: query + name: allow_partial_search_results + description: If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. + schema: + type: boolean + style: form + search::query.analyze_wildcard: + in: query + name: analyze_wildcard + description: |- + If true, wildcard and prefix queries are analyzed. + This parameter can only be used when the q query string parameter is specified. + schema: + type: boolean + style: form + search::query.analyzer: + in: query + name: analyzer + description: |- + Analyzer to use for the query string. + This parameter can only be used when the q query string parameter is specified. + schema: + type: string + style: form + search::query.batched_reduce_size: + in: query + name: batched_reduce_size + 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. + schema: + type: number + style: form + search::query.ccs_minimize_roundtrips: + in: query + name: ccs_minimize_roundtrips + description: If true, network round-trips between the coordinating node and the remote clusters are minimized when executing cross-cluster search (CCS) requests. + schema: + type: boolean + style: form + search::query.default_operator: + in: query + name: default_operator + description: |- + The default operator for query string query: AND or OR. + This parameter can only be used when the `q` query string parameter is specified. + schema: + $ref: '#/components/schemas/_common.query_dsl:Operator' + style: form + search::query.df: + in: query + name: df + description: |- + Field to use as default where no field prefix is given in the query string. + This parameter can only be used when the q query string parameter is specified. + schema: + type: string + style: form + search::query.docvalue_fields: + in: query + name: docvalue_fields + description: A comma-separated list of fields to return as the docvalue representation for each hit. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + search::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + search::query.explain: + in: query + name: explain + description: If `true`, returns detailed information about score computation as part of a hit. + schema: + type: boolean + style: form + search::query.from: + in: query + name: from + description: |- + Starting document offset. + Needs to be non-negative. + 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. + schema: + type: number + style: form + search::query.ignore_throttled: + in: query + name: ignore_throttled + description: If `true`, concrete, expanded or aliased indices will be ignored when frozen. + schema: + type: boolean + style: form + search::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + search::query.include_named_queries_score: + name: include_named_queries_score + in: query + description: Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) + schema: + type: boolean + default: false + description: Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) + search::query.lenient: + in: query + name: lenient + description: |- + If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + This parameter can only be used when the `q` query string parameter is specified. + schema: + type: boolean + style: form + search::query.max_concurrent_shard_requests: + in: query + name: max_concurrent_shard_requests + description: |- + Defines 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. + schema: + type: number + style: form + search::query.pre_filter_shard_size: + in: query + name: pre_filter_shard_size + description: |- + 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 (if date filters are mandatory to match but the shard bounds and the query are disjoint). + When unspecified, the pre-filter phase is executed if any of these conditions is met: + the request targets more than 128 shards; + the request targets one or more read-only index; + the primary sort of the query targets an indexed field. + schema: + type: number + style: form + search::query.preference: + in: query + name: preference + description: |- + Nodes and shards used for the search. + By default, Opensearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: + `_only_local` to run the search only on shards on the local node; + `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method; + `_only_nodes:,` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method; + `_prefer_nodes:,` to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method; + `_shards:,` to run the search only on the specified shards; + `` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order. + schema: + type: string + style: form + search::query.q: + in: query + name: q + description: |- + Query in the Lucene query string syntax using query parameter search. + Query parameter searches do not support the full Opensearch Query DSL but are handy for testing. + schema: + type: string + style: form + search::query.request_cache: + in: query + name: request_cache + description: |- + If `true`, the caching of search results is enabled for requests where `size` is `0`. + Defaults to index level settings. + schema: + type: boolean + style: form + search::query.rest_total_hits_as_int: + in: query + name: rest_total_hits_as_int + description: Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. + schema: + type: boolean + style: form + search::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + search::query.scroll: + in: query + name: scroll + description: |- + Period to retain the search context for scrolling. See Scroll search results. + By default, this value cannot exceed `1d` (24 hours). + You can change this limit using the `search.max_keep_alive` cluster-level setting. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + search::query.search_pipeline: + name: search_pipeline + in: query + description: Customizable sequence of processing stages applied to search queries. + schema: + type: string + description: Customizable sequence of processing stages applied to search queries. + search::query.search_type: + in: query + name: search_type + description: How distributed term frequencies are calculated for relevance scoring. + schema: + $ref: '#/components/schemas/_common:SearchType' + style: form + search::query.seq_no_primary_term: + in: query + name: seq_no_primary_term + description: If `true`, returns sequence number and primary term of the last modification of each hit. + schema: + type: boolean + style: form + search::query.size: + in: query + name: size + description: |- + Defines 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. + schema: + type: number + style: form + search::query.sort: + in: query + name: sort + description: A comma-separated list of : pairs. + schema: + oneOf: + - type: string + - type: array + items: + type: string + style: form + search::query.stats: + in: query + name: stats + description: Specific `tag` of the request for logging and statistical purposes. + schema: + type: array + items: + type: string + style: form + search::query.stored_fields: + in: query + name: stored_fields + description: |- + A comma-separated 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. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + search::query.suggest_field: + in: query + name: suggest_field + description: Specifies which field to use for suggestions. + schema: + $ref: '#/components/schemas/_common:Field' + style: form + search::query.suggest_mode: + in: query + name: suggest_mode + description: |- + Specifies the suggest mode. + This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + schema: + $ref: '#/components/schemas/_common:SuggestMode' + style: form + search::query.suggest_size: + in: query + name: suggest_size + description: |- + Number of suggestions to return. + This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + schema: + type: number + style: form + search::query.suggest_text: + in: query + name: suggest_text + description: |- + The source text for which the suggestions should be returned. + This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + schema: + type: string + style: form + search::query.terminate_after: + in: query + name: terminate_after + description: |- + Maximum number of documents to collect for each shard. + If a query reaches this limit, Opensearch terminates the query early. + Opensearch collects documents before sorting. + Use with caution. + Opensearch applies this parameter to each shard handling the request. + When possible, let Opensearch perform early termination automatically. + Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + If set to `0` (default), the query does not terminate early. + schema: + type: number + style: form + search::query.timeout: + in: query + name: timeout + description: |- + 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. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + search::query.track_scores: + in: query + name: track_scores + description: If `true`, calculate and return document scores, even if the scores are not used for sorting. + schema: + type: boolean + style: form + search::query.track_total_hits: + in: query + name: track_total_hits + description: |- + 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. + schema: + $ref: '#/components/schemas/_core.search:TrackHits' + style: form + search::query.typed_keys: + in: query + name: typed_keys + description: If `true`, aggregation and suggester names are be prefixed by their respective types in the response. + schema: + type: boolean + style: form + search::query.version: + in: query + name: version + description: If `true`, returns document version as part of a hit. + schema: + type: boolean + style: form + search_pipeline.create::path.pipeline: + name: pipeline + in: path + schema: + type: string + required: true + search_pipeline.get::path.pipeline: + name: pipeline + in: path + schema: + type: string + required: true + search_shards::path.index: + in: path + name: index + description: Returns the indices and shards that a search request would be executed against. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + search_shards::query.allow_no_indices: + in: query + name: allow_no_indices + 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`. + schema: + type: boolean + style: form + search_shards::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + search_shards::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + search_shards::query.local: + in: query + name: local + description: If `true`, the request retrieves information from the local node only. + schema: + type: boolean + style: form + search_shards::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + search_shards::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + search_template::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, + and aliases to search. Supports wildcards (*). + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + search_template::query.allow_no_indices: + in: query + name: allow_no_indices + 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`. + schema: + type: boolean + style: form + search_template::query.ccs_minimize_roundtrips: + in: query + name: ccs_minimize_roundtrips + description: If `true`, network round-trips are minimized for cross-cluster search requests. + schema: + type: boolean + style: form + search_template::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + search_template::query.explain: + in: query + name: explain + description: If `true`, the response includes additional details about score computation as part of a hit. + schema: + type: boolean + style: form + search_template::query.ignore_throttled: + in: query + name: ignore_throttled + description: If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. + schema: + type: boolean + style: form + search_template::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + search_template::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + search_template::query.profile: + in: query + name: profile + description: If `true`, the query execution is profiled. + schema: + type: boolean + style: form + search_template::query.rest_total_hits_as_int: + in: query + name: rest_total_hits_as_int + description: If true, hits.total are rendered as an integer in the response. + schema: + type: boolean + style: form + search_template::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + search_template::query.scroll: + in: query + name: scroll + description: |- + Specifies how long a consistent view of the index + should be maintained for scrolled search. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + search_template::query.search_type: + in: query + name: search_type + description: The type of the search operation. + schema: + $ref: '#/components/schemas/_common:SearchType' + style: form + search_template::query.typed_keys: + in: query + name: typed_keys + description: If `true`, the response prefixes aggregation and suggester names with their respective types. + schema: + type: boolean + style: form + security.create_action_group::path.action_group: + name: action_group + in: path + description: The name of the action group to create or replace + schema: + type: string + description: The name of the action group to create or replace + required: true + security.create_role::path.role: + name: role + in: path + schema: + type: string + required: true + security.create_role_mapping::path.role: + name: role + in: path + schema: + type: string + required: true + security.create_tenant::path.tenant: + name: tenant + in: path + schema: + type: string + required: true + security.create_user::path.username: + name: username + in: path + schema: + type: string + required: true + security.delete_action_group::path.action_group: + name: action_group + in: path + description: Action group to delete. + schema: + type: string + description: Action group to delete. + required: true + security.delete_distinguished_names::path.cluster_name: + name: cluster_name + in: path + schema: + type: string + required: true + security.delete_role::path.role: + name: role + in: path + schema: + type: string + required: true + security.delete_role_mapping::path.role: + name: role + in: path + schema: + type: string + required: true + security.delete_tenant::path.tenant: + name: tenant + in: path + schema: + type: string + required: true + security.delete_user::path.username: + name: username + in: path + schema: + type: string + required: true + security.get_action_group::path.action_group: + name: action_group + in: path + description: Action group to retrieve. + schema: + type: string + description: Action group to retrieve. + required: true + security.get_distinguished_names::path.cluster_name: + name: cluster_name + in: path + schema: + type: string + required: true + security.get_role::path.role: + name: role + in: path + schema: + type: string + required: true + security.get_role_mapping::path.role: + name: role + in: path + schema: + type: string + required: true + security.get_tenant::path.tenant: + name: tenant + in: path + schema: + type: string + required: true + security.get_user::path.username: + name: username + in: path + schema: + type: string + required: true + security.patch_action_group::path.action_group: + name: action_group + in: path + schema: + type: string + required: true + security.patch_role::path.role: + name: role + in: path + schema: + type: string + required: true + security.patch_role_mapping::path.role: + name: role + in: path + schema: + type: string + required: true + security.patch_tenant::path.tenant: + name: tenant + in: path + schema: + type: string + required: true + security.patch_user::path.username: + name: username + in: path + schema: + type: string + required: true + security.update_distinguished_names::path.cluster_name: + name: cluster_name + in: path + schema: + type: string + required: true + snapshot.cleanup_repository::path.repository: + in: path + name: repository + description: Snapshot repository to clean up. + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + snapshot.cleanup_repository::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + snapshot.cleanup_repository::query.master_timeout: + in: query + name: master_timeout + description: Period to wait for a connection to the master node. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.cleanup_repository::query.timeout: + in: query + name: timeout + description: Period to wait for a response. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + snapshot.clone::path.repository: + in: path + name: repository + description: A repository name + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + snapshot.clone::path.snapshot: + in: path + name: snapshot + description: The name of the snapshot to clone from + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + snapshot.clone::path.target_snapshot: + in: path + name: target_snapshot + description: The name of the cloned snapshot to create + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + snapshot.clone::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + snapshot.clone::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.create::path.repository: + in: path + name: repository + description: Repository for the snapshot. + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + snapshot.create::path.snapshot: + in: path + name: snapshot + description: Name of the snapshot. Must be unique in the repository. + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + snapshot.create::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + snapshot.create::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.create::query.wait_for_completion: + in: query + name: wait_for_completion + description: If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes. + schema: + type: boolean + style: form + snapshot.create_repository::path.repository: + in: path + name: repository + description: A repository name + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + snapshot.create_repository::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + snapshot.create_repository::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.create_repository::query.timeout: + in: query + name: timeout + description: Explicit operation timeout + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + snapshot.create_repository::query.verify: + in: query + name: verify + description: Whether to verify the repository after creation + schema: + type: boolean + style: form + snapshot.delete::path.repository: + in: path + name: repository + description: A repository name + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + snapshot.delete::path.snapshot: + in: path + name: snapshot + description: A comma-separated list of snapshot names + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + snapshot.delete::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + snapshot.delete::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.delete_repository::path.repository: + in: path + name: repository + description: Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + snapshot.delete_repository::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + snapshot.delete_repository::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.delete_repository::query.timeout: + in: query + name: timeout + description: Explicit operation timeout + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + snapshot.get::path.repository: + in: path + name: repository + description: Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported. + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + snapshot.get::path.snapshot: + in: path + name: snapshot + description: |- + 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. + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + snapshot.get::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + snapshot.get::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If false, the request returns an error for any snapshots that are unavailable. + schema: + type: boolean + style: form + snapshot.get::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.get::query.verbose: + in: query + name: verbose + description: If true, returns additional information about each snapshot such as the version of Opensearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + schema: + type: boolean + style: form + snapshot.get_repository::path.repository: + in: path + name: repository + description: A comma-separated list of repository names + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + snapshot.get_repository::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + snapshot.get_repository::query.local: + in: query + name: local + description: 'Return local information, do not retrieve the state from master node (default: false)' + schema: + type: boolean + style: form + snapshot.get_repository::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.restore::path.repository: + in: path + name: repository + description: A repository name + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + snapshot.restore::path.snapshot: + in: path + name: snapshot + description: A snapshot name + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + snapshot.restore::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + snapshot.restore::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.restore::query.wait_for_completion: + in: query + name: wait_for_completion + description: Should this request wait until the operation has completed before returning + schema: + type: boolean + style: form + snapshot.status::path.repository: + in: path + name: repository + description: A repository name + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + snapshot.status::path.snapshot: + in: path + name: snapshot + description: A comma-separated list of snapshot names + required: true + schema: + $ref: '#/components/schemas/_common:Names' + style: simple + snapshot.status::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + snapshot.status::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown + schema: + type: boolean + style: form + snapshot.status::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.verify_repository::path.repository: + in: path + name: repository + description: A repository name + required: true + schema: + $ref: '#/components/schemas/_common:Name' + style: simple + snapshot.verify_repository::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '#/components/schemas/_common:Duration' + x-version-added: 2.0.0 + snapshot.verify_repository::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.verify_repository::query.timeout: + in: query + name: timeout + description: Explicit operation timeout + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + tasks.cancel::path.task_id: + in: path + name: task_id + description: ID of the task. + required: true + schema: + $ref: '#/components/schemas/_common:TaskId' + style: simple + tasks.cancel::query.actions: + in: query + name: actions + description: Comma-separated list or wildcard expression of actions used to limit the request. + schema: + oneOf: + - type: string + - type: array + items: + type: string + style: form + tasks.cancel::query.nodes: + in: query + name: nodes + description: Comma-separated list of node IDs or names used to limit the request. + schema: + type: array + items: + type: string + style: form + tasks.cancel::query.parent_task_id: + in: query + name: parent_task_id + description: Parent task ID used to limit the tasks. + schema: + type: string + style: form + tasks.cancel::query.wait_for_completion: + in: query + name: wait_for_completion + description: Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false + schema: + type: boolean + style: form + tasks.get::path.task_id: + in: path + name: task_id + description: ID of the task. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + tasks.get::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + tasks.get::query.wait_for_completion: + in: query + name: wait_for_completion + description: If `true`, the request blocks until the task has completed. + schema: + type: boolean + style: form + tasks.list::query.actions: + in: query + name: actions + description: Comma-separated list or wildcard expression of actions used to limit the request. + schema: + oneOf: + - type: string + - type: array + items: + type: string + style: form + tasks.list::query.detailed: + in: query + name: detailed + description: If `true`, the response includes detailed information about shard recoveries. + schema: + type: boolean + style: form + tasks.list::query.group_by: + in: query + name: group_by + description: Key used to group tasks in the response. + schema: + $ref: '#/components/schemas/tasks._common:GroupBy' + style: form + tasks.list::query.nodes: + name: nodes + in: query + description: 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. + style: form + schema: + type: array + items: + type: string + description: 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. + explode: true + tasks.list::query.parent_task_id: + in: query + name: parent_task_id + description: Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of `-1`. + schema: + $ref: '#/components/schemas/_common:Id' + style: form + tasks.list::query.timeout: + in: query + name: timeout + description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + tasks.list::query.wait_for_completion: + in: query + name: wait_for_completion + description: If `true`, the request blocks until the operation is complete. + schema: + type: boolean + style: form + termvectors::path.id: + in: path + name: id + description: Unique identifier of the document. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + termvectors::path.index: + in: path + name: index + description: Name of the index that contains the document. + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + termvectors::query.field_statistics: + in: query + name: field_statistics + description: If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + schema: + type: boolean + style: form + termvectors::query.fields: + in: query + name: fields + description: |- + Comma-separated list or wildcard expressions of fields to include in the statistics. + Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + termvectors::query.offsets: + in: query + name: offsets + description: If `true`, the response includes term offsets. + schema: + type: boolean + style: form + termvectors::query.payloads: + in: query + name: payloads + description: If `true`, the response includes term payloads. + schema: + type: boolean + style: form + termvectors::query.positions: + in: query + name: positions + description: If `true`, the response includes term positions. + schema: + type: boolean + style: form + termvectors::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + termvectors::query.realtime: + in: query + name: realtime + description: If true, the request is real-time as opposed to near-real-time. + schema: + type: boolean + style: form + termvectors::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + termvectors::query.term_statistics: + in: query + name: term_statistics + description: If `true`, the response includes term frequency and document frequency. + schema: + type: boolean + style: form + termvectors::query.version: + in: query + name: version + description: If `true`, returns the document version as part of a hit. + schema: + $ref: '#/components/schemas/_common:VersionNumber' + style: form + termvectors::query.version_type: + in: query + name: version_type + description: Specific version type. + schema: + $ref: '#/components/schemas/_common:VersionType' + style: form + update::path.id: + in: path + name: id + description: Document ID + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + update::path.index: + in: path + name: index + description: The name of the index + required: true + schema: + $ref: '#/components/schemas/_common:IndexName' + style: simple + update::query._source: + in: query + name: _source + description: |- + Set to false to disable source retrieval. You can also specify a comma-separated + list of the fields you want to retrieve. + schema: + $ref: '#/components/schemas/_core.search:SourceConfigParam' + style: form + update::query._source_excludes: + in: query + name: _source_excludes + description: Specify the source fields you want to exclude. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + update::query._source_includes: + in: query + name: _source_includes + description: Specify the source fields you want to retrieve. + schema: + $ref: '#/components/schemas/_common:Fields' + style: form + update::query.if_primary_term: + in: query + name: if_primary_term + description: Only perform the operation if the document has this primary term. + schema: + type: number + style: form + update::query.if_seq_no: + in: query + name: if_seq_no + description: Only perform the operation if the document has this sequence number. + schema: + $ref: '#/components/schemas/_common:SequenceNumber' + style: form + update::query.lang: + in: query + name: lang + description: The script language. + schema: + type: string + style: form + update::query.refresh: + in: query + name: refresh + description: |- + If 'true', Opensearch 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. + schema: + $ref: '#/components/schemas/_common:Refresh' + style: form + update::query.require_alias: + in: query + name: require_alias + description: If true, the destination must be an index alias. + schema: + type: boolean + style: form + update::query.retry_on_conflict: + in: query + name: retry_on_conflict + description: Specify how many times should the operation be retried when a conflict occurs. + schema: + type: number + style: form + update::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + update::query.timeout: + in: query + name: timeout + description: |- + Period to wait for dynamic mapping updates and active shards. + This guarantees Opensearch waits for at least the timeout before failing. + The actual wait time could be longer, particularly when multiple waits occur. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + update::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + description: |- + 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. + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + update_by_query::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases to search. + Supports wildcards (`*`). + To search all data streams or indices, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '#/components/schemas/_common:Indices' + style: simple + update_by_query::query._source: + name: _source + in: query + description: True or false to return the _source field or not, or a list of fields to return. + style: form + schema: + type: array + items: + type: string + description: True or false to return the _source field or not, or a list of fields to return. + explode: true + update_by_query::query._source_excludes: + name: _source_excludes + in: query + description: List of fields to exclude from the returned _source field. + style: form + schema: + type: array + items: + type: string + description: List of fields to exclude from the returned _source field. + explode: true + update_by_query::query._source_includes: + name: _source_includes + in: query + description: List of fields to extract and return from the _source field. + style: form + schema: + type: array + items: + type: string + description: List of fields to extract and return from the _source field. + explode: true + update_by_query::query.allow_no_indices: + in: query + name: allow_no_indices + 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`. + schema: + type: boolean + style: form + update_by_query::query.analyze_wildcard: + in: query + name: analyze_wildcard + description: If `true`, wildcard and prefix queries are analyzed. + schema: + type: boolean + style: form + update_by_query::query.analyzer: + in: query + name: analyzer + description: Analyzer to use for the query string. + schema: + type: string + style: form + update_by_query::query.conflicts: + in: query + name: conflicts + description: 'What to do if update by query hits version conflicts: `abort` or `proceed`.' + schema: + $ref: '#/components/schemas/_common:Conflicts' + style: form + update_by_query::query.default_operator: + in: query + name: default_operator + description: 'The default operator for query string query: `AND` or `OR`.' + schema: + $ref: '#/components/schemas/_common.query_dsl:Operator' + style: form + update_by_query::query.df: + in: query + name: df + description: Field to use as default where no field prefix is given in the query string. + schema: + type: string + style: form + update_by_query::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '#/components/schemas/_common:ExpandWildcards' + style: form + update_by_query::query.from: + in: query + name: from + description: 'Starting offset (default: 0)' + schema: + type: number + style: form + update_by_query::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + update_by_query::query.lenient: + in: query + name: lenient + description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + schema: + type: boolean + style: form + update_by_query::query.max_docs: + in: query + name: max_docs + description: |- + Maximum number of documents to process. + Defaults to all documents. + schema: + type: number + style: form + update_by_query::query.pipeline: + in: query + name: pipeline + description: |- + ID of the pipeline to use to preprocess incoming documents. + If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. + If a final pipeline is configured it will always run, regardless of the value of this parameter. + schema: + type: string + style: form + update_by_query::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + update_by_query::query.q: + name: q + in: query + description: Query in the Lucene query string syntax. + schema: + type: string + description: Query in the Lucene query string syntax. + update_by_query::query.refresh: + in: query + name: refresh + description: If `true`, Opensearch refreshes affected shards to make the operation visible to search. + schema: + type: boolean + style: form + update_by_query::query.request_cache: + in: query + name: request_cache + description: If `true`, the request cache is used for this request. + schema: + type: boolean + style: form + update_by_query::query.requests_per_second: + in: query + name: requests_per_second + description: The throttle for this request in sub-requests per second. + schema: + type: number + style: form + update_by_query::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '#/components/schemas/_common:Routing' + style: form + update_by_query::query.scroll: + in: query + name: scroll + description: Period to retain the search context for scrolling. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + update_by_query::query.scroll_size: + in: query + name: scroll_size + description: Size of the scroll request that powers the operation. + schema: + type: number + style: form + update_by_query::query.search_timeout: + in: query + name: search_timeout + description: Explicit timeout for each search request. + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + update_by_query::query.search_type: + in: query + name: search_type + description: 'The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`.' + schema: + $ref: '#/components/schemas/_common:SearchType' + style: form + update_by_query::query.size: + name: size + in: query + description: Deprecated, please use `max_docs` instead. + schema: + type: integer + description: Deprecated, please use `max_docs` instead. + format: int32 + update_by_query::query.slices: + in: query + name: slices + description: The number of slices this task should be divided into. + schema: + $ref: '#/components/schemas/_common:Slices' + style: form + update_by_query::query.sort: + in: query + name: sort + description: A comma-separated list of : pairs. + schema: + type: array + items: + type: string + style: form + update_by_query::query.stats: + in: query + name: stats + description: Specific `tag` of the request for logging and statistical purposes. + schema: + type: array + items: + type: string + style: form + update_by_query::query.terminate_after: + in: query + name: terminate_after + description: |- + Maximum number of documents to collect for each shard. + If a query reaches this limit, Opensearch terminates the query early. + Opensearch collects documents before sorting. + Use with caution. + Opensearch applies this parameter to each shard handling the request. + When possible, let Opensearch perform early termination automatically. + Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + schema: + type: number + style: form + update_by_query::query.timeout: + in: query + name: timeout + description: 'Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards.' + schema: + $ref: '#/components/schemas/_common:Duration' + style: form + update_by_query::query.version: + in: query + name: version + description: If `true`, returns the document version as part of a hit. + schema: + type: boolean + style: form + update_by_query::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '#/components/schemas/_common:WaitForActiveShards' + style: form + update_by_query::query.wait_for_completion: + in: query + name: wait_for_completion + description: If `true`, the request blocks until the operation is complete. + schema: + type: boolean + style: form + update_by_query_rethrottle::path.task_id: + in: path + name: task_id + description: The ID for the task. + required: true + schema: + $ref: '#/components/schemas/_common:Id' + style: simple + update_by_query_rethrottle::query.requests_per_second: + in: query + name: requests_per_second + description: The throttle for this request in sub-requests per second. + schema: + type: number + style: form + requestBodies: + bulk: + content: + application/json: + schema: + type: array + items: + oneOf: + - $ref: '#/components/schemas/_core.bulk:OperationContainer' + - $ref: '#/components/schemas/_core.bulk:UpdateAction' + - type: object + description: The operation definition and data (action-data pairs), separated by newlines + x-serialize: bulk + required: true + cat.pit_segments: + content: + application/json: + schema: + type: object + properties: + pit_id: + type: array + items: + type: string + required: + - pit_id + clear_scroll: + content: + application/json: + schema: + type: object + properties: + scroll_id: + $ref: '#/components/schemas/_common:ScrollIds' + description: Comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter + cluster.allocation_explain: + content: + application/json: + schema: + type: object + properties: + current_node: + description: Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. + type: string + index: + $ref: '#/components/schemas/_common:IndexName' + primary: + description: If true, returns explanation for the primary shard for the given shard ID. + type: boolean + shard: + description: Specifies the ID of the shard that you would like an explanation for. + type: number + description: The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard' + cluster.put_component_template: + content: + application/json: + schema: + type: object + properties: + allow_auto_create: + description: |- + This setting overrides the value of the `action.auto_create_index` cluster setting. + If set to `true` in a template, then indices can be automatically created using that + template even if auto-creation of indices is disabled via `actions.auto_create_index`. + If set to `false` then data streams matching the template must always be explicitly created. + type: boolean + template: + $ref: '#/components/schemas/indices._common:IndexState' + version: + $ref: '#/components/schemas/_common:VersionNumber' + _meta: + $ref: '#/components/schemas/_common:Metadata' + required: + - template + description: The template definition + required: true + cluster.put_settings: + content: + application/json: + schema: + type: object + properties: + persistent: + type: object + additionalProperties: + type: object + transient: + type: object + additionalProperties: + type: object + description: The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). + required: true + cluster.reroute: + content: + application/json: + schema: + type: object + properties: + commands: + description: Defines the commands to perform. + type: array + items: + $ref: '#/components/schemas/cluster.reroute:Command' + description: The definition of `commands` to perform (`move`, `cancel`, `allocate`) + count: + content: + application/json: + schema: + type: object + properties: + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + description: Query to restrict the results specified with the Query DSL (optional) + create: + content: + application/json: + schema: + type: object + description: The document + required: true + delete_by_query: + content: + application/json: + schema: + type: object + properties: + max_docs: + description: The maximum number of documents to delete. + type: number + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + slice: + $ref: '#/components/schemas/_common:SlicedScroll' + description: The search definition using the Query DSL + required: true + delete_pit: + content: + application/json: + schema: + type: object + description: The point-in-time ids to be deleted + properties: + pit_id: + type: array + items: + type: string + required: + - pit_id + explain: + content: + application/json: + schema: + type: object + properties: + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + description: The query definition using the Query DSL + field_caps: + content: + application/json: + schema: + type: object + properties: + fields: + $ref: '#/components/schemas/_common:Fields' + index_filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + runtime_mappings: + $ref: '#/components/schemas/_common.mapping:RuntimeFields' + description: An index filter specified with the Query DSL + index: + content: + application/json: + schema: + type: object + description: The document + required: true + indices.analyze: + content: + application/json: + schema: + type: object + properties: + analyzer: + description: |- + The name of the analyzer that should be applied to the provided `text`. + This could be a built-in analyzer, or an analyzer that’s been configured in the index. + type: string + attributes: + description: Array of token attributes used to filter the output of the `explain` parameter. + type: array + items: + type: string + char_filter: + description: Array of character filters used to preprocess characters before the tokenizer. + type: array + items: + $ref: '#/components/schemas/_common.analysis:CharFilter' + explain: + description: If `true`, the response includes token attributes and additional details. + type: boolean + field: + $ref: '#/components/schemas/_common:Field' + filter: + description: Array of token filters used to apply after the tokenizer. + type: array + items: + $ref: '#/components/schemas/_common.analysis:TokenFilter' + normalizer: + description: Normalizer to use to convert text into a single token. + type: string + text: + $ref: '#/components/schemas/indices.analyze:TextToAnalyze' + tokenizer: + $ref: '#/components/schemas/_common.analysis:Tokenizer' + description: Define analyzer/tokenizer parameters and the text on which the analysis should be performed + indices.clone: + content: + application/json: + schema: + type: object + properties: + aliases: + description: Aliases for the resulting index. + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:Alias' + settings: + description: Configuration options for the target index. + type: object + additionalProperties: + type: object + description: The configuration for the target index (`settings` and `aliases`) + indices.create: + content: + application/json: + schema: + type: object + properties: + aliases: + description: Aliases for the index. + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:Alias' + mappings: + $ref: '#/components/schemas/_common.mapping:TypeMapping' + settings: + $ref: '#/components/schemas/indices._common:IndexSettings' + description: The configuration for the index (`settings` and `mappings`) + indices.create_data_stream: + content: + application/json: + schema: + type: object + description: The data stream definition + indices.put_alias: + content: + application/json: + schema: + type: object + properties: + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + index_routing: + $ref: '#/components/schemas/_common:Routing' + is_write_index: + description: |- + If `true`, sets the write index or data stream for the alias. + If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests. + If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index. + Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + type: boolean + routing: + $ref: '#/components/schemas/_common:Routing' + search_routing: + $ref: '#/components/schemas/_common:Routing' + description: The settings for the alias, such as `routing` or `filter` + indices.put_index_template: + content: + application/json: + schema: + type: object + properties: + index_patterns: + $ref: '#/components/schemas/_common:Indices' + composed_of: + description: |- + An ordered list of component template names. + Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + type: array + items: + $ref: '#/components/schemas/_common:Name' + template: + $ref: '#/components/schemas/indices.put_index_template:IndexTemplateMapping' + data_stream: + $ref: '#/components/schemas/indices._common:DataStreamVisibility' + priority: + description: |- + Priority to determine index template precedence when a new data stream or index is created. + The index template with the highest priority is chosen. + If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + This number is not automatically generated by Opensearch. + type: number + version: + $ref: '#/components/schemas/_common:VersionNumber' + _meta: + $ref: '#/components/schemas/_common:Metadata' + description: The template definition + required: true + indices.put_mapping: + content: + application/json: + schema: + type: object + properties: + date_detection: + description: Controls whether dynamic date detection is enabled. + type: boolean + dynamic: + $ref: '#/components/schemas/_common.mapping:DynamicMapping' + dynamic_date_formats: + description: |- + 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. + type: array + items: + type: string + dynamic_templates: + description: Specify dynamic templates for the mapping. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:DynamicTemplate' + - type: array + items: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:DynamicTemplate' + _field_names: + $ref: '#/components/schemas/_common.mapping:FieldNamesField' + _meta: + $ref: '#/components/schemas/_common:Metadata' + numeric_detection: + description: Automatically map strings into numeric data types for all fields. + type: boolean + properties: + description: |- + Mapping for a field. For new fields, this mapping can include: + + - Field name + - Field data type + - Mapping parameters + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:Property' + _routing: + $ref: '#/components/schemas/_common.mapping:RoutingField' + _source: + $ref: '#/components/schemas/_common.mapping:SourceField' + runtime: + $ref: '#/components/schemas/_common.mapping:RuntimeFields' + description: The mapping definition + required: true + indices.put_settings: + content: + application/json: + schema: + $ref: '#/components/schemas/indices._common:IndexSettings' + required: true + indices.put_template: + content: + application/json: + schema: + type: object + properties: + aliases: + description: Aliases for the index. + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:Alias' + index_patterns: + description: |- + Array of wildcard expressions used to match the names + of indices during creation. + oneOf: + - type: string + - type: array + items: + type: string + mappings: + $ref: '#/components/schemas/_common.mapping:TypeMapping' + order: + description: |- + Order in which Opensearch 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. + type: number + settings: + description: Configuration options for the index. + type: object + additionalProperties: + type: object + version: + $ref: '#/components/schemas/_common:VersionNumber' + description: The template definition + required: true + indices.rollover: + content: + application/json: + schema: + type: object + properties: + aliases: + description: |- + Aliases for the target index. + Data streams do not support this parameter. + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:Alias' + conditions: + $ref: '#/components/schemas/indices.rollover:RolloverConditions' + mappings: + $ref: '#/components/schemas/_common.mapping:TypeMapping' + settings: + description: |- + Configuration options for the index. + Data streams do not support this parameter. + type: object + additionalProperties: + type: object + description: The conditions that needs to be met for executing rollover + indices.shrink: + content: + application/json: + schema: + type: object + properties: + aliases: + description: |- + The key is the alias name. + Index alias names support date math. + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:Alias' + settings: + description: Configuration options for the target index. + type: object + additionalProperties: + type: object + description: The configuration for the target index (`settings` and `aliases`) + indices.simulate_index_template: + content: + application/json: + schema: + type: object + properties: + allow_auto_create: + description: |- + This setting overrides the value of the `action.auto_create_index` cluster setting. + If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`. + If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + type: boolean + index_patterns: + $ref: '#/components/schemas/_common:Indices' + composed_of: + description: |- + An ordered list of component template names. + Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + type: array + items: + $ref: '#/components/schemas/_common:Name' + template: + $ref: '#/components/schemas/indices.put_index_template:IndexTemplateMapping' + data_stream: + $ref: '#/components/schemas/indices._common:DataStreamVisibility' + priority: + description: |- + Priority to determine index template precedence when a new data stream or index is created. + The index template with the highest priority is chosen. + If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + This number is not automatically generated by Opensearch. + type: number + version: + $ref: '#/components/schemas/_common:VersionNumber' + _meta: + $ref: '#/components/schemas/_common:Metadata' + description: New index template definition, which will be included in the simulation, as if it already exists in the system + indices.simulate_template: + content: + application/json: + schema: + $ref: '#/components/schemas/indices._common:IndexTemplate' + indices.split: + content: + application/json: + schema: + type: object + properties: + aliases: + description: Aliases for the resulting index. + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:Alias' + settings: + description: Configuration options for the target index. + type: object + additionalProperties: + type: object + description: The configuration for the target index (`settings` and `aliases`) + indices.update_aliases: + content: + application/json: + schema: + type: object + properties: + actions: + description: Actions to perform. + type: array + items: + $ref: '#/components/schemas/indices.update_aliases:Action' + description: The definition of `actions` to perform + required: true + indices.validate_query: + content: + application/json: + schema: + type: object + properties: + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + description: The query definition specified with the Query DSL + ingest.put_pipeline: + content: + application/json: + schema: + type: object + properties: + _meta: + $ref: '#/components/schemas/_common:Metadata' + description: + description: Description of the ingest pipeline. + type: string + on_failure: + description: Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Opensearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Opensearch will not attempt to run the pipeline's remaining processors. + type: array + items: + $ref: '#/components/schemas/ingest._common:ProcessorContainer' + processors: + description: Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. + type: array + items: + $ref: '#/components/schemas/ingest._common:ProcessorContainer' + version: + $ref: '#/components/schemas/_common:VersionNumber' + description: The ingest definition + required: true + ingest.simulate: + content: + application/json: + schema: + type: object + properties: + docs: + description: Sample documents to test in the pipeline. + type: array + items: + $ref: '#/components/schemas/ingest.simulate:Document' + pipeline: + $ref: '#/components/schemas/ingest._common:Pipeline' + description: The simulate definition + required: true + knn.search_models: + content: + application/json: + schema: + type: object + knn.train_model: + content: + application/json: + schema: + type: object + properties: + training_index: + type: string + training_field: + type: string + dimension: + type: integer + format: int32 + max_training_vector_count: + type: integer + format: int32 + search_size: + type: integer + format: int32 + description: + type: string + method: + type: string + required: + - dimension + - method + - training_field + - training_index + required: true + mget: + content: + application/json: + schema: + type: object + properties: + docs: + description: The documents you want to retrieve. Required if no index is specified in the request URI. + type: array + items: + $ref: '#/components/schemas/_core.mget:Operation' + ids: + $ref: '#/components/schemas/_common:Ids' + description: Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL. + required: true + msearch: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/_core.msearch:RequestItem' + description: The request definitions (metadata-search request definition pairs), separated by newlines + x-serialize: bulk + required: true + msearch_template: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/_core.msearch_template:RequestItem' + description: The request definitions (metadata-search request definition pairs), separated by newlines + x-serialize: bulk + required: true + mtermvectors: + content: + application/json: + schema: + type: object + properties: + docs: + description: Array of existing or artificial documents. + type: array + items: + $ref: '#/components/schemas/_core.mtermvectors:Operation' + ids: + description: Simplified syntax to specify documents by their ID if they're in the same index. + type: array + items: + $ref: '#/components/schemas/_common:Id' + description: Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation. + nodes.reload_secure_settings: + content: + application/json: + schema: + type: object + properties: + secure_settings_password: + $ref: '#/components/schemas/_common:Password' + description: An object containing the password for the opensearch keystore + notifications.create_config: + content: + application/json: + schema: + $ref: '#/components/schemas/notifications._common:NotificationsConfig' + required: true + notifications.get_config: + content: + application/json: + schema: + $ref: '#/components/schemas/notifications._common:NotificationsConfigs_GetRequestContent' + notifications.update_config: + content: + application/json: + schema: + $ref: '#/components/schemas/notifications._common:NotificationsConfig' + required: true + put_script: + content: + application/json: + schema: + type: object + properties: + script: + $ref: '#/components/schemas/_common:StoredScript' + required: + - script + description: The document + required: true + rank_eval: + content: + application/json: + schema: + type: object + properties: + requests: + description: A set of typical search requests, together with their provided ratings. + type: array + items: + $ref: '#/components/schemas/_core.rank_eval:RankEvalRequestItem' + metric: + $ref: '#/components/schemas/_core.rank_eval:RankEvalMetric' + required: + - requests + description: The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. + required: true + reindex: + content: + application/json: + schema: + type: object + properties: + conflicts: + $ref: '#/components/schemas/_common:Conflicts' + dest: + $ref: '#/components/schemas/_core.reindex:Destination' + max_docs: + description: The maximum number of documents to reindex. + type: number + script: + $ref: '#/components/schemas/_common:Script' + size: + type: number + source: + $ref: '#/components/schemas/_core.reindex:Source' + required: + - dest + - source + description: The search definition using the Query DSL and the prototype for the index request. + required: true + remote_store.restore: + content: + application/json: + schema: + type: object + description: Comma-separated list of index IDs + properties: + indices: + type: array + items: + type: string + required: + - indices + examples: + RemoteStoreRestore_example1: + summary: Examples for Post Remote Storage Restore Operation. + description: '' + value: + indices: + - books + required: true + render_search_template: + content: + application/json: + schema: + type: object + properties: + file: + type: string + params: + description: |- + Key-value pairs used to replace Mustache variables in the template. + The key is the variable name. + The value is the variable value. + type: object + additionalProperties: + type: object + source: + description: |- + An inline search template. + Supports the same parameters as the search API's request body. + These parameters also support Mustache variables. + If no `id` or `` is specified, this parameter is required. + type: string + description: The search definition template and its params + scripts_painless_execute: + content: + application/json: + schema: + type: object + properties: + context: + description: The context that the script should run in. + type: string + context_setup: + $ref: '#/components/schemas/_core.scripts_painless_execute:PainlessContextSetup' + script: + $ref: '#/components/schemas/_common:InlineScript' + description: The script to execute + scroll: + content: + application/json: + schema: + type: object + properties: + scroll: + $ref: '#/components/schemas/_common:Duration' + scroll_id: + $ref: '#/components/schemas/_common:ScrollId' + required: + - scroll_id + description: The scroll ID if not passed by URL or query parameter. + search: + content: + application/json: + schema: + type: object + properties: + aggregations: + description: Defines the aggregations that are run as part of the search request. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:AggregationContainer' + collapse: + $ref: '#/components/schemas/_core.search:FieldCollapse' + explain: + description: If true, returns detailed information about score computation as part of a hit. + type: boolean + ext: + description: Configuration of search extensions defined by Opensearch plugins. + type: object + additionalProperties: + type: object + from: + description: |- + Starting document offset. + Needs to be non-negative. + 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. + type: number + highlight: + $ref: '#/components/schemas/_core.search:Highlight' + track_total_hits: + $ref: '#/components/schemas/_core.search:TrackHits' + indices_boost: + description: Boosts the _score of documents from specified indices. + type: array + items: + type: object + additionalProperties: + type: number + docvalue_fields: + description: |- + Array of wildcard (`*`) patterns. + The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. + type: array + items: + $ref: '#/components/schemas/_common.query_dsl:FieldAndFormat' + knn: + description: Defines the approximate kNN search to run. + oneOf: + - $ref: '#/components/schemas/_common:KnnQuery' + - type: array + items: + $ref: '#/components/schemas/_common:KnnQuery' + rank: + $ref: '#/components/schemas/_common:RankContainer' + min_score: + description: |- + Minimum `_score` for matching documents. + Documents with a lower `_score` are not included in the search results. + type: number + post_filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + profile: + description: |- + Set to `true` to return detailed timing information about the execution of individual components in a search request. + NOTE: This is a debugging tool and adds significant overhead to search execution. + type: boolean + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + rescore: + description: Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases. + oneOf: + - $ref: '#/components/schemas/_core.search:Rescore' + - type: array + items: + $ref: '#/components/schemas/_core.search:Rescore' + script_fields: + description: Retrieve a script evaluation (based on different fields) for each hit. + type: object + additionalProperties: + $ref: '#/components/schemas/_common:ScriptField' + search_after: + $ref: '#/components/schemas/_common:SortResults' + size: + description: |- + 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. + type: number + slice: + $ref: '#/components/schemas/_common:SlicedScroll' + sort: + $ref: '#/components/schemas/_common:Sort' + _source: + $ref: '#/components/schemas/_core.search:SourceConfig' + fields: + description: |- + Array of wildcard (`*`) patterns. + The request returns values for field names matching these patterns in the `hits.fields` property of the response. + type: array + items: + $ref: '#/components/schemas/_common.query_dsl:FieldAndFormat' + suggest: + $ref: '#/components/schemas/_core.search:Suggester' + terminate_after: + description: |- + Maximum number of documents to collect for each shard. + If a query reaches this limit, Opensearch terminates the query early. + Opensearch collects documents before sorting. + Use with caution. + Opensearch applies this parameter to each shard handling the request. + When possible, let Opensearch perform early termination automatically. + Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + If set to `0` (default), the query does not terminate early. + type: number + timeout: + description: |- + 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. + type: string + track_scores: + description: If true, calculate and return document scores, even if the scores are not used for sorting. + type: boolean + version: + description: If true, returns document version as part of a hit. + type: boolean + seq_no_primary_term: + description: If `true`, returns sequence number and primary term of the last modification of each hit. + type: boolean + stored_fields: + $ref: '#/components/schemas/_common:Fields' + pit: + $ref: '#/components/schemas/_core.search:PointInTimeReference' + runtime_mappings: + $ref: '#/components/schemas/_common.mapping:RuntimeFields' + stats: + description: |- + 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. + type: array + items: + type: string + description: The search definition using the Query DSL + search_pipeline.create: + content: + application/json: + schema: + $ref: '#/components/schemas/search_pipeline._common:SearchPipelineStructure' + required: true + search_template: + content: + application/json: + schema: + type: object + properties: + explain: + description: If `true`, returns detailed information about score calculation as part of each hit. + type: boolean + id: + $ref: '#/components/schemas/_common:Id' + params: + description: |- + Key-value pairs used to replace Mustache variables in the template. + The key is the variable name. + The value is the variable value. + type: object + additionalProperties: + type: object + profile: + description: If `true`, the query execution is profiled. + type: boolean + source: + description: |- + 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. + type: string + description: The search definition template and its params + required: true + security.change_password: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:ChangePasswordRequestContent' + required: true + security.create_action_group: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Action_Group' + required: true + security.create_role: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:Role' + required: true + security.create_role_mapping: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:RoleMapping' + required: true + security.create_tenant: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:CreateTenantParams' + required: true + security.create_user: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:User' + required: true + security.patch_action_group: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/security._common:PatchOperation' + required: true + security.patch_action_groups: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/security._common:PatchOperation' + required: true + security.patch_audit_configuration: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/security._common:PatchOperation' + required: true + security.patch_configuration: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/security._common:PatchOperation' + required: true + security.patch_distinguished_names: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/security._common:PatchOperation' + required: true + security.patch_role: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/security._common:PatchOperation' + required: true + security.patch_role_mapping: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/security._common:PatchOperation' + required: true + security.patch_role_mappings: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/security._common:PatchOperation' + required: true + security.patch_roles: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/security._common:PatchOperation' + required: true + security.patch_tenant: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/security._common:PatchOperation' + required: true + security.patch_tenants: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/security._common:PatchOperation' + required: true + security.patch_user: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/security._common:PatchOperation' + required: true + security.patch_users: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/security._common:PatchOperation' + required: true + security.update_audit_configuration: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:AuditConfig' + required: true + security.update_configuration: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:DynamicConfig' + required: true + security.update_distinguished_names: + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:DistinguishedNames' + snapshot.clone: + content: + application/json: + schema: + type: object + properties: + indices: + type: string + required: + - indices + description: The snapshot clone definition + required: true + snapshot.create: + content: + application/json: + schema: + type: object + properties: + ignore_unavailable: + 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. + type: boolean + include_global_state: + 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`). + type: boolean + indices: + $ref: '#/components/schemas/_common:Indices' + feature_states: + 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. + type: array + items: + type: string + metadata: + $ref: '#/components/schemas/_common:Metadata' + partial: + 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. + type: boolean + description: The snapshot definition + snapshot.create_repository: + content: + application/json: + schema: + type: object + properties: + repository: + $ref: '#/components/schemas/snapshot._common:Repository' + type: + type: string + settings: + $ref: '#/components/schemas/snapshot._common:RepositorySettings' + required: + - type + - settings + description: The repository definition + required: true + snapshot.restore: + content: + application/json: + schema: + type: object + properties: + feature_states: + type: array + items: + type: string + ignore_index_settings: + type: array + items: + type: string + ignore_unavailable: + type: boolean + include_aliases: + type: boolean + include_global_state: + type: boolean + index_settings: + $ref: '#/components/schemas/indices._common:IndexSettings' + indices: + $ref: '#/components/schemas/_common:Indices' + partial: + type: boolean + rename_pattern: + type: string + rename_replacement: + type: string + description: Details of what to restore + termvectors: + content: + application/json: + schema: + type: object + properties: + doc: + description: An artificial document (a document not present in the index) for which you want to retrieve term vectors. + type: object + filter: + $ref: '#/components/schemas/_core.termvectors:Filter' + per_field_analyzer: + description: Overrides the default per-field analyzer. + type: object + additionalProperties: + type: string + description: Define parameters and or supply a document to get termvectors for. See documentation. + update: + content: + application/json: + schema: + type: object + properties: + detect_noop: + description: |- + Set to false to disable setting 'result' in the response + to 'noop' if no change to the document occurred. + type: boolean + doc: + description: A partial update to an existing document. + type: object + doc_as_upsert: + description: Set to true to use the contents of 'doc' as the value of 'upsert' + type: boolean + script: + $ref: '#/components/schemas/_common:Script' + scripted_upsert: + description: Set to true to execute the script whether or not the document exists. + type: boolean + _source: + $ref: '#/components/schemas/_core.search:SourceConfig' + upsert: + description: |- + 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. + type: object + description: The request definition requires either `script` or partial `doc` + required: true + update_by_query: + content: + application/json: + schema: + type: object + properties: + max_docs: + description: The maximum number of documents to update. + type: number + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + script: + $ref: '#/components/schemas/_common:Script' + slice: + $ref: '#/components/schemas/_common:SlicedScroll' + conflicts: + $ref: '#/components/schemas/_common:Conflicts' + description: The search definition using the Query DSL + responses: + bulk@200: + description: '' + content: + application/json: + schema: + type: object + properties: + errors: + type: boolean + items: + type: array + items: + type: object + additionalProperties: + $ref: '#/components/schemas/_core.bulk:ResponseItem' + minProperties: 1 + maxProperties: 1 + took: + type: number + ingest_took: + type: number + required: + - errors + - items + - took + cat.aliases@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.aliases:AliasesRecord' + cat.all_pit_segments@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat._common:CatPitSegmentsRecord' + cat.allocation@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.allocation:AllocationRecord' + cat.cluster_manager@200: + description: '' + cat.count@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.count:CountRecord' + cat.fielddata@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.fielddata:FielddataRecord' + cat.health@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.health:HealthRecord' + cat.help@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.help:HelpRecord' + cat.indices@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.indices:IndicesRecord' + cat.master@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.master:MasterRecord' + cat.nodeattrs@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.nodeattrs:NodeAttributesRecord' + cat.nodes@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.nodes:NodesRecord' + cat.pending_tasks@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.pending_tasks:PendingTasksRecord' + cat.pit_segments@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat._common:CatPitSegmentsRecord' + cat.plugins@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.plugins:PluginsRecord' + cat.recovery@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.recovery:RecoveryRecord' + cat.repositories@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.repositories:RepositoriesRecord' + cat.segment_replication@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat._common:CatSegmentReplicationRecord' + cat.segments@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.segments:SegmentsRecord' + cat.shards@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.shards:ShardsRecord' + cat.snapshots@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.snapshots:SnapshotsRecord' + cat.tasks@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.tasks:TasksRecord' + cat.templates@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.templates:TemplatesRecord' + cat.thread_pool@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/cat.thread_pool:ThreadPoolRecord' + clear_scroll@200: + description: '' + content: + application/json: + schema: + type: object + properties: + succeeded: + type: boolean + num_freed: + type: number + required: + - succeeded + - num_freed + cluster.allocation_explain@200: + description: '' + content: + application/json: + schema: + type: object + properties: + allocate_explanation: + type: string + allocation_delay: + $ref: '#/components/schemas/_common:Duration' + allocation_delay_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + can_allocate: + $ref: '#/components/schemas/cluster.allocation_explain:Decision' + can_move_to_other_node: + $ref: '#/components/schemas/cluster.allocation_explain:Decision' + can_rebalance_cluster: + $ref: '#/components/schemas/cluster.allocation_explain:Decision' + can_rebalance_cluster_decisions: + type: array + items: + $ref: '#/components/schemas/cluster.allocation_explain:AllocationDecision' + can_rebalance_to_other_node: + $ref: '#/components/schemas/cluster.allocation_explain:Decision' + can_remain_decisions: + type: array + items: + $ref: '#/components/schemas/cluster.allocation_explain:AllocationDecision' + can_remain_on_current_node: + $ref: '#/components/schemas/cluster.allocation_explain:Decision' + cluster_info: + $ref: '#/components/schemas/cluster.allocation_explain:ClusterInfo' + configured_delay: + $ref: '#/components/schemas/_common:Duration' + configured_delay_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + current_node: + $ref: '#/components/schemas/cluster.allocation_explain:CurrentNode' + current_state: + type: string + index: + $ref: '#/components/schemas/_common:IndexName' + move_explanation: + type: string + node_allocation_decisions: + type: array + items: + $ref: '#/components/schemas/cluster.allocation_explain:NodeAllocationExplanation' + primary: + type: boolean + rebalance_explanation: + type: string + remaining_delay: + $ref: '#/components/schemas/_common:Duration' + remaining_delay_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + shard: + type: number + unassigned_info: + $ref: '#/components/schemas/cluster.allocation_explain:UnassignedInformation' + note: + type: string + required: + - current_state + - index + - primary + - shard + cluster.delete_component_template@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + cluster.delete_decommission_awareness@200: + description: '' + cluster.delete_voting_config_exclusions@200: + description: '' + content: + application/json: {} + cluster.delete_weighted_routing@200: + description: '' + cluster.exists_component_template@200: + description: '' + content: + application/json: {} + cluster.get_component_template@200: + description: '' + content: + application/json: + schema: + type: object + properties: + component_templates: + type: array + items: + $ref: '#/components/schemas/cluster._common:ComponentTemplate' + required: + - component_templates + cluster.get_decommission_awareness@200: + description: '' + cluster.get_settings@200: + description: '' + content: + application/json: + schema: + type: object + properties: + persistent: + type: object + additionalProperties: + type: object + transient: + type: object + additionalProperties: + type: object + defaults: + type: object + additionalProperties: + type: object + required: + - persistent + - transient + cluster.get_weighted_routing@200: + description: '' + cluster.health@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/cluster.health:HealthResponseBody' + cluster.pending_tasks@200: + description: '' + content: + application/json: + schema: + type: object + properties: + tasks: + type: array + items: + $ref: '#/components/schemas/cluster.pending_tasks:PendingTask' + required: + - tasks + cluster.post_voting_config_exclusions@200: + description: '' + content: + application/json: {} + cluster.put_component_template@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + cluster.put_decommission_awareness@200: + description: '' + cluster.put_settings@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + persistent: + type: object + additionalProperties: + type: object + transient: + type: object + additionalProperties: + type: object + required: + - acknowledged + - persistent + - transient + cluster.put_weighted_routing@200: + description: '' + cluster.remote_info@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/cluster.remote_info:ClusterRemoteInfo' + cluster.reroute@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + explanations: + type: array + items: + $ref: '#/components/schemas/cluster.reroute:RerouteExplanation' + state: + description: |- + 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. + type: object + required: + - acknowledged + cluster.state@200: + description: '' + content: + application/json: + schema: + type: object + cluster.stats@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/cluster.stats:StatsResponseBase' + count@200: + description: '' + content: + application/json: + schema: + type: object + properties: + count: + type: number + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + required: + - count + - _shards + create@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:WriteResponseBase' + create_pit@200: + description: '' + content: + application/json: + schema: + type: object + properties: + pit_id: + type: string + _shards: + $ref: '#/components/schemas/_core._common:ShardStatistics' + creation_time: + type: integer + format: int64 + dangling_indices.delete_dangling_index@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + dangling_indices.import_dangling_index@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + dangling_indices.list_dangling_indices@200: + description: '' + content: + application/json: + schema: + type: object + properties: + dangling_indices: + type: array + items: + $ref: '#/components/schemas/dangling_indices.list_dangling_indices:DanglingIndex' + required: + - dangling_indices + delete@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:WriteResponseBase' + delete_all_pits@200: + description: '' + content: + application/json: + schema: + type: object + properties: + pits: + type: array + items: + $ref: '#/components/schemas/_core._common:PitsDetailsDeleteAll' + delete_by_query@200: + description: '' + content: + application/json: + schema: + type: object + properties: + batches: + type: number + deleted: + type: number + failures: + type: array + items: + $ref: '#/components/schemas/_common:BulkIndexByScrollFailure' + noops: + type: number + requests_per_second: + type: number + retries: + $ref: '#/components/schemas/_common:Retries' + slice_id: + type: number + task: + $ref: '#/components/schemas/_common:TaskId' + throttled: + $ref: '#/components/schemas/_common:Duration' + throttled_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + throttled_until: + $ref: '#/components/schemas/_common:Duration' + throttled_until_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + timed_out: + type: boolean + took: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total: + type: number + version_conflicts: + type: number + delete_by_query_rethrottle@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/tasks._common:TaskListResponseBase' + delete_pit@200: + description: '' + content: + application/json: + schema: + type: object + properties: + pits: + type: array + items: + $ref: '#/components/schemas/_core._common:DeletedPit' + delete_script@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + exists@200: + description: '' + content: + application/json: {} + exists_source@200: + description: '' + content: + application/json: {} + explain@200: + description: '' + content: + application/json: + schema: + type: object + properties: + _index: + $ref: '#/components/schemas/_common:IndexName' + _id: + $ref: '#/components/schemas/_common:Id' + matched: + type: boolean + explanation: + $ref: '#/components/schemas/_core.explain:ExplanationDetail' + get: + $ref: '#/components/schemas/_common:InlineGet' + required: + - _index + - _id + - matched + field_caps@200: + description: '' + content: + application/json: + schema: + type: object + properties: + indices: + $ref: '#/components/schemas/_common:Indices' + fields: + type: object + additionalProperties: + type: object + additionalProperties: + $ref: '#/components/schemas/_core.field_caps:FieldCapability' + required: + - indices + - fields + get@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_core.get:GetResult' + get_all_pits@200: + description: '' + content: + application/json: + schema: + type: object + properties: + pits: + type: array + items: + $ref: '#/components/schemas/_core._common:PitDetail' + get_script@200: + description: '' + content: + application/json: + schema: + type: object + properties: + _id: + $ref: '#/components/schemas/_common:Id' + found: + type: boolean + script: + $ref: '#/components/schemas/_common:StoredScript' + required: + - _id + - found + get_script_context@200: + description: '' + content: + application/json: + schema: + type: object + properties: + contexts: + type: array + items: + $ref: '#/components/schemas/_core.get_script_context:Context' + required: + - contexts + get_script_languages@200: + description: '' + content: + application/json: + schema: + type: object + properties: + language_contexts: + type: array + items: + $ref: '#/components/schemas/_core.get_script_languages:LanguageContext' + types_allowed: + type: array + items: + type: string + required: + - language_contexts + - types_allowed + get_source@200: + description: '' + content: + application/json: + schema: + type: object + index@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:WriteResponseBase' + indices.add_block@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + shards_acknowledged: + type: boolean + indices: + type: array + items: + $ref: '#/components/schemas/indices.add_block:IndicesBlockStatus' + required: + - acknowledged + - shards_acknowledged + - indices + indices.analyze@200: + description: '' + content: + application/json: + schema: + type: object + properties: + detail: + $ref: '#/components/schemas/indices.analyze:AnalyzeDetail' + tokens: + type: array + items: + $ref: '#/components/schemas/indices.analyze:AnalyzeToken' + indices.clear_cache@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:ShardsOperationResponseBase' + indices.clone@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + index: + $ref: '#/components/schemas/_common:IndexName' + shards_acknowledged: + type: boolean + required: + - acknowledged + - index + - shards_acknowledged + indices.close@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + indices: + type: object + additionalProperties: + $ref: '#/components/schemas/indices.close:CloseIndexResult' + shards_acknowledged: + type: boolean + required: + - acknowledged + - indices + - shards_acknowledged + indices.create@200: + description: '' + content: + application/json: + schema: + type: object + properties: + index: + $ref: '#/components/schemas/_common:IndexName' + shards_acknowledged: + type: boolean + acknowledged: + type: boolean + required: + - index + - shards_acknowledged + - acknowledged + indices.create_data_stream@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + indices.data_streams_stats@200: + description: '' + content: + application/json: + schema: + type: object + properties: + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + backing_indices: + description: Total number of backing indices for the selected data streams. + type: number + data_stream_count: + description: Total number of selected data streams. + type: number + data_streams: + description: Contains statistics for the selected data streams. + type: array + items: + $ref: '#/components/schemas/indices.data_streams_stats:DataStreamsStatsItem' + total_store_sizes: + $ref: '#/components/schemas/_common:ByteSize' + total_store_size_bytes: + description: Total size, in bytes, of all shards for the selected data streams. + type: number + required: + - _shards + - backing_indices + - data_stream_count + - data_streams + - total_store_size_bytes + indices.delete@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:IndicesResponseBase' + indices.delete_alias@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + indices.delete_data_stream@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + indices.delete_index_template@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + indices.delete_template@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + indices.exists@200: + description: '' + content: + application/json: {} + indices.exists_alias@200: + description: '' + content: + application/json: {} + indices.exists_index_template@200: + description: '' + content: + application/json: {} + indices.exists_template@200: + description: '' + content: + application/json: {} + indices.flush@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:ShardsOperationResponseBase' + indices.forcemerge@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/indices.forcemerge._types:ForceMergeResponseBody' + indices.get@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:IndexState' + indices.get_alias@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/indices.get_alias:IndexAliases' + indices.get_data_stream@200: + description: '' + content: + application/json: + schema: + type: object + properties: + data_streams: + type: array + items: + $ref: '#/components/schemas/indices._common:DataStream' + required: + - data_streams + indices.get_field_mapping@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/indices.get_field_mapping:TypeFieldMappings' + indices.get_index_template@200: + description: '' + content: + application/json: + schema: + type: object + properties: + index_templates: + type: array + items: + $ref: '#/components/schemas/indices.get_index_template:IndexTemplateItem' + required: + - index_templates + indices.get_mapping@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/indices.get_mapping:IndexMappingRecord' + indices.get_settings@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:IndexState' + indices.get_template@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:TemplateMapping' + indices.get_upgrade@200: + description: '' + indices.open@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + shards_acknowledged: + type: boolean + required: + - acknowledged + - shards_acknowledged + indices.put_alias@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + indices.put_index_template@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + indices.put_mapping@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:IndicesResponseBase' + indices.put_settings@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + indices.put_template@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + indices.recovery@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/indices.recovery:RecoveryStatus' + indices.refresh@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:ShardsOperationResponseBase' + indices.resolve_index@200: + description: '' + content: + application/json: + schema: + type: object + properties: + indices: + type: array + items: + $ref: '#/components/schemas/indices.resolve_index:ResolveIndexItem' + aliases: + type: array + items: + $ref: '#/components/schemas/indices.resolve_index:ResolveIndexAliasItem' + data_streams: + type: array + items: + $ref: '#/components/schemas/indices.resolve_index:ResolveIndexDataStreamsItem' + required: + - indices + - aliases + - data_streams + indices.rollover@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + conditions: + type: object + additionalProperties: + type: boolean + dry_run: + type: boolean + new_index: + type: string + old_index: + type: string + rolled_over: + type: boolean + shards_acknowledged: + type: boolean + required: + - acknowledged + - conditions + - dry_run + - new_index + - old_index + - rolled_over + - shards_acknowledged + indices.segments@200: + description: '' + content: + application/json: + schema: + type: object + properties: + indices: + type: object + additionalProperties: + $ref: '#/components/schemas/indices.segments:IndexSegment' + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + required: + - indices + - _shards + indices.shard_stores@200: + description: '' + content: + application/json: + schema: + type: object + properties: + indices: + type: object + additionalProperties: + $ref: '#/components/schemas/indices.shard_stores:IndicesShardStores' + required: + - indices + indices.shrink@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + shards_acknowledged: + type: boolean + index: + $ref: '#/components/schemas/_common:IndexName' + required: + - acknowledged + - shards_acknowledged + - index + indices.simulate_index_template@200: + description: '' + content: + application/json: + schema: + type: object + indices.simulate_template@200: + description: '' + content: + application/json: + schema: + type: object + properties: + overlapping: + type: array + items: + $ref: '#/components/schemas/indices.simulate_template:Overlapping' + template: + $ref: '#/components/schemas/indices.simulate_template:Template' + required: + - template + indices.split@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + shards_acknowledged: + type: boolean + index: + $ref: '#/components/schemas/_common:IndexName' + required: + - acknowledged + - shards_acknowledged + - index + indices.stats@200: + description: '' + content: + application/json: + schema: + type: object + properties: + indices: + type: object + additionalProperties: + $ref: '#/components/schemas/indices.stats:IndicesStats' + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + _all: + $ref: '#/components/schemas/indices.stats:IndicesStats' + required: + - _shards + - _all + indices.update_aliases@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + indices.upgrade@200: + description: '' + indices.validate_query@200: + description: '' + content: + application/json: + schema: + type: object + properties: + explanations: + type: array + items: + $ref: '#/components/schemas/indices.validate_query:IndicesValidationExplanation' + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + valid: + type: boolean + error: + type: string + required: + - valid + info@200: + description: '' + content: + application/json: + schema: + type: object + properties: + cluster_name: + $ref: '#/components/schemas/_common:Name' + cluster_uuid: + $ref: '#/components/schemas/_common:Uuid' + name: + $ref: '#/components/schemas/_common:Name' + tagline: + type: string + version: + $ref: '#/components/schemas/_common:OpensearchVersionInfo' + required: + - cluster_name + - cluster_uuid + - name + - tagline + - version + ingest.delete_pipeline@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + ingest.get_pipeline@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/ingest._common:Pipeline' + ingest.processor_grok@200: + description: '' + content: + application/json: + schema: + type: object + properties: + patterns: + type: object + additionalProperties: + type: string + required: + - patterns + ingest.put_pipeline@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + ingest.simulate@200: + description: '' + content: + application/json: + schema: + type: object + properties: + docs: + type: array + items: + $ref: '#/components/schemas/ingest.simulate:PipelineSimulation' + required: + - docs + knn.delete_model@200: + description: '' + knn.get_model@200: + description: '' + knn.search_models@200: + description: '' + knn.stats@200: + description: '' + knn.train_model@200: + description: '' + knn.warmup@200: + description: '' + mget@200: + description: '' + content: + application/json: + schema: + type: object + properties: + docs: + type: array + items: + $ref: '#/components/schemas/_core.mget:ResponseItem' + required: + - docs + msearch@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_core.msearch:MultiSearchResult' + msearch_template@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_core.msearch:MultiSearchResult' + mtermvectors@200: + description: '' + content: + application/json: + schema: + type: object + properties: + docs: + type: array + items: + $ref: '#/components/schemas/_core.mtermvectors:TermVectorsResult' + required: + - docs + nodes.hot_threads@200: + description: '' + nodes.info@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/nodes.info:ResponseBase' + nodes.reload_secure_settings@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/nodes.reload_secure_settings:ResponseBase' + nodes.stats@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/nodes.stats:ResponseBase' + nodes.usage@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/nodes.usage:ResponseBase' + notifications.create_config@200: + description: '' + content: + application/json: + schema: + type: object + properties: + config_id: + type: string + notifications.delete_config@200: + description: '' + content: + application/json: + schema: + type: object + properties: + delete_response_list: + $ref: '#/components/schemas/notifications._common:DeleteResponseList' + notifications.get_config@200: + description: '' + content: + application/json: + schema: + type: object + properties: + start_index: + type: integer + format: int64 + total_hits: + type: integer + format: int64 + total_hit_relation: + $ref: '#/components/schemas/notifications._common:TotalHitRelation' + config_list: + type: array + items: + $ref: '#/components/schemas/notifications._common:NotificationsConfigsOutputItem' + notifications.list_features@200: + description: '' + content: + application/json: + schema: + type: object + properties: + allowed_config_type_list: + type: array + items: + $ref: '#/components/schemas/notifications._common:NotificationConfigType' + plugin_features: + $ref: '#/components/schemas/notifications._common:NotificationsPluginFeaturesMap' + notifications.send_test@200: + description: '' + content: + application/json: + schema: + type: object + properties: + event_source: + $ref: '#/components/schemas/notifications._common:EventSource' + status_list: + type: array + items: + $ref: '#/components/schemas/notifications._common:EventStatus' + notifications.update_config@200: + description: '' + content: + application/json: + schema: + type: object + properties: + config_id: + type: string + ping@200: + description: '' + content: + application/json: {} + put_script@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + rank_eval@200: + description: '' + content: + application/json: + schema: + type: object + properties: + metric_score: + description: The overall evaluation quality calculated by the defined metric + type: number + details: + description: The details section contains one entry for every query in the original requests section, keyed by the search request id + type: object + additionalProperties: + $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricDetail' + failures: + type: object + additionalProperties: + type: object + required: + - metric_score + - details + - failures + reindex@200: + description: '' + content: + application/json: + schema: + type: object + properties: + batches: + type: number + created: + type: number + deleted: + type: number + failures: + type: array + items: + $ref: '#/components/schemas/_common:BulkIndexByScrollFailure' + noops: + type: number + retries: + $ref: '#/components/schemas/_common:Retries' + requests_per_second: + type: number + slice_id: + type: number + task: + $ref: '#/components/schemas/_common:TaskId' + throttled_millis: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + throttled_until_millis: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + timed_out: + type: boolean + took: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total: + type: number + updated: + type: number + version_conflicts: + type: number + reindex_rethrottle@200: + description: '' + content: + application/json: + schema: + type: object + properties: + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/_core.reindex_rethrottle:ReindexNode' + required: + - nodes + remote_store.restore@200: + description: '' + content: + application/json: + schema: + type: object + properties: + accepted: + type: boolean + remote_store: + $ref: '#/components/schemas/remote_store._common:RemoteStoreRestoreInfo' + examples: + RemoteStoreRestore_example1: + summary: Examples for Post Remote Storage Restore Operation. + description: '' + value: + remote_store: + indices: + - books + shards: + total: 1 + failed: 0 + successful: 1 + render_search_template@200: + description: '' + content: + application/json: + schema: + type: object + properties: + template_output: + type: object + additionalProperties: + type: object + required: + - template_output + scripts_painless_execute@200: + description: '' + content: + application/json: + schema: + type: object + properties: + result: + type: object + required: + - result + scroll@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_core.search:ResponseBody' + search@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_core.search:ResponseBody' + search_pipeline.create@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + search_pipeline.get@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/search_pipeline._common:SearchPipelineMap' + search_shards@200: + description: '' + content: + application/json: + schema: + type: object + properties: + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:NodeAttributes' + shards: + type: array + items: + type: array + items: + $ref: '#/components/schemas/_common:NodeShard' + indices: + type: object + additionalProperties: + $ref: '#/components/schemas/_core.search_shards:ShardStoreIndex' + required: + - nodes + - shards + - indices + search_template@200: + description: '' + content: + application/json: + schema: + type: object + properties: + took: + type: number + timed_out: + type: boolean + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + hits: + $ref: '#/components/schemas/_core.search:HitsMetadata' + aggregations: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:Aggregate' + _clusters: + $ref: '#/components/schemas/_common:ClusterStatistics' + fields: + type: object + additionalProperties: + type: object + max_score: + type: number + num_reduce_phases: + type: number + profile: + $ref: '#/components/schemas/_core.search:Profile' + pit_id: + $ref: '#/components/schemas/_common:Id' + _scroll_id: + $ref: '#/components/schemas/_common:ScrollId' + suggest: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/_core.search:Suggest' + terminated_early: + type: boolean + required: + - took + - timed_out + - _shards + - hits + security.change_password@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.create_action_group@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.create_role@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.create_role_mapping@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.create_tenant@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.create_user@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.delete_action_group@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.delete_distinguished_names@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.delete_role@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.delete_role_mapping@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.delete_tenant@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.delete_user@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.flush_cache@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.get_account_details@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:AccountDetails' + security.get_action_group@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:ActionGroupsMap' + security.get_action_groups@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:ActionGroupsMap' + security.get_audit_configuration@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:AuditConfigWithReadOnly' + security.get_certificates@200: + description: '' + content: + application/json: + schema: + type: object + properties: + http_certificates_list: + type: array + items: + $ref: '#/components/schemas/security._common:CertificatesDetail' + transport_certificates_list: + type: array + items: + $ref: '#/components/schemas/security._common:CertificatesDetail' + security.get_configuration@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:DynamicConfig' + security.get_distinguished_names@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:DistinguishedNamesMap' + security.get_role@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:RolesMap' + security.get_role_mapping@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:RoleMappings' + security.get_role_mappings@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:RoleMappings' + security.get_roles@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:RolesMap' + security.get_tenant@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:TenantsMap' + security.get_tenants@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:TenantsMap' + security.get_user@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:UsersMap' + security.get_users@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/security._common:UsersMap' + security.health@200: + description: '' + content: + application/json: + schema: + type: object + properties: + message: + type: string + mode: + type: string + status: + type: string + security.patch_action_group@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_action_groups@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_audit_configuration@200: + description: '' + security.patch_configuration@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_distinguished_names@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_role@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_role_mapping@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_role_mappings@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_roles@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_tenant@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_tenants@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_user@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_users@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.reload_http_certificates@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.reload_transport_certificates@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.update_audit_configuration@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.update_configuration@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.update_distinguished_names@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + snapshot.cleanup_repository@200: + description: '' + content: + application/json: + schema: + type: object + properties: + results: + $ref: '#/components/schemas/snapshot.cleanup_repository:CleanupRepositoryResults' + required: + - results + snapshot.clone@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + snapshot.create@200: + description: '' + content: + application/json: + schema: + type: object + properties: + accepted: + description: Equals `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false` + type: boolean + snapshot: + $ref: '#/components/schemas/snapshot._common:SnapshotInfo' + snapshot.create_repository@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + snapshot.delete@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + snapshot.delete_repository@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + snapshot.get@200: + description: '' + content: + application/json: + schema: + type: object + properties: + responses: + type: array + items: + $ref: '#/components/schemas/snapshot.get:SnapshotResponseItem' + snapshots: + type: array + items: + $ref: '#/components/schemas/snapshot._common:SnapshotInfo' + total: + description: The total number of snapshots that match the request when ignoring size limit or after query parameter. + type: number + remaining: + 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. + type: number + required: + - total + - remaining + snapshot.get_repository@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/snapshot._common:Repository' + snapshot.restore@200: + description: '' + content: + application/json: + schema: + type: object + properties: + snapshot: + $ref: '#/components/schemas/snapshot.restore:SnapshotRestore' + required: + - snapshot + snapshot.status@200: + description: '' + content: + application/json: + schema: + type: object + properties: + snapshots: + type: array + items: + $ref: '#/components/schemas/snapshot._common:Status' + required: + - snapshots + snapshot.verify_repository@200: + description: '' + content: + application/json: + schema: + type: object + properties: + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/snapshot.verify_repository:CompactNodeInfo' + required: + - nodes + tasks.cancel@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/tasks._common:TaskListResponseBase' + tasks.get@200: + description: '' + content: + application/json: + schema: + type: object + properties: + completed: + type: boolean + task: + $ref: '#/components/schemas/tasks._common:TaskInfo' + response: + type: object + error: + $ref: '#/components/schemas/_common:ErrorCause' + required: + - completed + - task + tasks.list@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/tasks._common:TaskListResponseBase' + termvectors@200: + description: '' + content: + application/json: + schema: + type: object + properties: + found: + type: boolean + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' + term_vectors: + type: object + additionalProperties: + $ref: '#/components/schemas/_core.termvectors:TermVector' + took: + type: number + _version: + $ref: '#/components/schemas/_common:VersionNumber' + required: + - found + - _id + - _index + - took + - _version + update@200: + description: '' + content: + application/json: + schema: + $ref: '#/components/schemas/_core.update:UpdateWriteResponseBase' + update_by_query@200: + description: '' + content: + application/json: + schema: + type: object + properties: + batches: + type: number + failures: + type: array + items: + $ref: '#/components/schemas/_common:BulkIndexByScrollFailure' + noops: + type: number + deleted: + type: number + requests_per_second: + type: number + retries: + $ref: '#/components/schemas/_common:Retries' + task: + $ref: '#/components/schemas/_common:TaskId' + timed_out: + type: boolean + took: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total: + type: number + updated: + type: number + version_conflicts: + type: number + throttled: + $ref: '#/components/schemas/_common:Duration' + throttled_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + throttled_until: + $ref: '#/components/schemas/_common:Duration' + throttled_until_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + update_by_query_rethrottle@200: + description: '' + content: + application/json: + schema: + type: object + properties: + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/_core.update_by_query_rethrottle:UpdateByQueryRethrottleNode' + required: + - nodes + schemas: + _common.aggregations:AdjacencyMatrixAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseAdjacencyMatrixBucket' + - type: object + _common.aggregations:AdjacencyMatrixAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + filters: + description: |- + Filters used to create buckets. + At least one filter is required. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + _common.aggregations:AdjacencyMatrixBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + key: + type: string + required: + - key + _common.aggregations:Aggregate: + oneOf: + - $ref: '#/components/schemas/_common.aggregations:CardinalityAggregate' + - $ref: '#/components/schemas/_common.aggregations:HdrPercentilesAggregate' + - $ref: '#/components/schemas/_common.aggregations:HdrPercentileRanksAggregate' + - $ref: '#/components/schemas/_common.aggregations:TDigestPercentilesAggregate' + - $ref: '#/components/schemas/_common.aggregations:TDigestPercentileRanksAggregate' + - $ref: '#/components/schemas/_common.aggregations:PercentilesBucketAggregate' + - $ref: '#/components/schemas/_common.aggregations:MedianAbsoluteDeviationAggregate' + - $ref: '#/components/schemas/_common.aggregations:MinAggregate' + - $ref: '#/components/schemas/_common.aggregations:MaxAggregate' + - $ref: '#/components/schemas/_common.aggregations:SumAggregate' + - $ref: '#/components/schemas/_common.aggregations:AvgAggregate' + - $ref: '#/components/schemas/_common.aggregations:WeightedAvgAggregate' + - $ref: '#/components/schemas/_common.aggregations:ValueCountAggregate' + - $ref: '#/components/schemas/_common.aggregations:SimpleValueAggregate' + - $ref: '#/components/schemas/_common.aggregations:DerivativeAggregate' + - $ref: '#/components/schemas/_common.aggregations:BucketMetricValueAggregate' + - $ref: '#/components/schemas/_common.aggregations:StatsAggregate' + - $ref: '#/components/schemas/_common.aggregations:StatsBucketAggregate' + - $ref: '#/components/schemas/_common.aggregations:ExtendedStatsAggregate' + - $ref: '#/components/schemas/_common.aggregations:ExtendedStatsBucketAggregate' + - $ref: '#/components/schemas/_common.aggregations:GeoBoundsAggregate' + - $ref: '#/components/schemas/_common.aggregations:GeoCentroidAggregate' + - $ref: '#/components/schemas/_common.aggregations:HistogramAggregate' + - $ref: '#/components/schemas/_common.aggregations:DateHistogramAggregate' + - $ref: '#/components/schemas/_common.aggregations:AutoDateHistogramAggregate' + - $ref: '#/components/schemas/_common.aggregations:VariableWidthHistogramAggregate' + - $ref: '#/components/schemas/_common.aggregations:StringTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations:LongTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations:DoubleTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations:UnmappedTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations:LongRareTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations:StringRareTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations:UnmappedRareTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations:MultiTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations:MissingAggregate' + - $ref: '#/components/schemas/_common.aggregations:NestedAggregate' + - $ref: '#/components/schemas/_common.aggregations:ReverseNestedAggregate' + - $ref: '#/components/schemas/_common.aggregations:GlobalAggregate' + - $ref: '#/components/schemas/_common.aggregations:FilterAggregate' + - $ref: '#/components/schemas/_common.aggregations:ChildrenAggregate' + - $ref: '#/components/schemas/_common.aggregations:ParentAggregate' + - $ref: '#/components/schemas/_common.aggregations:SamplerAggregate' + - $ref: '#/components/schemas/_common.aggregations:UnmappedSamplerAggregate' + - $ref: '#/components/schemas/_common.aggregations:GeoHashGridAggregate' + - $ref: '#/components/schemas/_common.aggregations:GeoTileGridAggregate' + - $ref: '#/components/schemas/_common.aggregations:GeoHexGridAggregate' + - $ref: '#/components/schemas/_common.aggregations:RangeAggregate' + - $ref: '#/components/schemas/_common.aggregations:DateRangeAggregate' + - $ref: '#/components/schemas/_common.aggregations:GeoDistanceAggregate' + - $ref: '#/components/schemas/_common.aggregations:IpRangeAggregate' + - $ref: '#/components/schemas/_common.aggregations:IpPrefixAggregate' + - $ref: '#/components/schemas/_common.aggregations:FiltersAggregate' + - $ref: '#/components/schemas/_common.aggregations:AdjacencyMatrixAggregate' + - $ref: '#/components/schemas/_common.aggregations:SignificantLongTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations:SignificantStringTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations:UnmappedSignificantTermsAggregate' + - $ref: '#/components/schemas/_common.aggregations:CompositeAggregate' + - $ref: '#/components/schemas/_common.aggregations:FrequentItemSetsAggregate' + - $ref: '#/components/schemas/_common.aggregations:ScriptedMetricAggregate' + - $ref: '#/components/schemas/_common.aggregations:TopHitsAggregate' + - $ref: '#/components/schemas/_common.aggregations:InferenceAggregate' + - $ref: '#/components/schemas/_common.aggregations:StringStatsAggregate' + - $ref: '#/components/schemas/_common.aggregations:BoxPlotAggregate' + - $ref: '#/components/schemas/_common.aggregations:TopMetricsAggregate' + - $ref: '#/components/schemas/_common.aggregations:TTestAggregate' + - $ref: '#/components/schemas/_common.aggregations:RateAggregate' + - $ref: '#/components/schemas/_common.aggregations:CumulativeCardinalityAggregate' + - $ref: '#/components/schemas/_common.aggregations:MatrixStatsAggregate' + - $ref: '#/components/schemas/_common.aggregations:GeoLineAggregate' + _common.aggregations:AggregateBase: + type: object + properties: + meta: + $ref: '#/components/schemas/_common:Metadata' + _common.aggregations:AggregateOrder: + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common:SortOrder' + minProperties: 1 + maxProperties: 1 + - type: array + items: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:SortOrder' + minProperties: 1 + maxProperties: 1 + _common.aggregations:Aggregation: + type: object + properties: + meta: + $ref: '#/components/schemas/_common:Metadata' + name: + type: string + _common.aggregations:AggregationContainer: + allOf: + - type: object + properties: + aggregations: + description: |- + Sub-aggregations for this aggregation. + Only applies to bucket aggregations. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:AggregationContainer' + meta: + $ref: '#/components/schemas/_common:Metadata' + - type: object + properties: + adjacency_matrix: + $ref: '#/components/schemas/_common.aggregations:AdjacencyMatrixAggregation' + auto_date_histogram: + $ref: '#/components/schemas/_common.aggregations:AutoDateHistogramAggregation' + avg: + $ref: '#/components/schemas/_common.aggregations:AverageAggregation' + avg_bucket: + $ref: '#/components/schemas/_common.aggregations:AverageBucketAggregation' + boxplot: + $ref: '#/components/schemas/_common.aggregations:BoxplotAggregation' + bucket_script: + $ref: '#/components/schemas/_common.aggregations:BucketScriptAggregation' + bucket_selector: + $ref: '#/components/schemas/_common.aggregations:BucketSelectorAggregation' + bucket_sort: + $ref: '#/components/schemas/_common.aggregations:BucketSortAggregation' + bucket_count_ks_test: + $ref: '#/components/schemas/_common.aggregations:BucketKsAggregation' + bucket_correlation: + $ref: '#/components/schemas/_common.aggregations:BucketCorrelationAggregation' + cardinality: + $ref: '#/components/schemas/_common.aggregations:CardinalityAggregation' + categorize_text: + $ref: '#/components/schemas/_common.aggregations:CategorizeTextAggregation' + children: + $ref: '#/components/schemas/_common.aggregations:ChildrenAggregation' + composite: + $ref: '#/components/schemas/_common.aggregations:CompositeAggregation' + cumulative_cardinality: + $ref: '#/components/schemas/_common.aggregations:CumulativeCardinalityAggregation' + cumulative_sum: + $ref: '#/components/schemas/_common.aggregations:CumulativeSumAggregation' + date_histogram: + $ref: '#/components/schemas/_common.aggregations:DateHistogramAggregation' + date_range: + $ref: '#/components/schemas/_common.aggregations:DateRangeAggregation' + derivative: + $ref: '#/components/schemas/_common.aggregations:DerivativeAggregation' + diversified_sampler: + $ref: '#/components/schemas/_common.aggregations:DiversifiedSamplerAggregation' + extended_stats: + $ref: '#/components/schemas/_common.aggregations:ExtendedStatsAggregation' + extended_stats_bucket: + $ref: '#/components/schemas/_common.aggregations:ExtendedStatsBucketAggregation' + frequent_item_sets: + $ref: '#/components/schemas/_common.aggregations:FrequentItemSetsAggregation' + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + filters: + $ref: '#/components/schemas/_common.aggregations:FiltersAggregation' + geo_bounds: + $ref: '#/components/schemas/_common.aggregations:GeoBoundsAggregation' + geo_centroid: + $ref: '#/components/schemas/_common.aggregations:GeoCentroidAggregation' + geo_distance: + $ref: '#/components/schemas/_common.aggregations:GeoDistanceAggregation' + geohash_grid: + $ref: '#/components/schemas/_common.aggregations:GeoHashGridAggregation' + geo_line: + $ref: '#/components/schemas/_common.aggregations:GeoLineAggregation' + geotile_grid: + $ref: '#/components/schemas/_common.aggregations:GeoTileGridAggregation' + geohex_grid: + $ref: '#/components/schemas/_common.aggregations:GeohexGridAggregation' + global: + $ref: '#/components/schemas/_common.aggregations:GlobalAggregation' + histogram: + $ref: '#/components/schemas/_common.aggregations:HistogramAggregation' + ip_range: + $ref: '#/components/schemas/_common.aggregations:IpRangeAggregation' + ip_prefix: + $ref: '#/components/schemas/_common.aggregations:IpPrefixAggregation' + inference: + $ref: '#/components/schemas/_common.aggregations:InferenceAggregation' + line: + $ref: '#/components/schemas/_common.aggregations:GeoLineAggregation' + matrix_stats: + $ref: '#/components/schemas/_common.aggregations:MatrixStatsAggregation' + max: + $ref: '#/components/schemas/_common.aggregations:MaxAggregation' + max_bucket: + $ref: '#/components/schemas/_common.aggregations:MaxBucketAggregation' + median_absolute_deviation: + $ref: '#/components/schemas/_common.aggregations:MedianAbsoluteDeviationAggregation' + min: + $ref: '#/components/schemas/_common.aggregations:MinAggregation' + min_bucket: + $ref: '#/components/schemas/_common.aggregations:MinBucketAggregation' + missing: + $ref: '#/components/schemas/_common.aggregations:MissingAggregation' + moving_avg: + $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregation' + moving_percentiles: + $ref: '#/components/schemas/_common.aggregations:MovingPercentilesAggregation' + moving_fn: + $ref: '#/components/schemas/_common.aggregations:MovingFunctionAggregation' + multi_terms: + $ref: '#/components/schemas/_common.aggregations:MultiTermsAggregation' + nested: + $ref: '#/components/schemas/_common.aggregations:NestedAggregation' + normalize: + $ref: '#/components/schemas/_common.aggregations:NormalizeAggregation' + parent: + $ref: '#/components/schemas/_common.aggregations:ParentAggregation' + percentile_ranks: + $ref: '#/components/schemas/_common.aggregations:PercentileRanksAggregation' + percentiles: + $ref: '#/components/schemas/_common.aggregations:PercentilesAggregation' + percentiles_bucket: + $ref: '#/components/schemas/_common.aggregations:PercentilesBucketAggregation' + range: + $ref: '#/components/schemas/_common.aggregations:RangeAggregation' + rare_terms: + $ref: '#/components/schemas/_common.aggregations:RareTermsAggregation' + rate: + $ref: '#/components/schemas/_common.aggregations:RateAggregation' + reverse_nested: + $ref: '#/components/schemas/_common.aggregations:ReverseNestedAggregation' + sampler: + $ref: '#/components/schemas/_common.aggregations:SamplerAggregation' + scripted_metric: + $ref: '#/components/schemas/_common.aggregations:ScriptedMetricAggregation' + serial_diff: + $ref: '#/components/schemas/_common.aggregations:SerialDifferencingAggregation' + significant_terms: + $ref: '#/components/schemas/_common.aggregations:SignificantTermsAggregation' + significant_text: + $ref: '#/components/schemas/_common.aggregations:SignificantTextAggregation' + stats: + $ref: '#/components/schemas/_common.aggregations:StatsAggregation' + stats_bucket: + $ref: '#/components/schemas/_common.aggregations:StatsBucketAggregation' + string_stats: + $ref: '#/components/schemas/_common.aggregations:StringStatsAggregation' + sum: + $ref: '#/components/schemas/_common.aggregations:SumAggregation' + sum_bucket: + $ref: '#/components/schemas/_common.aggregations:SumBucketAggregation' + terms: + $ref: '#/components/schemas/_common.aggregations:TermsAggregation' + top_hits: + $ref: '#/components/schemas/_common.aggregations:TopHitsAggregation' + t_test: + $ref: '#/components/schemas/_common.aggregations:TTestAggregation' + top_metrics: + $ref: '#/components/schemas/_common.aggregations:TopMetricsAggregation' + value_count: + $ref: '#/components/schemas/_common.aggregations:ValueCountAggregation' + weighted_avg: + $ref: '#/components/schemas/_common.aggregations:WeightedAverageAggregation' + variable_width_histogram: + $ref: '#/components/schemas/_common.aggregations:VariableWidthHistogramAggregation' + minProperties: 1 + maxProperties: 1 + _common.aggregations:AggregationRange: + type: object + properties: + from: + description: Start of the range (inclusive). + oneOf: + - type: number + - type: string + - nullable: true + type: string + key: + description: Custom key to return the range with. + type: string + to: + description: End of the range (exclusive). + oneOf: + - type: number + - type: string + - nullable: true + type: string + _common.aggregations:ArrayPercentilesItem: + type: object + properties: + key: + type: string + value: + oneOf: + - type: number + - nullable: true + type: string + value_as_string: + type: string + required: + - key + - value + _common.aggregations:AutoDateHistogramAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseDateHistogramBucket' + - type: object + properties: + interval: + $ref: '#/components/schemas/_common:DurationLarge' + required: + - interval + _common.aggregations:AutoDateHistogramAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + buckets: + description: The target number of buckets. + type: number + field: + $ref: '#/components/schemas/_common:Field' + format: + description: |- + The date format used to format `key_as_string` in the response. + If no `format` is specified, the first date format specified in the field mapping is used. + type: string + minimum_interval: + $ref: '#/components/schemas/_common.aggregations:MinimumInterval' + missing: + $ref: '#/components/schemas/_common:DateTime' + offset: + description: Time zone specified as a ISO 8601 UTC offset. + type: string + params: + type: object + additionalProperties: + type: object + script: + $ref: '#/components/schemas/_common:Script' + time_zone: + $ref: '#/components/schemas/_common:TimeZone' + _common.aggregations:AverageAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - type: object + _common.aggregations:AverageBucketAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + _common.aggregations:AvgAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - type: object + _common.aggregations:BoxPlotAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + min: + type: number + max: + type: number + q1: + type: number + q2: + type: number + q3: + type: number + lower: + type: number + upper: + type: number + min_as_string: + type: string + max_as_string: + type: string + q1_as_string: + type: string + q2_as_string: + type: string + q3_as_string: + type: string + lower_as_string: + type: string + upper_as_string: + type: string + required: + - min + - max + - q1 + - q2 + - q3 + - lower + - upper + _common.aggregations:BoxplotAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - type: object + properties: + compression: + description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + type: number + _common.aggregations:BucketAggregationBase: + allOf: + - $ref: '#/components/schemas/_common.aggregations:Aggregation' + - type: object + _common.aggregations:BucketCorrelationAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketPathAggregation' + - type: object + properties: + function: + $ref: '#/components/schemas/_common.aggregations:BucketCorrelationFunction' + required: + - function + _common.aggregations:BucketCorrelationFunction: + type: object + properties: + count_correlation: + $ref: '#/components/schemas/_common.aggregations:BucketCorrelationFunctionCountCorrelation' + required: + - count_correlation + _common.aggregations:BucketCorrelationFunctionCountCorrelation: + type: object + properties: + indicator: + $ref: '#/components/schemas/_common.aggregations:BucketCorrelationFunctionCountCorrelationIndicator' + required: + - indicator + _common.aggregations:BucketCorrelationFunctionCountCorrelationIndicator: + type: object + properties: + doc_count: + description: |- + The total number of documents that initially created the expectations. It’s required to be greater + than or equal to the sum of all values in the buckets_path as this is the originating superset of data + to which the term values are correlated. + type: number + expectations: + description: |- + An array of numbers with which to correlate the configured `bucket_path` values. + The length of this value must always equal the number of buckets returned by the `bucket_path`. + type: array + items: + type: number + fractions: + description: |- + An array of fractions to use when averaging and calculating variance. This should be used if + the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided, + must equal expectations. + type: array + items: + type: number + required: + - doc_count + - expectations + _common.aggregations:BucketKsAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketPathAggregation' + - type: object + properties: + alternative: + description: |- + A list of string values indicating which K-S test alternative to calculate. The valid values + are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used + when calculating the K-S test. Default value is all possible alternative hypotheses. + type: array + items: + type: string + fractions: + description: |- + A list of doubles indicating the distribution of the samples with which to compare to the `buckets_path` results. + In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual + document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall + documents are uniformly distributed on these buckets, which they would be if one used equal percentiles of a + metric to define the bucket end points. + type: array + items: + type: number + sampling_method: + description: |- + Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values. + This determines the cumulative distribution function (CDF) points used comparing the two samples. Default is + `upper_tail`, which emphasizes the upper end of the CDF points. Valid options are: `upper_tail`, `uniform`, + and `lower_tail`. + type: string + _common.aggregations:BucketMetricValueAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - type: object + properties: + keys: + type: array + items: + type: string + required: + - keys + _common.aggregations:BucketPathAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:Aggregation' + - type: object + properties: + buckets_path: + $ref: '#/components/schemas/_common.aggregations:BucketsPath' + _common.aggregations:BucketScriptAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + properties: + script: + $ref: '#/components/schemas/_common:Script' + _common.aggregations:BucketSelectorAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + properties: + script: + $ref: '#/components/schemas/_common:Script' + _common.aggregations:BucketSortAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:Aggregation' + - type: object + properties: + from: + description: Buckets in positions prior to `from` will be truncated. + type: number + gap_policy: + $ref: '#/components/schemas/_common.aggregations:GapPolicy' + size: + description: |- + The number of buckets to return. + Defaults to all buckets of the parent aggregation. + type: number + sort: + $ref: '#/components/schemas/_common:Sort' + _common.aggregations:BucketsAdjacencyMatrixBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:AdjacencyMatrixBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:AdjacencyMatrixBucket' + _common.aggregations:BucketsCompositeBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:CompositeBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:CompositeBucket' + _common.aggregations:BucketsDateHistogramBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:DateHistogramBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:DateHistogramBucket' + _common.aggregations:BucketsDoubleTermsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:DoubleTermsBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:DoubleTermsBucket' + _common.aggregations:BucketsFiltersBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:FiltersBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:FiltersBucket' + _common.aggregations:BucketsFrequentItemSetsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:FrequentItemSetsBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:FrequentItemSetsBucket' + _common.aggregations:BucketsGeoHashGridBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:GeoHashGridBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:GeoHashGridBucket' + _common.aggregations:BucketsGeoHexGridBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:GeoHexGridBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:GeoHexGridBucket' + _common.aggregations:BucketsGeoTileGridBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:GeoTileGridBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:GeoTileGridBucket' + _common.aggregations:BucketsHistogramBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:HistogramBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:HistogramBucket' + _common.aggregations:BucketsIpPrefixBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:IpPrefixBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:IpPrefixBucket' + _common.aggregations:BucketsIpRangeBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:IpRangeBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:IpRangeBucket' + _common.aggregations:BucketsLongRareTermsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:LongRareTermsBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:LongRareTermsBucket' + _common.aggregations:BucketsLongTermsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:LongTermsBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:LongTermsBucket' + _common.aggregations:BucketsMultiTermsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:MultiTermsBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:MultiTermsBucket' + _common.aggregations:BucketsPath: + description: |- + 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. + oneOf: + - type: string + - type: array + items: + type: string + - type: object + additionalProperties: + type: string + _common.aggregations:BucketsQueryContainer: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + - type: array + items: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + _common.aggregations:BucketsRangeBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:RangeBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:RangeBucket' + _common.aggregations:BucketsSignificantLongTermsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:SignificantLongTermsBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:SignificantLongTermsBucket' + _common.aggregations:BucketsSignificantStringTermsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:SignificantStringTermsBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:SignificantStringTermsBucket' + _common.aggregations:BucketsStringRareTermsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:StringRareTermsBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:StringRareTermsBucket' + _common.aggregations:BucketsStringTermsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:StringTermsBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:StringTermsBucket' + _common.aggregations:BucketsVariableWidthHistogramBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:VariableWidthHistogramBucket' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:VariableWidthHistogramBucket' + _common.aggregations:BucketsVoid: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/_common:Void' + - type: array + items: + $ref: '#/components/schemas/_common:Void' + _common.aggregations:CalendarInterval: + type: string + enum: + - second + - minute + - hour + - day + - week + - month + - quarter + - year + _common.aggregations:CardinalityAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + value: + type: number + required: + - value + _common.aggregations:CardinalityAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - type: object + properties: + precision_threshold: + description: |- + A unique count below which counts are expected to be close to accurate. + This allows to trade memory for accuracy. + type: number + rehash: + type: boolean + execution_hint: + $ref: '#/components/schemas/_common.aggregations:CardinalityExecutionMode' + _common.aggregations:CardinalityExecutionMode: + type: string + enum: + - global_ordinals + - segment_ordinals + - direct + - save_memory_heuristic + - save_time_heuristic + _common.aggregations:CategorizeTextAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:Aggregation' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + max_unique_tokens: + description: |- + The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1. + Smaller values use less memory and create fewer categories. Larger values will use more memory and + create narrower categories. Max allowed value is 100. + type: number + max_matched_tokens: + description: |- + The maximum number of token positions to match on before attempting to merge categories. Larger + values will use more memory and create narrower categories. Max allowed value is 100. + type: number + similarity_threshold: + description: |- + The minimum percentage of tokens that must match for text to be added to the category bucket. Must + be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory + usage and create narrower categories. + type: number + categorization_filters: + description: |- + 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. + type: array + items: + type: string + categorization_analyzer: + $ref: '#/components/schemas/_common.aggregations:CategorizeTextAnalyzer' + shard_size: + description: The number of categorization buckets to return from each shard before merging all the results. + type: number + size: + description: The number of buckets to return. + type: number + min_doc_count: + description: The minimum number of documents in a bucket to be returned to the results. + type: number + shard_min_doc_count: + description: The minimum number of documents in a bucket to be returned from the shard before merging. + type: number + required: + - field + _common.aggregations:CategorizeTextAnalyzer: + oneOf: + - type: string + - $ref: '#/components/schemas/_common.aggregations:CustomCategorizeTextAnalyzer' + _common.aggregations:ChiSquareHeuristic: + type: object + properties: + background_is_superset: + description: Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + type: boolean + include_negatives: + description: Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + type: boolean + required: + - background_is_superset + - include_negatives + _common.aggregations:ChildrenAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - type: object + _common.aggregations:ChildrenAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + type: + $ref: '#/components/schemas/_common:RelationName' + _common.aggregations:ClassificationInferenceOptions: + type: object + properties: + num_top_classes: + description: Specifies the number of top class predictions to return. Defaults to 0. + type: number + num_top_feature_importance_values: + description: Specifies the maximum number of feature importance values per document. + type: number + prediction_field_type: + description: 'Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.' + type: string + results_field: + description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value. + type: string + top_classes_results_field: + description: Specifies the field to which the top classes are written. Defaults to top_classes. + type: string + _common.aggregations:CompositeAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseCompositeBucket' + - type: object + properties: + after_key: + $ref: '#/components/schemas/_common.aggregations:CompositeAggregateKey' + _common.aggregations:CompositeAggregateKey: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:FieldValue' + _common.aggregations:CompositeAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + after: + $ref: '#/components/schemas/_common.aggregations:CompositeAggregateKey' + size: + description: The number of composite buckets that should be returned. + type: number + sources: + description: |- + The value sources used to build composite buckets. + Keys are returned in the order of the `sources` definition. + type: array + items: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:CompositeAggregationSource' + _common.aggregations:CompositeAggregationBase: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + missing_bucket: + type: boolean + missing_order: + $ref: '#/components/schemas/_common.aggregations:MissingOrder' + script: + $ref: '#/components/schemas/_common:Script' + value_type: + $ref: '#/components/schemas/_common.aggregations:ValueType' + order: + $ref: '#/components/schemas/_common:SortOrder' + _common.aggregations:CompositeAggregationSource: + type: object + properties: + terms: + $ref: '#/components/schemas/_common.aggregations:CompositeTermsAggregation' + histogram: + $ref: '#/components/schemas/_common.aggregations:CompositeHistogramAggregation' + date_histogram: + $ref: '#/components/schemas/_common.aggregations:CompositeDateHistogramAggregation' + geotile_grid: + $ref: '#/components/schemas/_common.aggregations:CompositeGeoTileGridAggregation' + _common.aggregations:CompositeBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + key: + $ref: '#/components/schemas/_common.aggregations:CompositeAggregateKey' + required: + - key + _common.aggregations:CompositeDateHistogramAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationBase' + - type: object + properties: + format: + type: string + calendar_interval: + $ref: '#/components/schemas/_common:DurationLarge' + fixed_interval: + $ref: '#/components/schemas/_common:DurationLarge' + offset: + $ref: '#/components/schemas/_common:Duration' + time_zone: + $ref: '#/components/schemas/_common:TimeZone' + _common.aggregations:CompositeGeoTileGridAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationBase' + - type: object + properties: + precision: + type: number + bounds: + $ref: '#/components/schemas/_common:GeoBounds' + _common.aggregations:CompositeHistogramAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationBase' + - type: object + properties: + interval: + type: number + required: + - interval + _common.aggregations:CompositeTermsAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:CompositeAggregationBase' + - type: object + _common.aggregations:CumulativeCardinalityAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + value: + type: number + value_as_string: + type: string + required: + - value + _common.aggregations:CumulativeCardinalityAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + _common.aggregations:CumulativeSumAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + _common.aggregations:CustomCategorizeTextAnalyzer: + type: object + properties: + char_filter: + type: array + items: + type: string + tokenizer: + type: string + filter: + type: array + items: + type: string + _common.aggregations:DateHistogramAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseDateHistogramBucket' + - type: object + _common.aggregations:DateHistogramAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + calendar_interval: + $ref: '#/components/schemas/_common.aggregations:CalendarInterval' + extended_bounds: + $ref: '#/components/schemas/_common.aggregations:ExtendedBoundsFieldDateMath' + hard_bounds: + $ref: '#/components/schemas/_common.aggregations:ExtendedBoundsFieldDateMath' + field: + $ref: '#/components/schemas/_common:Field' + fixed_interval: + $ref: '#/components/schemas/_common:Duration' + format: + description: |- + The date format used to format `key_as_string` in the response. + If no `format` is specified, the first date format specified in the field mapping is used. + type: string + interval: + $ref: '#/components/schemas/_common:Duration' + min_doc_count: + description: |- + Only returns buckets that have `min_doc_count` number of documents. + By default, all buckets between the first bucket that matches documents and the last one are returned. + type: number + missing: + $ref: '#/components/schemas/_common:DateTime' + offset: + $ref: '#/components/schemas/_common:Duration' + order: + $ref: '#/components/schemas/_common.aggregations:AggregateOrder' + params: + type: object + additionalProperties: + type: object + script: + $ref: '#/components/schemas/_common:Script' + time_zone: + $ref: '#/components/schemas/_common:TimeZone' + keyed: + description: Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array. + type: boolean + _common.aggregations:DateHistogramBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + key_as_string: + type: string + key: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + required: + - key + _common.aggregations:DateRangeAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:RangeAggregate' + - type: object + _common.aggregations:DateRangeAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + format: + description: The date format used to format `from` and `to` in the response. + type: string + missing: + $ref: '#/components/schemas/_common.aggregations:Missing' + ranges: + description: Array of date ranges. + type: array + items: + $ref: '#/components/schemas/_common.aggregations:DateRangeExpression' + time_zone: + $ref: '#/components/schemas/_common:TimeZone' + keyed: + description: Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array. + type: boolean + _common.aggregations:DateRangeExpression: + type: object + properties: + from: + $ref: '#/components/schemas/_common.aggregations:FieldDateMath' + key: + description: Custom key to return the range with. + type: string + to: + $ref: '#/components/schemas/_common.aggregations:FieldDateMath' + _common.aggregations:DerivativeAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - type: object + properties: + normalized_value: + type: number + normalized_value_as_string: + type: string + _common.aggregations:DerivativeAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + _common.aggregations:DiversifiedSamplerAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + execution_hint: + $ref: '#/components/schemas/_common.aggregations:SamplerAggregationExecutionHint' + max_docs_per_value: + description: Limits how many documents are permitted per choice of de-duplicating value. + type: number + script: + $ref: '#/components/schemas/_common:Script' + shard_size: + description: Limits how many top-scoring documents are collected in the sample processed on each shard. + type: number + field: + $ref: '#/components/schemas/_common:Field' + _common.aggregations:DoubleTermsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseDoubleTermsBucket' + - type: object + _common.aggregations:DoubleTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:TermsBucketBase' + - type: object + properties: + key: + type: number + key_as_string: + type: string + required: + - key + _common.aggregations:EwmaModelSettings: + type: object + properties: + alpha: + type: number + _common.aggregations:EwmaMovingAverageAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' + - type: object + properties: + model: + type: string + enum: + - ewma + settings: + $ref: '#/components/schemas/_common.aggregations:EwmaModelSettings' + required: + - model + - settings + _common.aggregations:ExtendedBoundsFieldDateMath: + type: object + properties: + max: + $ref: '#/components/schemas/_common.aggregations:FieldDateMath' + min: + $ref: '#/components/schemas/_common.aggregations:FieldDateMath' + required: + - max + - min + _common.aggregations:ExtendedBoundsdouble: + type: object + properties: + max: + description: Maximum value for the bound. + type: number + min: + description: Minimum value for the bound. + type: number + required: + - max + - min + _common.aggregations:ExtendedStatsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:StatsAggregate' + - type: object + properties: + sum_of_squares: + oneOf: + - type: number + - nullable: true + type: string + variance: + oneOf: + - type: number + - nullable: true + type: string + variance_population: + oneOf: + - type: number + - nullable: true + type: string + variance_sampling: + oneOf: + - type: number + - nullable: true + type: string + std_deviation: + oneOf: + - type: number + - nullable: true + type: string + std_deviation_population: + oneOf: + - type: number + - nullable: true + type: string + std_deviation_sampling: + oneOf: + - type: number + - nullable: true + type: string + std_deviation_bounds: + $ref: '#/components/schemas/_common.aggregations:StandardDeviationBounds' + sum_of_squares_as_string: + type: string + variance_as_string: + type: string + variance_population_as_string: + type: string + variance_sampling_as_string: + type: string + std_deviation_as_string: + type: string + std_deviation_bounds_as_string: + $ref: '#/components/schemas/_common.aggregations:StandardDeviationBoundsAsString' + required: + - sum_of_squares + - variance + - variance_population + - variance_sampling + - std_deviation + - std_deviation_population + - std_deviation_sampling + _common.aggregations:ExtendedStatsAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - type: object + properties: + sigma: + description: The number of standard deviations above/below the mean to display. + type: number + _common.aggregations:ExtendedStatsBucketAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:ExtendedStatsAggregate' + - type: object + _common.aggregations:ExtendedStatsBucketAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + properties: + sigma: + description: The number of standard deviations above/below the mean to display. + type: number + _common.aggregations:FieldDateMath: + description: |- + A date range limit, represented either as a DateMath expression or a number expressed + according to the target field's precision. + oneOf: + - $ref: '#/components/schemas/_common:DateMath' + - type: number + _common.aggregations:FilterAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - type: object + _common.aggregations:FiltersAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseFiltersBucket' + - type: object + _common.aggregations:FiltersAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + filters: + $ref: '#/components/schemas/_common.aggregations:BucketsQueryContainer' + other_bucket: + description: Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters. + type: boolean + other_bucket_key: + description: The key with which the other bucket is returned. + type: string + keyed: + description: |- + By default, the named filters aggregation returns the buckets as an object. + Set to `false` to return the buckets as an array of objects. + type: boolean + _common.aggregations:FiltersBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + _common.aggregations:FormatMetricAggregationBase: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - type: object + properties: + format: + type: string + _common.aggregations:FormattableMetricAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - type: object + properties: + format: + type: string + _common.aggregations:FrequentItemSetsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseFrequentItemSetsBucket' + - type: object + _common.aggregations:FrequentItemSetsAggregation: + type: object + properties: + fields: + description: Fields to analyze. + type: array + items: + $ref: '#/components/schemas/_common.aggregations:FrequentItemSetsField' + minimum_set_size: + description: The minimum size of one item set. + type: number + minimum_support: + description: The minimum support of one item set. + type: number + size: + description: The number of top item sets to return. + type: number + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + required: + - fields + _common.aggregations:FrequentItemSetsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + key: + type: object + additionalProperties: + type: array + items: + type: string + support: + type: number + required: + - key + - support + _common.aggregations:FrequentItemSetsField: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + exclude: + $ref: '#/components/schemas/_common.aggregations:TermsExclude' + include: + $ref: '#/components/schemas/_common.aggregations:TermsInclude' + required: + - field + _common.aggregations:GapPolicy: + type: string + enum: + - skip + - insert_zeros + - keep_values + _common.aggregations:GeoBoundsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + bounds: + $ref: '#/components/schemas/_common:GeoBounds' + _common.aggregations:GeoBoundsAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - type: object + properties: + wrap_longitude: + description: Specifies whether the bounding box should be allowed to overlap the international date line. + type: boolean + _common.aggregations:GeoCentroidAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + count: + type: number + location: + $ref: '#/components/schemas/_common:GeoLocation' + required: + - count + _common.aggregations:GeoCentroidAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - type: object + properties: + count: + type: number + location: + $ref: '#/components/schemas/_common:GeoLocation' + _common.aggregations:GeoDistanceAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:RangeAggregate' + - type: object + _common.aggregations:GeoDistanceAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + distance_type: + $ref: '#/components/schemas/_common:GeoDistanceType' + field: + $ref: '#/components/schemas/_common:Field' + origin: + $ref: '#/components/schemas/_common:GeoLocation' + ranges: + description: An array of ranges used to bucket documents. + type: array + items: + $ref: '#/components/schemas/_common.aggregations:AggregationRange' + unit: + $ref: '#/components/schemas/_common:DistanceUnit' + _common.aggregations:GeoHashGridAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseGeoHashGridBucket' + - type: object + _common.aggregations:GeoHashGridAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + bounds: + $ref: '#/components/schemas/_common:GeoBounds' + field: + $ref: '#/components/schemas/_common:Field' + precision: + $ref: '#/components/schemas/_common:GeoHashPrecision' + shard_size: + description: |- + Allows for more accurate counting of the top cells returned in the final result the aggregation. + Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + type: number + size: + description: The maximum number of geohash buckets to return. + type: number + _common.aggregations:GeoHashGridBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + key: + $ref: '#/components/schemas/_common:GeoHash' + required: + - key + _common.aggregations:GeoHexGridAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseGeoHexGridBucket' + - type: object + _common.aggregations:GeoHexGridBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + key: + $ref: '#/components/schemas/_common:GeoHexCell' + required: + - key + _common.aggregations:GeoLineAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + type: + type: string + geometry: + $ref: '#/components/schemas/_common:GeoLine' + properties: + type: object + required: + - type + - geometry + - properties + _common.aggregations:GeoLineAggregation: + type: object + properties: + point: + $ref: '#/components/schemas/_common.aggregations:GeoLinePoint' + sort: + $ref: '#/components/schemas/_common.aggregations:GeoLineSort' + include_sort: + description: When `true`, returns an additional array of the sort values in the feature properties. + type: boolean + sort_order: + $ref: '#/components/schemas/_common:SortOrder' + size: + description: |- + The maximum length of the line represented in the aggregation. + Valid sizes are between 1 and 10000. + type: number + required: + - point + - sort + _common.aggregations:GeoLinePoint: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + required: + - field + _common.aggregations:GeoLineSort: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + required: + - field + _common.aggregations:GeoTileGridAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseGeoTileGridBucket' + - type: object + _common.aggregations:GeoTileGridAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + precision: + $ref: '#/components/schemas/_common:GeoTilePrecision' + shard_size: + description: |- + Allows for more accurate counting of the top cells returned in the final result the aggregation. + Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + type: number + size: + description: The maximum number of buckets to return. + type: number + bounds: + $ref: '#/components/schemas/_common:GeoBounds' + _common.aggregations:GeoTileGridBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + key: + $ref: '#/components/schemas/_common:GeoTile' + required: + - key + _common.aggregations:GeohexGridAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + precision: + description: |- + Integer zoom of the key used to defined cells or buckets + in the results. Value should be between 0-15. + type: number + bounds: + $ref: '#/components/schemas/_common:GeoBounds' + size: + description: Maximum number of buckets to return. + type: number + shard_size: + description: Number of buckets returned from each shard. + type: number + required: + - field + _common.aggregations:GlobalAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - type: object + _common.aggregations:GlobalAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + _common.aggregations:GoogleNormalizedDistanceHeuristic: + type: object + properties: + background_is_superset: + description: Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + type: boolean + _common.aggregations:HdrMethod: + type: object + properties: + number_of_significant_value_digits: + description: Specifies the resolution of values for the histogram in number of significant digits. + type: number + _common.aggregations:HdrPercentileRanksAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' + - type: object + _common.aggregations:HdrPercentilesAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' + - type: object + _common.aggregations:HistogramAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseHistogramBucket' + - type: object + _common.aggregations:HistogramAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + extended_bounds: + $ref: '#/components/schemas/_common.aggregations:ExtendedBoundsdouble' + hard_bounds: + $ref: '#/components/schemas/_common.aggregations:ExtendedBoundsdouble' + field: + $ref: '#/components/schemas/_common:Field' + interval: + description: |- + The interval for the buckets. + Must be a positive decimal. + type: number + min_doc_count: + description: |- + Only returns buckets that have `min_doc_count` number of documents. + By default, the response will fill gaps in the histogram with empty buckets. + type: number + missing: + description: |- + The value to apply to documents that do not have a value. + By default, documents without a value are ignored. + type: number + offset: + description: |- + By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`. + The bucket boundaries can be shifted by using the `offset` option. + type: number + order: + $ref: '#/components/schemas/_common.aggregations:AggregateOrder' + script: + $ref: '#/components/schemas/_common:Script' + format: + type: string + keyed: + description: If `true`, returns buckets as a hash instead of an array, keyed by the bucket keys. + type: boolean + _common.aggregations:HistogramBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + key_as_string: + type: string + key: + type: number + required: + - key + _common.aggregations:HoltLinearModelSettings: + type: object + properties: + alpha: + type: number + beta: + type: number + _common.aggregations:HoltMovingAverageAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' + - type: object + properties: + model: + type: string + enum: + - holt + settings: + $ref: '#/components/schemas/_common.aggregations:HoltLinearModelSettings' + required: + - model + - settings + _common.aggregations:HoltWintersModelSettings: + type: object + properties: + alpha: + type: number + beta: + type: number + gamma: + type: number + pad: + type: boolean + period: + type: number + type: + $ref: '#/components/schemas/_common.aggregations:HoltWintersType' + _common.aggregations:HoltWintersMovingAverageAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' + - type: object + properties: + model: + type: string + enum: + - holt_winters + settings: + $ref: '#/components/schemas/_common.aggregations:HoltWintersModelSettings' + required: + - model + - settings + _common.aggregations:HoltWintersType: + type: string + enum: + - add + - mult + _common.aggregations:InferenceAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + value: + $ref: '#/components/schemas/_common:FieldValue' + feature_importance: + type: array + items: + $ref: '#/components/schemas/_common.aggregations:InferenceFeatureImportance' + top_classes: + type: array + items: + $ref: '#/components/schemas/_common.aggregations:InferenceTopClassEntry' + warning: + type: string + _common.aggregations:InferenceAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + properties: + model_id: + $ref: '#/components/schemas/_common:Name' + inference_config: + $ref: '#/components/schemas/_common.aggregations:InferenceConfigContainer' + required: + - model_id + _common.aggregations:InferenceClassImportance: + type: object + properties: + class_name: + type: string + importance: + type: number + required: + - class_name + - importance + _common.aggregations:InferenceConfigContainer: + type: object + properties: + regression: + $ref: '#/components/schemas/_common.aggregations:RegressionInferenceOptions' + classification: + $ref: '#/components/schemas/_common.aggregations:ClassificationInferenceOptions' + minProperties: 1 + maxProperties: 1 + _common.aggregations:InferenceFeatureImportance: + type: object + properties: + feature_name: + type: string + importance: + type: number + classes: + type: array + items: + $ref: '#/components/schemas/_common.aggregations:InferenceClassImportance' + required: + - feature_name + _common.aggregations:InferenceTopClassEntry: + type: object + properties: + class_name: + $ref: '#/components/schemas/_common:FieldValue' + class_probability: + type: number + class_score: + type: number + required: + - class_name + - class_probability + - class_score + _common.aggregations:IpPrefixAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseIpPrefixBucket' + - type: object + _common.aggregations:IpPrefixAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + prefix_length: + description: |- + Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. + For IPv6 addresses the accepted range is [0, 128]. + type: number + is_ipv6: + description: Defines whether the prefix applies to IPv6 addresses. + type: boolean + append_prefix_length: + description: Defines whether the prefix length is appended to IP address keys in the response. + type: boolean + keyed: + description: Defines whether buckets are returned as a hash rather than an array in the response. + type: boolean + min_doc_count: + description: Minimum number of documents in a bucket for it to be included in the response. + type: number + required: + - field + - prefix_length + _common.aggregations:IpPrefixBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + is_ipv6: + type: boolean + key: + type: string + prefix_length: + type: number + netmask: + type: string + required: + - is_ipv6 + - key + - prefix_length + _common.aggregations:IpRangeAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseIpRangeBucket' + - type: object + _common.aggregations:IpRangeAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + ranges: + description: Array of IP ranges. + type: array + items: + $ref: '#/components/schemas/_common.aggregations:IpRangeAggregationRange' + _common.aggregations:IpRangeAggregationRange: + type: object + properties: + from: + description: Start of the range. + oneOf: + - type: string + - nullable: true + type: string + mask: + description: IP range defined as a CIDR mask. + type: string + to: + description: End of the range. + oneOf: + - type: string + - nullable: true + type: string + _common.aggregations:IpRangeBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + key: + type: string + from: + type: string + to: + type: string + _common.aggregations:KeyedPercentiles: + type: object + additionalProperties: + oneOf: + - type: string + - type: number + - nullable: true + type: string + _common.aggregations:LinearMovingAverageAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' + - type: object + properties: + model: + type: string + enum: + - linear + settings: + $ref: '#/components/schemas/_common:EmptyObject' + required: + - model + - settings + _common.aggregations:LongRareTermsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseLongRareTermsBucket' + - type: object + _common.aggregations:LongRareTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + key: + type: number + key_as_string: + type: string + required: + - key + _common.aggregations:LongTermsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseLongTermsBucket' + - type: object + _common.aggregations:LongTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:TermsBucketBase' + - type: object + properties: + key: + type: number + key_as_string: + type: string + required: + - key + _common.aggregations:MatrixAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:Aggregation' + - type: object + properties: + fields: + $ref: '#/components/schemas/_common:Fields' + missing: + description: |- + The value to apply to documents that do not have a value. + By default, documents without a value are ignored. + type: object + additionalProperties: + type: number + _common.aggregations:MatrixStatsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + doc_count: + type: number + fields: + type: array + items: + $ref: '#/components/schemas/_common.aggregations:MatrixStatsFields' + required: + - doc_count + _common.aggregations:MatrixStatsAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MatrixAggregation' + - type: object + properties: + mode: + $ref: '#/components/schemas/_common:SortMode' + _common.aggregations:MatrixStatsFields: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Field' + count: + type: number + mean: + type: number + variance: + type: number + skewness: + type: number + kurtosis: + type: number + covariance: + type: object + additionalProperties: + type: number + correlation: + type: object + additionalProperties: + type: number + required: + - name + - count + - mean + - variance + - skewness + - kurtosis + - covariance + - correlation + _common.aggregations:MaxAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - type: object + _common.aggregations:MaxAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - type: object + _common.aggregations:MaxBucketAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + _common.aggregations:MedianAbsoluteDeviationAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - type: object + _common.aggregations:MedianAbsoluteDeviationAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - type: object + properties: + compression: + description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + type: number + _common.aggregations:MetricAggregationBase: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + missing: + $ref: '#/components/schemas/_common.aggregations:Missing' + script: + $ref: '#/components/schemas/_common:Script' + _common.aggregations:MinAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - type: object + _common.aggregations:MinAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - type: object + _common.aggregations:MinBucketAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + _common.aggregations:MinimumInterval: + type: string + enum: + - second + - minute + - hour + - day + - month + - year + _common.aggregations:Missing: + oneOf: + - type: string + - type: number + - type: number + - type: boolean + _common.aggregations:MissingAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - type: object + _common.aggregations:MissingAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + missing: + $ref: '#/components/schemas/_common.aggregations:Missing' + _common.aggregations:MissingOrder: + type: string + enum: + - first + - last + - default + _common.aggregations:MovingAverageAggregation: + discriminator: + propertyName: model + oneOf: + - $ref: '#/components/schemas/_common.aggregations:LinearMovingAverageAggregation' + - $ref: '#/components/schemas/_common.aggregations:SimpleMovingAverageAggregation' + - $ref: '#/components/schemas/_common.aggregations:EwmaMovingAverageAggregation' + - $ref: '#/components/schemas/_common.aggregations:HoltMovingAverageAggregation' + - $ref: '#/components/schemas/_common.aggregations:HoltWintersMovingAverageAggregation' + _common.aggregations:MovingAverageAggregationBase: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + properties: + minimize: + type: boolean + predict: + type: number + window: + type: number + _common.aggregations:MovingFunctionAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + properties: + script: + description: The script that should be executed on each window of data. + type: string + shift: + description: |- + By default, the window consists of the last n values excluding the current bucket. + Increasing `shift` by 1, moves the starting window position by 1 to the right. + type: number + window: + description: The size of window to "slide" across the histogram. + type: number + _common.aggregations:MovingPercentilesAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + properties: + window: + description: The size of window to "slide" across the histogram. + type: number + shift: + description: |- + By default, the window consists of the last n values excluding the current bucket. + Increasing `shift` by 1, moves the starting window position by 1 to the right. + type: number + keyed: + type: boolean + _common.aggregations:MultiBucketAggregateBaseAdjacencyMatrixBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsAdjacencyMatrixBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseCompositeBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsCompositeBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseDateHistogramBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsDateHistogramBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseDoubleTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsDoubleTermsBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseFiltersBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsFiltersBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseFrequentItemSetsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsFrequentItemSetsBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseGeoHashGridBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsGeoHashGridBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseGeoHexGridBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsGeoHexGridBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseGeoTileGridBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsGeoTileGridBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseHistogramBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsHistogramBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseIpPrefixBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsIpPrefixBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseIpRangeBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsIpRangeBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseLongRareTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsLongRareTermsBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseLongTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsLongTermsBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseMultiTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsMultiTermsBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseRangeBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsRangeBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseSignificantLongTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsSignificantLongTermsBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseSignificantStringTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsSignificantStringTermsBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseStringRareTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsStringRareTermsBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseStringTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsStringTermsBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseVariableWidthHistogramBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsVariableWidthHistogramBucket' + required: + - buckets + _common.aggregations:MultiBucketAggregateBaseVoid: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/_common.aggregations:BucketsVoid' + required: + - buckets + _common.aggregations:MultiBucketBase: + type: object + properties: + doc_count: + type: number + required: + - doc_count + _common.aggregations:MultiTermLookup: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + missing: + $ref: '#/components/schemas/_common.aggregations:Missing' + required: + - field + _common.aggregations:MultiTermsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseMultiTermsBucket' + - type: object + _common.aggregations:MultiTermsAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + collect_mode: + $ref: '#/components/schemas/_common.aggregations:TermsAggregationCollectMode' + order: + $ref: '#/components/schemas/_common.aggregations:AggregateOrder' + min_doc_count: + description: The minimum number of documents in a bucket for it to be returned. + type: number + shard_min_doc_count: + description: The minimum number of documents in a bucket on each shard for it to be returned. + type: number + shard_size: + description: |- + The number of candidate terms produced by each shard. + By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + type: number + show_term_doc_count_error: + description: Calculates the doc count error on per term basis. + type: boolean + size: + description: The number of term buckets should be returned out of the overall terms list. + type: number + terms: + description: The field from which to generate sets of terms. + type: array + items: + $ref: '#/components/schemas/_common.aggregations:MultiTermLookup' + required: + - terms + _common.aggregations:MultiTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + key: + type: array + items: + $ref: '#/components/schemas/_common:FieldValue' + key_as_string: + type: string + doc_count_error_upper_bound: + type: number + required: + - key + _common.aggregations:MutualInformationHeuristic: + type: object + properties: + background_is_superset: + description: Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to. + type: boolean + include_negatives: + description: Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset. + type: boolean + _common.aggregations:NestedAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - type: object + _common.aggregations:NestedAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + path: + $ref: '#/components/schemas/_common:Field' + _common.aggregations:NormalizeAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + properties: + method: + $ref: '#/components/schemas/_common.aggregations:NormalizeMethod' + _common.aggregations:NormalizeMethod: + type: string + enum: + - rescale_0_1 + - rescale_0_100 + - percent_of_sum + - mean + - z-score + - softmax + _common.aggregations:ParentAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - type: object + _common.aggregations:ParentAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + type: + $ref: '#/components/schemas/_common:RelationName' + _common.aggregations:PercentageScoreHeuristic: + type: object + _common.aggregations:PercentileRanksAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - type: object + properties: + keyed: + description: |- + By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array. + Set to `false` to disable this behavior. + type: boolean + values: + description: An array of values for which to calculate the percentile ranks. + oneOf: + - type: array + items: + type: number + - nullable: true + type: string + hdr: + $ref: '#/components/schemas/_common.aggregations:HdrMethod' + tdigest: + $ref: '#/components/schemas/_common.aggregations:TDigest' + _common.aggregations:Percentiles: + oneOf: + - $ref: '#/components/schemas/_common.aggregations:KeyedPercentiles' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:ArrayPercentilesItem' + _common.aggregations:PercentilesAggregateBase: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + values: + $ref: '#/components/schemas/_common.aggregations:Percentiles' + required: + - values + _common.aggregations:PercentilesAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - type: object + properties: + keyed: + description: |- + By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array. + Set to `false` to disable this behavior. + type: boolean + percents: + description: The percentiles to calculate. + type: array + items: + type: number + hdr: + $ref: '#/components/schemas/_common.aggregations:HdrMethod' + tdigest: + $ref: '#/components/schemas/_common.aggregations:TDigest' + _common.aggregations:PercentilesBucketAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' + - type: object + _common.aggregations:PercentilesBucketAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + properties: + percents: + description: The list of percentiles to calculate. + type: array + items: + type: number + _common.aggregations:PipelineAggregationBase: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketPathAggregation' + - type: object + properties: + format: + description: |- + `DecimalFormat` pattern for the output value. + If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + type: string + gap_policy: + $ref: '#/components/schemas/_common.aggregations:GapPolicy' + _common.aggregations:RangeAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseRangeBucket' + - type: object + _common.aggregations:RangeAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + missing: + description: |- + The value to apply to documents that do not have a value. + By default, documents without a value are ignored. + type: number + ranges: + description: An array of ranges used to bucket documents. + type: array + items: + $ref: '#/components/schemas/_common.aggregations:AggregationRange' + script: + $ref: '#/components/schemas/_common:Script' + keyed: + description: Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array. + type: boolean + format: + type: string + _common.aggregations:RangeBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + from: + type: number + to: + type: number + from_as_string: + type: string + to_as_string: + type: string + key: + description: The bucket key. Present if the aggregation is _not_ keyed + type: string + _common.aggregations:RareTermsAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + exclude: + $ref: '#/components/schemas/_common.aggregations:TermsExclude' + field: + $ref: '#/components/schemas/_common:Field' + include: + $ref: '#/components/schemas/_common.aggregations:TermsInclude' + max_doc_count: + description: The maximum number of documents a term should appear in. + type: number + missing: + $ref: '#/components/schemas/_common.aggregations:Missing' + precision: + description: |- + The precision of the internal CuckooFilters. + Smaller precision leads to better approximation, but higher memory usage. + type: number + value_type: + type: string + _common.aggregations:RateAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + value: + type: number + value_as_string: + type: string + required: + - value + _common.aggregations:RateAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - type: object + properties: + unit: + $ref: '#/components/schemas/_common.aggregations:CalendarInterval' + mode: + $ref: '#/components/schemas/_common.aggregations:RateMode' + _common.aggregations:RateMode: + type: string + enum: + - sum + - value_count + _common.aggregations:RegressionInferenceOptions: + type: object + properties: + results_field: + $ref: '#/components/schemas/_common:Field' + num_top_feature_importance_values: + description: Specifies the maximum number of feature importance values per document. + type: number + _common.aggregations:ReverseNestedAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - type: object + _common.aggregations:ReverseNestedAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + path: + $ref: '#/components/schemas/_common:Field' + _common.aggregations:SamplerAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - type: object + _common.aggregations:SamplerAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + shard_size: + description: Limits how many top-scoring documents are collected in the sample processed on each shard. + type: number + _common.aggregations:SamplerAggregationExecutionHint: + type: string + enum: + - map + - global_ordinals + - bytes_hash + _common.aggregations:ScriptedHeuristic: + type: object + properties: + script: + $ref: '#/components/schemas/_common:Script' + required: + - script + _common.aggregations:ScriptedMetricAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + value: + type: object + required: + - value + _common.aggregations:ScriptedMetricAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - type: object + properties: + combine_script: + $ref: '#/components/schemas/_common:Script' + init_script: + $ref: '#/components/schemas/_common:Script' + map_script: + $ref: '#/components/schemas/_common:Script' + params: + description: |- + A global object with script parameters for `init`, `map` and `combine` scripts. + It is shared between the scripts. + type: object + additionalProperties: + type: object + reduce_script: + $ref: '#/components/schemas/_common:Script' + _common.aggregations:SerialDifferencingAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + properties: + lag: + description: |- + The historical bucket to subtract from the current value. + Must be a positive, non-zero integer. + type: number + _common.aggregations:SignificantLongTermsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SignificantTermsAggregateBaseSignificantLongTermsBucket' + - type: object + _common.aggregations:SignificantLongTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SignificantTermsBucketBase' + - type: object + properties: + key: + type: number + key_as_string: + type: string + required: + - key + _common.aggregations:SignificantStringTermsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SignificantTermsAggregateBaseSignificantStringTermsBucket' + - type: object + _common.aggregations:SignificantStringTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SignificantTermsBucketBase' + - type: object + properties: + key: + type: string + required: + - key + _common.aggregations:SignificantTermsAggregateBaseSignificantLongTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseSignificantLongTermsBucket' + - type: object + properties: + bg_count: + type: number + doc_count: + type: number + _common.aggregations:SignificantTermsAggregateBaseSignificantStringTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseSignificantStringTermsBucket' + - type: object + properties: + bg_count: + type: number + doc_count: + type: number + _common.aggregations:SignificantTermsAggregateBaseVoid: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVoid' + - type: object + properties: + bg_count: + type: number + doc_count: + type: number + _common.aggregations:SignificantTermsAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + background_filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + chi_square: + $ref: '#/components/schemas/_common.aggregations:ChiSquareHeuristic' + exclude: + $ref: '#/components/schemas/_common.aggregations:TermsExclude' + execution_hint: + $ref: '#/components/schemas/_common.aggregations:TermsAggregationExecutionHint' + field: + $ref: '#/components/schemas/_common:Field' + gnd: + $ref: '#/components/schemas/_common.aggregations:GoogleNormalizedDistanceHeuristic' + include: + $ref: '#/components/schemas/_common.aggregations:TermsInclude' + jlh: + $ref: '#/components/schemas/_common:EmptyObject' + min_doc_count: + description: Only return terms that are found in more than `min_doc_count` hits. + type: number + mutual_information: + $ref: '#/components/schemas/_common.aggregations:MutualInformationHeuristic' + percentage: + $ref: '#/components/schemas/_common.aggregations:PercentageScoreHeuristic' + script_heuristic: + $ref: '#/components/schemas/_common.aggregations:ScriptedHeuristic' + shard_min_doc_count: + description: |- + Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the `min_doc_count`. + Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + type: number + shard_size: + description: |- + Can be used to control the volumes of candidate terms produced by each shard. + By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + type: number + size: + description: The number of buckets returned out of the overall terms list. + type: number + _common.aggregations:SignificantTermsBucketBase: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + score: + type: number + bg_count: + type: number + required: + - score + - bg_count + _common.aggregations:SignificantTextAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + background_filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + chi_square: + $ref: '#/components/schemas/_common.aggregations:ChiSquareHeuristic' + exclude: + $ref: '#/components/schemas/_common.aggregations:TermsExclude' + execution_hint: + $ref: '#/components/schemas/_common.aggregations:TermsAggregationExecutionHint' + field: + $ref: '#/components/schemas/_common:Field' + filter_duplicate_text: + description: Whether to out duplicate text to deal with noisy data. + type: boolean + gnd: + $ref: '#/components/schemas/_common.aggregations:GoogleNormalizedDistanceHeuristic' + include: + $ref: '#/components/schemas/_common.aggregations:TermsInclude' + jlh: + $ref: '#/components/schemas/_common:EmptyObject' + min_doc_count: + description: Only return values that are found in more than `min_doc_count` hits. + type: number + mutual_information: + $ref: '#/components/schemas/_common.aggregations:MutualInformationHeuristic' + percentage: + $ref: '#/components/schemas/_common.aggregations:PercentageScoreHeuristic' + script_heuristic: + $ref: '#/components/schemas/_common.aggregations:ScriptedHeuristic' + shard_min_doc_count: + description: |- + Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count. + Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + type: number + shard_size: + description: |- + The number of candidate terms produced by each shard. + By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + type: number + size: + description: The number of buckets returned out of the overall terms list. + type: number + source_fields: + $ref: '#/components/schemas/_common:Fields' + _common.aggregations:SimpleMovingAverageAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MovingAverageAggregationBase' + - type: object + properties: + model: + type: string + enum: + - simple + settings: + $ref: '#/components/schemas/_common:EmptyObject' + required: + - model + - settings + _common.aggregations:SimpleValueAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - type: object + _common.aggregations:SingleBucketAggregateBase: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + doc_count: + type: number + required: + - doc_count + _common.aggregations:SingleMetricAggregateBase: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + value: + description: |- + The metric value. A missing value generally means that there was no data to aggregate, + unless specified otherwise. + oneOf: + - type: number + - nullable: true + type: string + value_as_string: + type: string + required: + - value + _common.aggregations:StandardDeviationBounds: + type: object + properties: + upper: + oneOf: + - type: number + - nullable: true + type: string + lower: + oneOf: + - type: number + - nullable: true + type: string + upper_population: + oneOf: + - type: number + - nullable: true + type: string + lower_population: + oneOf: + - type: number + - nullable: true + type: string + upper_sampling: + oneOf: + - type: number + - nullable: true + type: string + lower_sampling: + oneOf: + - type: number + - nullable: true + type: string + required: + - upper + - lower + - upper_population + - lower_population + - upper_sampling + - lower_sampling + _common.aggregations:StandardDeviationBoundsAsString: + type: object + properties: + upper: + type: string + lower: + type: string + upper_population: + type: string + lower_population: + type: string + upper_sampling: + type: string + lower_sampling: + type: string + required: + - upper + - lower + - upper_population + - lower_population + - upper_sampling + - lower_sampling + _common.aggregations:StatsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + count: + type: number + min: + oneOf: + - type: number + - nullable: true + type: string + max: + oneOf: + - type: number + - nullable: true + type: string + avg: + oneOf: + - type: number + - nullable: true + type: string + sum: + type: number + min_as_string: + type: string + max_as_string: + type: string + avg_as_string: + type: string + sum_as_string: + type: string + required: + - count + - min + - max + - avg + - sum + _common.aggregations:StatsAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - type: object + _common.aggregations:StatsBucketAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:StatsAggregate' + - type: object + _common.aggregations:StatsBucketAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + _common.aggregations:StringRareTermsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseStringRareTermsBucket' + - type: object + _common.aggregations:StringRareTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + key: + type: string + required: + - key + _common.aggregations:StringStatsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + count: + type: number + min_length: + oneOf: + - type: number + - nullable: true + type: string + max_length: + oneOf: + - type: number + - nullable: true + type: string + avg_length: + oneOf: + - type: number + - nullable: true + type: string + entropy: + oneOf: + - type: number + - nullable: true + type: string + distribution: + oneOf: + - type: object + additionalProperties: + type: number + - nullable: true + type: string + min_length_as_string: + type: string + max_length_as_string: + type: string + avg_length_as_string: + type: string + required: + - count + - min_length + - max_length + - avg_length + - entropy + _common.aggregations:StringStatsAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - type: object + properties: + show_distribution: + description: Shows the probability distribution for all characters. + type: boolean + _common.aggregations:StringTermsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseStringTermsBucket' + - type: object + _common.aggregations:StringTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:TermsBucketBase' + - type: object + properties: + key: + $ref: '#/components/schemas/_common:FieldValue' + required: + - key + _common.aggregations:SumAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - type: object + _common.aggregations:SumAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:FormatMetricAggregationBase' + - type: object + _common.aggregations:SumBucketAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PipelineAggregationBase' + - type: object + _common.aggregations:TDigest: + type: object + properties: + compression: + description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error. + type: number + _common.aggregations:TDigestPercentileRanksAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' + - type: object + _common.aggregations:TDigestPercentilesAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:PercentilesAggregateBase' + - type: object + _common.aggregations:TTestAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + value: + oneOf: + - type: number + - nullable: true + type: string + value_as_string: + type: string + required: + - value + _common.aggregations:TTestAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:Aggregation' + - type: object + properties: + a: + $ref: '#/components/schemas/_common.aggregations:TestPopulation' + b: + $ref: '#/components/schemas/_common.aggregations:TestPopulation' + type: + $ref: '#/components/schemas/_common.aggregations:TTestType' + _common.aggregations:TTestType: + type: string + enum: + - paired + - homoscedastic + - heteroscedastic + _common.aggregations:TermsAggregateBaseDoubleTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseDoubleTermsBucket' + - type: object + properties: + doc_count_error_upper_bound: + type: number + sum_other_doc_count: + type: number + _common.aggregations:TermsAggregateBaseLongTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseLongTermsBucket' + - type: object + properties: + doc_count_error_upper_bound: + type: number + sum_other_doc_count: + type: number + _common.aggregations:TermsAggregateBaseMultiTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseMultiTermsBucket' + - type: object + properties: + doc_count_error_upper_bound: + type: number + sum_other_doc_count: + type: number + _common.aggregations:TermsAggregateBaseStringTermsBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseStringTermsBucket' + - type: object + properties: + doc_count_error_upper_bound: + type: number + sum_other_doc_count: + type: number + _common.aggregations:TermsAggregateBaseVoid: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVoid' + - type: object + properties: + doc_count_error_upper_bound: + type: number + sum_other_doc_count: + type: number + _common.aggregations:TermsAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:BucketAggregationBase' + - type: object + properties: + collect_mode: + $ref: '#/components/schemas/_common.aggregations:TermsAggregationCollectMode' + exclude: + $ref: '#/components/schemas/_common.aggregations:TermsExclude' + execution_hint: + $ref: '#/components/schemas/_common.aggregations:TermsAggregationExecutionHint' + field: + $ref: '#/components/schemas/_common:Field' + include: + $ref: '#/components/schemas/_common.aggregations:TermsInclude' + min_doc_count: + description: Only return values that are found in more than `min_doc_count` hits. + type: number + missing: + $ref: '#/components/schemas/_common.aggregations:Missing' + missing_order: + $ref: '#/components/schemas/_common.aggregations:MissingOrder' + missing_bucket: + type: boolean + value_type: + description: Coerced unmapped fields into the specified type. + type: string + order: + $ref: '#/components/schemas/_common.aggregations:AggregateOrder' + script: + $ref: '#/components/schemas/_common:Script' + shard_size: + description: |- + The number of candidate terms produced by each shard. + By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + type: number + show_term_doc_count_error: + description: Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the `doc_count` returned by each shard. + type: boolean + size: + description: The number of buckets returned out of the overall terms list. + type: number + format: + type: string + _common.aggregations:TermsAggregationCollectMode: + type: string + enum: + - depth_first + - breadth_first + _common.aggregations:TermsAggregationExecutionHint: + type: string + enum: + - map + - global_ordinals + - global_ordinals_hash + - global_ordinals_low_cardinality + _common.aggregations:TermsBucketBase: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + doc_count_error: + type: number + _common.aggregations:TermsExclude: + oneOf: + - type: string + - type: array + items: + type: string + _common.aggregations:TermsInclude: + oneOf: + - type: string + - type: array + items: + type: string + - $ref: '#/components/schemas/_common.aggregations:TermsPartition' + _common.aggregations:TermsPartition: + type: object + properties: + num_partitions: + description: The number of partitions. + type: number + partition: + description: The partition number for this request. + type: number + required: + - num_partitions + - partition + _common.aggregations:TestPopulation: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + script: + $ref: '#/components/schemas/_common:Script' + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + required: + - field + _common.aggregations:TopHitsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + hits: + $ref: '#/components/schemas/_core.search:HitsMetadata' + required: + - hits + _common.aggregations:TopHitsAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - type: object + properties: + docvalue_fields: + $ref: '#/components/schemas/_common:Fields' + explain: + description: If `true`, returns detailed information about score computation as part of a hit. + type: boolean + from: + description: Starting document offset. + type: number + highlight: + $ref: '#/components/schemas/_core.search:Highlight' + script_fields: + description: Returns the result of one or more script evaluations for each hit. + type: object + additionalProperties: + $ref: '#/components/schemas/_common:ScriptField' + size: + description: The maximum number of top matching hits to return per bucket. + type: number + sort: + $ref: '#/components/schemas/_common:Sort' + _source: + $ref: '#/components/schemas/_core.search:SourceConfig' + stored_fields: + $ref: '#/components/schemas/_common:Fields' + track_scores: + description: If `true`, calculates and returns document scores, even if the scores are not used for sorting. + type: boolean + version: + description: If `true`, returns document version as part of a hit. + type: boolean + seq_no_primary_term: + description: If `true`, returns sequence number and primary term of the last modification of each hit. + type: boolean + _common.aggregations:TopMetrics: + type: object + properties: + sort: + type: array + items: + oneOf: + - $ref: '#/components/schemas/_common:FieldValue' + - nullable: true + type: string + metrics: + type: object + additionalProperties: + oneOf: + - $ref: '#/components/schemas/_common:FieldValue' + - nullable: true + type: string + required: + - sort + - metrics + _common.aggregations:TopMetricsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:AggregateBase' + - type: object + properties: + top: + type: array + items: + $ref: '#/components/schemas/_common.aggregations:TopMetrics' + required: + - top + _common.aggregations:TopMetricsAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MetricAggregationBase' + - type: object + properties: + metrics: + description: The fields of the top document to return. + oneOf: + - $ref: '#/components/schemas/_common.aggregations:TopMetricsValue' + - type: array + items: + $ref: '#/components/schemas/_common.aggregations:TopMetricsValue' + size: + description: The number of top documents from which to return metrics. + type: number + sort: + $ref: '#/components/schemas/_common:Sort' + _common.aggregations:TopMetricsValue: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + required: + - field + _common.aggregations:UnmappedRareTermsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVoid' + - type: object + _common.aggregations:UnmappedSamplerAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleBucketAggregateBase' + - type: object + _common.aggregations:UnmappedSignificantTermsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SignificantTermsAggregateBaseVoid' + - type: object + _common.aggregations:UnmappedTermsAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:TermsAggregateBaseVoid' + - type: object + _common.aggregations:ValueCountAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - type: object + _common.aggregations:ValueCountAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:FormattableMetricAggregation' + - type: object + _common.aggregations:ValueType: + type: string + enum: + - string + - long + - double + - number + - date + - date_nanos + - ip + - numeric + - geo_point + - boolean + _common.aggregations:VariableWidthHistogramAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketAggregateBaseVariableWidthHistogramBucket' + - type: object + _common.aggregations:VariableWidthHistogramAggregation: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + buckets: + description: The target number of buckets. + type: number + shard_size: + description: |- + The number of buckets that the coordinating node will request from each shard. + Defaults to `buckets * 50`. + type: number + initial_buffer: + description: |- + Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run. + Defaults to `min(10 * shard_size, 50000)`. + type: number + _common.aggregations:VariableWidthHistogramBucket: + allOf: + - $ref: '#/components/schemas/_common.aggregations:MultiBucketBase' + - type: object + properties: + min: + type: number + key: + type: number + max: + type: number + min_as_string: + type: string + key_as_string: + type: string + max_as_string: + type: string + required: + - min + - key + - max + _common.aggregations:WeightedAverageAggregation: + allOf: + - $ref: '#/components/schemas/_common.aggregations:Aggregation' + - type: object + properties: + format: + description: A numeric response formatter. + type: string + value: + $ref: '#/components/schemas/_common.aggregations:WeightedAverageValue' + value_type: + $ref: '#/components/schemas/_common.aggregations:ValueType' + weight: + $ref: '#/components/schemas/_common.aggregations:WeightedAverageValue' + _common.aggregations:WeightedAverageValue: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + missing: + description: A value or weight to use if the field is missing. + type: number + script: + $ref: '#/components/schemas/_common:Script' + _common.aggregations:WeightedAvgAggregate: + allOf: + - $ref: '#/components/schemas/_common.aggregations:SingleMetricAggregateBase' + - type: object + _common.analysis:Analyzer: + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/_common.analysis:CustomAnalyzer' + - $ref: '#/components/schemas/_common.analysis:FingerprintAnalyzer' + - $ref: '#/components/schemas/_common.analysis:KeywordAnalyzer' + - $ref: '#/components/schemas/_common.analysis:LanguageAnalyzer' + - $ref: '#/components/schemas/_common.analysis:NoriAnalyzer' + - $ref: '#/components/schemas/_common.analysis:PatternAnalyzer' + - $ref: '#/components/schemas/_common.analysis:SimpleAnalyzer' + - $ref: '#/components/schemas/_common.analysis:StandardAnalyzer' + - $ref: '#/components/schemas/_common.analysis:StopAnalyzer' + - $ref: '#/components/schemas/_common.analysis:WhitespaceAnalyzer' + - $ref: '#/components/schemas/_common.analysis:IcuAnalyzer' + - $ref: '#/components/schemas/_common.analysis:KuromojiAnalyzer' + - $ref: '#/components/schemas/_common.analysis:SnowballAnalyzer' + - $ref: '#/components/schemas/_common.analysis:DutchAnalyzer' + _common.analysis:AsciiFoldingTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - asciifolding + preserve_original: + $ref: '#/components/schemas/_common:Stringifiedboolean' + required: + - type + _common.analysis:CharFilter: + oneOf: + - type: string + - $ref: '#/components/schemas/_common.analysis:CharFilterDefinition' + _common.analysis:CharFilterBase: + type: object + properties: + version: + $ref: '#/components/schemas/_common:VersionString' + _common.analysis:CharFilterDefinition: + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/_common.analysis:HtmlStripCharFilter' + - $ref: '#/components/schemas/_common.analysis:MappingCharFilter' + - $ref: '#/components/schemas/_common.analysis:PatternReplaceCharFilter' + - $ref: '#/components/schemas/_common.analysis:IcuNormalizationCharFilter' + - $ref: '#/components/schemas/_common.analysis:KuromojiIterationMarkCharFilter' + _common.analysis:CharGroupTokenizer: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - char_group + tokenize_on_chars: + type: array + items: + type: string + max_token_length: + type: number + required: + - type + - tokenize_on_chars + _common.analysis:CommonGramsTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - common_grams + common_words: + type: array + items: + type: string + common_words_path: + type: string + ignore_case: + type: boolean + query_mode: + type: boolean + required: + - type + _common.analysis:CompoundWordTokenFilterBase: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + hyphenation_patterns_path: + type: string + max_subword_size: + type: number + min_subword_size: + type: number + min_word_size: + type: number + only_longest_match: + type: boolean + word_list: + type: array + items: + type: string + word_list_path: + type: string + _common.analysis:ConditionTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - condition + filter: + type: array + items: + type: string + script: + $ref: '#/components/schemas/_common:Script' + required: + - type + - filter + - script + _common.analysis:CustomAnalyzer: + type: object + properties: + type: + type: string + enum: + - custom + char_filter: + type: array + items: + type: string + filter: + type: array + items: + type: string + position_increment_gap: + type: number + position_offset_gap: + type: number + tokenizer: + type: string + required: + - type + - tokenizer + _common.analysis:CustomNormalizer: + type: object + properties: + type: + type: string + enum: + - custom + char_filter: + type: array + items: + type: string + filter: + type: array + items: + type: string + required: + - type + _common.analysis:DelimitedPayloadEncoding: + type: string + enum: + - int + - float + - identity + _common.analysis:DelimitedPayloadTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - delimited_payload + delimiter: + type: string + encoding: + $ref: '#/components/schemas/_common.analysis:DelimitedPayloadEncoding' + required: + - type + _common.analysis:DictionaryDecompounderTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:CompoundWordTokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - dictionary_decompounder + required: + - type + _common.analysis:DutchAnalyzer: + type: object + properties: + type: + type: string + enum: + - dutch + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' + required: + - type + _common.analysis:EdgeNGramSide: + type: string + enum: + - front + - back + _common.analysis:EdgeNGramTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - edge_ngram + max_gram: + type: number + min_gram: + type: number + side: + $ref: '#/components/schemas/_common.analysis:EdgeNGramSide' + preserve_original: + $ref: '#/components/schemas/_common:Stringifiedboolean' + required: + - type + _common.analysis:EdgeNGramTokenizer: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - edge_ngram + custom_token_chars: + type: string + max_gram: + type: number + min_gram: + type: number + token_chars: + type: array + items: + $ref: '#/components/schemas/_common.analysis:TokenChar' + required: + - type + - max_gram + - min_gram + - token_chars + _common.analysis:ElisionTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - elision + articles: + type: array + items: + type: string + articles_path: + type: string + articles_case: + $ref: '#/components/schemas/_common:Stringifiedboolean' + required: + - type + _common.analysis:FingerprintAnalyzer: + type: object + properties: + type: + type: string + enum: + - fingerprint + version: + $ref: '#/components/schemas/_common:VersionString' + max_output_size: + type: number + preserve_original: + type: boolean + separator: + type: string + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' + stopwords_path: + type: string + required: + - type + - max_output_size + - preserve_original + - separator + _common.analysis:FingerprintTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - fingerprint + max_output_size: + type: number + separator: + type: string + required: + - type + _common.analysis:HtmlStripCharFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:CharFilterBase' + - type: object + properties: + type: + type: string + enum: + - html_strip + required: + - type + _common.analysis:HunspellTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - hunspell + dedup: + type: boolean + dictionary: + type: string + locale: + type: string + longest_only: + type: boolean + required: + - type + - locale + _common.analysis:HyphenationDecompounderTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:CompoundWordTokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - hyphenation_decompounder + required: + - type + _common.analysis:IcuAnalyzer: + type: object + properties: + type: + type: string + enum: + - icu_analyzer + method: + $ref: '#/components/schemas/_common.analysis:IcuNormalizationType' + mode: + $ref: '#/components/schemas/_common.analysis:IcuNormalizationMode' + required: + - type + - method + - mode + _common.analysis:IcuCollationAlternate: + type: string + enum: + - shifted + - non-ignorable + _common.analysis:IcuCollationCaseFirst: + type: string + enum: + - lower + - upper + _common.analysis:IcuCollationDecomposition: + type: string + enum: + - no + - identical + _common.analysis:IcuCollationStrength: + type: string + enum: + - primary + - secondary + - tertiary + - quaternary + - identical + _common.analysis:IcuCollationTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - icu_collation + alternate: + $ref: '#/components/schemas/_common.analysis:IcuCollationAlternate' + caseFirst: + $ref: '#/components/schemas/_common.analysis:IcuCollationCaseFirst' + caseLevel: + type: boolean + country: + type: string + decomposition: + $ref: '#/components/schemas/_common.analysis:IcuCollationDecomposition' + hiraganaQuaternaryMode: + type: boolean + language: + type: string + numeric: + type: boolean + rules: + type: string + strength: + $ref: '#/components/schemas/_common.analysis:IcuCollationStrength' + variableTop: + type: string + variant: + type: string + required: + - type + _common.analysis:IcuFoldingTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - icu_folding + unicode_set_filter: + type: string + required: + - type + - unicode_set_filter + _common.analysis:IcuNormalizationCharFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:CharFilterBase' + - type: object + properties: + type: + type: string + enum: + - icu_normalizer + mode: + $ref: '#/components/schemas/_common.analysis:IcuNormalizationMode' + name: + $ref: '#/components/schemas/_common.analysis:IcuNormalizationType' + required: + - type + _common.analysis:IcuNormalizationMode: + type: string + enum: + - decompose + - compose + _common.analysis:IcuNormalizationTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - icu_normalizer + name: + $ref: '#/components/schemas/_common.analysis:IcuNormalizationType' + required: + - type + - name + _common.analysis:IcuNormalizationType: + type: string + enum: + - nfc + - nfkc + - nfkc_cf + _common.analysis:IcuTokenizer: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - icu_tokenizer + rule_files: + type: string + required: + - type + - rule_files + _common.analysis:IcuTransformDirection: + type: string + enum: + - forward + - reverse + _common.analysis:IcuTransformTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - icu_transform + dir: + $ref: '#/components/schemas/_common.analysis:IcuTransformDirection' + id: + type: string + required: + - type + - id + _common.analysis:KStemTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - kstem + required: + - type + _common.analysis:KeepTypesMode: + type: string + enum: + - include + - exclude + _common.analysis:KeepTypesTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - keep_types + mode: + $ref: '#/components/schemas/_common.analysis:KeepTypesMode' + types: + type: array + items: + type: string + required: + - type + _common.analysis:KeepWordsTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - keep + keep_words: + type: array + items: + type: string + keep_words_case: + type: boolean + keep_words_path: + type: string + required: + - type + _common.analysis:KeywordAnalyzer: + type: object + properties: + type: + type: string + enum: + - keyword + version: + $ref: '#/components/schemas/_common:VersionString' + required: + - type + _common.analysis:KeywordMarkerTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - keyword_marker + ignore_case: + type: boolean + keywords: + type: array + items: + type: string + keywords_path: + type: string + keywords_pattern: + type: string + required: + - type + _common.analysis:KeywordTokenizer: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - keyword + buffer_size: + type: number + required: + - type + - buffer_size + _common.analysis:KuromojiAnalyzer: + type: object + properties: + type: + type: string + enum: + - kuromoji + mode: + $ref: '#/components/schemas/_common.analysis:KuromojiTokenizationMode' + user_dictionary: + type: string + required: + - type + - mode + _common.analysis:KuromojiIterationMarkCharFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:CharFilterBase' + - type: object + properties: + type: + type: string + enum: + - kuromoji_iteration_mark + normalize_kana: + type: boolean + normalize_kanji: + type: boolean + required: + - type + - normalize_kana + - normalize_kanji + _common.analysis:KuromojiPartOfSpeechTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - kuromoji_part_of_speech + stoptags: + type: array + items: + type: string + required: + - type + - stoptags + _common.analysis:KuromojiReadingFormTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - kuromoji_readingform + use_romaji: + type: boolean + required: + - type + - use_romaji + _common.analysis:KuromojiStemmerTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - kuromoji_stemmer + minimum_length: + type: number + required: + - type + - minimum_length + _common.analysis:KuromojiTokenizationMode: + type: string + enum: + - normal + - search + - extended + _common.analysis:KuromojiTokenizer: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - kuromoji_tokenizer + discard_punctuation: + type: boolean + mode: + $ref: '#/components/schemas/_common.analysis:KuromojiTokenizationMode' + nbest_cost: + type: number + nbest_examples: + type: string + user_dictionary: + type: string + user_dictionary_rules: + type: array + items: + type: string + discard_compound_token: + type: boolean + required: + - type + - mode + _common.analysis:Language: + type: string + enum: + - 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 + _common.analysis:LanguageAnalyzer: + type: object + properties: + type: + type: string + enum: + - language + version: + $ref: '#/components/schemas/_common:VersionString' + language: + $ref: '#/components/schemas/_common.analysis:Language' + stem_exclusion: + type: array + items: + type: string + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' + stopwords_path: + type: string + required: + - type + - language + - stem_exclusion + _common.analysis:LengthTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - length + max: + type: number + min: + type: number + required: + - type + _common.analysis:LetterTokenizer: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - letter + required: + - type + _common.analysis:LimitTokenCountTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - limit + consume_all_tokens: + type: boolean + max_token_count: + $ref: '#/components/schemas/_common:Stringifiedinteger' + required: + - type + _common.analysis:LowercaseNormalizer: + type: object + properties: + type: + type: string + enum: + - lowercase + required: + - type + _common.analysis:LowercaseTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - lowercase + language: + type: string + required: + - type + _common.analysis:LowercaseTokenizer: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - lowercase + required: + - type + _common.analysis:MappingCharFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:CharFilterBase' + - type: object + properties: + type: + type: string + enum: + - mapping + mappings: + type: array + items: + type: string + mappings_path: + type: string + required: + - type + _common.analysis:MultiplexerTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - multiplexer + filters: + type: array + items: + type: string + preserve_original: + $ref: '#/components/schemas/_common:Stringifiedboolean' + required: + - type + - filters + _common.analysis:NGramTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - ngram + max_gram: + type: number + min_gram: + type: number + preserve_original: + $ref: '#/components/schemas/_common:Stringifiedboolean' + required: + - type + _common.analysis:NGramTokenizer: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - ngram + custom_token_chars: + type: string + max_gram: + type: number + min_gram: + type: number + token_chars: + type: array + items: + $ref: '#/components/schemas/_common.analysis:TokenChar' + required: + - type + - max_gram + - min_gram + - token_chars + _common.analysis:NoriAnalyzer: + type: object + properties: + type: + type: string + enum: + - nori + version: + $ref: '#/components/schemas/_common:VersionString' + decompound_mode: + $ref: '#/components/schemas/_common.analysis:NoriDecompoundMode' + stoptags: + type: array + items: + type: string + user_dictionary: + type: string + required: + - type + _common.analysis:NoriDecompoundMode: + type: string + enum: + - discard + - none + - mixed + _common.analysis:NoriPartOfSpeechTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - nori_part_of_speech + stoptags: + type: array + items: + type: string + required: + - type + _common.analysis:NoriTokenizer: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - nori_tokenizer + decompound_mode: + $ref: '#/components/schemas/_common.analysis:NoriDecompoundMode' + discard_punctuation: + type: boolean + user_dictionary: + type: string + user_dictionary_rules: + type: array + items: + type: string + required: + - type + _common.analysis:Normalizer: + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/_common.analysis:LowercaseNormalizer' + - $ref: '#/components/schemas/_common.analysis:CustomNormalizer' + _common.analysis:PathHierarchyTokenizer: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - path_hierarchy + buffer_size: + $ref: '#/components/schemas/_common:Stringifiedinteger' + delimiter: + type: string + replacement: + type: string + reverse: + $ref: '#/components/schemas/_common:Stringifiedboolean' + skip: + $ref: '#/components/schemas/_common:Stringifiedinteger' + required: + - type + - buffer_size + - delimiter + - reverse + - skip + _common.analysis:PatternAnalyzer: + type: object + properties: + type: + type: string + enum: + - pattern + version: + $ref: '#/components/schemas/_common:VersionString' + flags: + type: string + lowercase: + type: boolean + pattern: + type: string + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' + required: + - type + - pattern + _common.analysis:PatternCaptureTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - pattern_capture + patterns: + type: array + items: + type: string + preserve_original: + $ref: '#/components/schemas/_common:Stringifiedboolean' + required: + - type + - patterns + _common.analysis:PatternReplaceCharFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:CharFilterBase' + - type: object + properties: + type: + type: string + enum: + - pattern_replace + flags: + type: string + pattern: + type: string + replacement: + type: string + required: + - type + - pattern + _common.analysis:PatternReplaceTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - pattern_replace + all: + type: boolean + flags: + type: string + pattern: + type: string + replacement: + type: string + required: + - type + - pattern + _common.analysis:PatternTokenizer: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - pattern + flags: + type: string + group: + type: number + pattern: + type: string + required: + - type + _common.analysis:PhoneticEncoder: + type: string + enum: + - metaphone + - double_metaphone + - soundex + - refined_soundex + - caverphone1 + - caverphone2 + - cologne + - nysiis + - koelnerphonetik + - haasephonetik + - beider_morse + - daitch_mokotoff + _common.analysis:PhoneticLanguage: + type: string + enum: + - any + - common + - cyrillic + - english + - french + - german + - hebrew + - hungarian + - polish + - romanian + - russian + - spanish + _common.analysis:PhoneticNameType: + type: string + enum: + - generic + - ashkenazi + - sephardic + _common.analysis:PhoneticRuleType: + type: string + enum: + - approx + - exact + _common.analysis:PhoneticTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - phonetic + encoder: + $ref: '#/components/schemas/_common.analysis:PhoneticEncoder' + languageset: + type: array + items: + $ref: '#/components/schemas/_common.analysis:PhoneticLanguage' + max_code_len: + type: number + name_type: + $ref: '#/components/schemas/_common.analysis:PhoneticNameType' + replace: + type: boolean + rule_type: + $ref: '#/components/schemas/_common.analysis:PhoneticRuleType' + required: + - type + - encoder + - languageset + - name_type + - rule_type + _common.analysis:PorterStemTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - porter_stem + required: + - type + _common.analysis:PredicateTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - predicate_token_filter + script: + $ref: '#/components/schemas/_common:Script' + required: + - type + - script + _common.analysis:RemoveDuplicatesTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - remove_duplicates + required: + - type + _common.analysis:ReverseTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - reverse + required: + - type + _common.analysis:ShingleTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - shingle + filler_token: + type: string + max_shingle_size: + oneOf: + - type: number + - type: string + min_shingle_size: + oneOf: + - type: number + - type: string + output_unigrams: + type: boolean + output_unigrams_if_no_shingles: + type: boolean + token_separator: + type: string + required: + - type + _common.analysis:SimpleAnalyzer: + type: object + properties: + type: + type: string + enum: + - simple + version: + $ref: '#/components/schemas/_common:VersionString' + required: + - type + _common.analysis:SnowballAnalyzer: + type: object + properties: + type: + type: string + enum: + - snowball + version: + $ref: '#/components/schemas/_common:VersionString' + language: + $ref: '#/components/schemas/_common.analysis:SnowballLanguage' + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' + required: + - type + - language + _common.analysis:SnowballLanguage: + type: string + enum: + - Armenian + - Basque + - Catalan + - Danish + - Dutch + - English + - Finnish + - French + - German + - German2 + - Hungarian + - Italian + - Kp + - Lovins + - Norwegian + - Porter + - Portuguese + - Romanian + - Russian + - Spanish + - Swedish + - Turkish + _common.analysis:SnowballTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - snowball + language: + $ref: '#/components/schemas/_common.analysis:SnowballLanguage' + required: + - type + - language + _common.analysis:StandardAnalyzer: + type: object + properties: + type: + type: string + enum: + - standard + max_token_length: + type: number + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' + required: + - type + _common.analysis:StandardTokenizer: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - standard + max_token_length: + type: number + required: + - type + _common.analysis:StemmerOverrideTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - stemmer_override + rules: + type: array + items: + type: string + rules_path: + type: string + required: + - type + _common.analysis:StemmerTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - stemmer + language: + type: string + required: + - type + _common.analysis:StopAnalyzer: + type: object + properties: + type: + type: string + enum: + - stop + version: + $ref: '#/components/schemas/_common:VersionString' + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' + stopwords_path: + type: string + required: + - type + _common.analysis:StopTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - stop + ignore_case: + type: boolean + remove_trailing: + type: boolean + stopwords: + $ref: '#/components/schemas/_common.analysis:StopWords' + stopwords_path: + type: string + required: + - type + _common.analysis:StopWords: + description: |- + Language value, such as _arabic_ or _thai_. Defaults to _english_. + Each 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. + Also accepts an array of stop words. + oneOf: + - type: string + - type: array + items: + type: string + _common.analysis:SynonymFormat: + type: string + enum: + - solr + - wordnet + _common.analysis:SynonymGraphTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - synonym_graph + expand: + type: boolean + format: + $ref: '#/components/schemas/_common.analysis:SynonymFormat' + lenient: + type: boolean + synonyms: + type: array + items: + type: string + synonyms_path: + type: string + tokenizer: + type: string + updateable: + type: boolean + required: + - type + _common.analysis:SynonymTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - synonym + expand: + type: boolean + format: + $ref: '#/components/schemas/_common.analysis:SynonymFormat' + lenient: + type: boolean + synonyms: + type: array + items: + type: string + synonyms_path: + type: string + tokenizer: + type: string + updateable: + type: boolean + required: + - type + _common.analysis:TokenChar: + type: string + enum: + - letter + - digit + - whitespace + - punctuation + - symbol + - custom + _common.analysis:TokenFilter: + oneOf: + - type: string + - $ref: '#/components/schemas/_common.analysis:TokenFilterDefinition' + _common.analysis:TokenFilterBase: + type: object + properties: + version: + $ref: '#/components/schemas/_common:VersionString' + _common.analysis:TokenFilterDefinition: + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/_common.analysis:AsciiFoldingTokenFilter' + - $ref: '#/components/schemas/_common.analysis:CommonGramsTokenFilter' + - $ref: '#/components/schemas/_common.analysis:ConditionTokenFilter' + - $ref: '#/components/schemas/_common.analysis:DelimitedPayloadTokenFilter' + - $ref: '#/components/schemas/_common.analysis:EdgeNGramTokenFilter' + - $ref: '#/components/schemas/_common.analysis:ElisionTokenFilter' + - $ref: '#/components/schemas/_common.analysis:FingerprintTokenFilter' + - $ref: '#/components/schemas/_common.analysis:HunspellTokenFilter' + - $ref: '#/components/schemas/_common.analysis:HyphenationDecompounderTokenFilter' + - $ref: '#/components/schemas/_common.analysis:KeepTypesTokenFilter' + - $ref: '#/components/schemas/_common.analysis:KeepWordsTokenFilter' + - $ref: '#/components/schemas/_common.analysis:KeywordMarkerTokenFilter' + - $ref: '#/components/schemas/_common.analysis:KStemTokenFilter' + - $ref: '#/components/schemas/_common.analysis:LengthTokenFilter' + - $ref: '#/components/schemas/_common.analysis:LimitTokenCountTokenFilter' + - $ref: '#/components/schemas/_common.analysis:LowercaseTokenFilter' + - $ref: '#/components/schemas/_common.analysis:MultiplexerTokenFilter' + - $ref: '#/components/schemas/_common.analysis:NGramTokenFilter' + - $ref: '#/components/schemas/_common.analysis:NoriPartOfSpeechTokenFilter' + - $ref: '#/components/schemas/_common.analysis:PatternCaptureTokenFilter' + - $ref: '#/components/schemas/_common.analysis:PatternReplaceTokenFilter' + - $ref: '#/components/schemas/_common.analysis:PorterStemTokenFilter' + - $ref: '#/components/schemas/_common.analysis:PredicateTokenFilter' + - $ref: '#/components/schemas/_common.analysis:RemoveDuplicatesTokenFilter' + - $ref: '#/components/schemas/_common.analysis:ReverseTokenFilter' + - $ref: '#/components/schemas/_common.analysis:ShingleTokenFilter' + - $ref: '#/components/schemas/_common.analysis:SnowballTokenFilter' + - $ref: '#/components/schemas/_common.analysis:StemmerOverrideTokenFilter' + - $ref: '#/components/schemas/_common.analysis:StemmerTokenFilter' + - $ref: '#/components/schemas/_common.analysis:StopTokenFilter' + - $ref: '#/components/schemas/_common.analysis:SynonymGraphTokenFilter' + - $ref: '#/components/schemas/_common.analysis:SynonymTokenFilter' + - $ref: '#/components/schemas/_common.analysis:TrimTokenFilter' + - $ref: '#/components/schemas/_common.analysis:TruncateTokenFilter' + - $ref: '#/components/schemas/_common.analysis:UniqueTokenFilter' + - $ref: '#/components/schemas/_common.analysis:UppercaseTokenFilter' + - $ref: '#/components/schemas/_common.analysis:WordDelimiterGraphTokenFilter' + - $ref: '#/components/schemas/_common.analysis:WordDelimiterTokenFilter' + - $ref: '#/components/schemas/_common.analysis:KuromojiStemmerTokenFilter' + - $ref: '#/components/schemas/_common.analysis:KuromojiReadingFormTokenFilter' + - $ref: '#/components/schemas/_common.analysis:KuromojiPartOfSpeechTokenFilter' + - $ref: '#/components/schemas/_common.analysis:IcuTokenizer' + - $ref: '#/components/schemas/_common.analysis:IcuCollationTokenFilter' + - $ref: '#/components/schemas/_common.analysis:IcuFoldingTokenFilter' + - $ref: '#/components/schemas/_common.analysis:IcuNormalizationTokenFilter' + - $ref: '#/components/schemas/_common.analysis:IcuTransformTokenFilter' + - $ref: '#/components/schemas/_common.analysis:PhoneticTokenFilter' + - $ref: '#/components/schemas/_common.analysis:DictionaryDecompounderTokenFilter' + _common.analysis:Tokenizer: + oneOf: + - type: string + - $ref: '#/components/schemas/_common.analysis:TokenizerDefinition' + _common.analysis:TokenizerBase: + type: object + properties: + version: + $ref: '#/components/schemas/_common:VersionString' + _common.analysis:TokenizerDefinition: + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/_common.analysis:CharGroupTokenizer' + - $ref: '#/components/schemas/_common.analysis:EdgeNGramTokenizer' + - $ref: '#/components/schemas/_common.analysis:KeywordTokenizer' + - $ref: '#/components/schemas/_common.analysis:LetterTokenizer' + - $ref: '#/components/schemas/_common.analysis:LowercaseTokenizer' + - $ref: '#/components/schemas/_common.analysis:NGramTokenizer' + - $ref: '#/components/schemas/_common.analysis:NoriTokenizer' + - $ref: '#/components/schemas/_common.analysis:PathHierarchyTokenizer' + - $ref: '#/components/schemas/_common.analysis:StandardTokenizer' + - $ref: '#/components/schemas/_common.analysis:UaxEmailUrlTokenizer' + - $ref: '#/components/schemas/_common.analysis:WhitespaceTokenizer' + - $ref: '#/components/schemas/_common.analysis:KuromojiTokenizer' + - $ref: '#/components/schemas/_common.analysis:PatternTokenizer' + - $ref: '#/components/schemas/_common.analysis:IcuTokenizer' + _common.analysis:TrimTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - trim + required: + - type + _common.analysis:TruncateTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - truncate + length: + type: number + required: + - type + _common.analysis:UaxEmailUrlTokenizer: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - uax_url_email + max_token_length: + type: number + required: + - type + _common.analysis:UniqueTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - unique + only_on_same_position: + type: boolean + required: + - type + _common.analysis:UppercaseTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - uppercase + required: + - type + _common.analysis:WhitespaceAnalyzer: + type: object + properties: + type: + type: string + enum: + - whitespace + version: + $ref: '#/components/schemas/_common:VersionString' + required: + - type + _common.analysis:WhitespaceTokenizer: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - whitespace + max_token_length: + type: number + required: + - type + _common.analysis:WordDelimiterGraphTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - word_delimiter_graph + adjust_offsets: + type: boolean + catenate_all: + type: boolean + catenate_numbers: + type: boolean + catenate_words: + type: boolean + generate_number_parts: + type: boolean + generate_word_parts: + type: boolean + ignore_keywords: + type: boolean + preserve_original: + $ref: '#/components/schemas/_common:Stringifiedboolean' + protected_words: + type: array + items: + type: string + protected_words_path: + type: string + split_on_case_change: + type: boolean + split_on_numerics: + type: boolean + stem_english_possessive: + type: boolean + type_table: + type: array + items: + type: string + type_table_path: + type: string + required: + - type + _common.analysis:WordDelimiterTokenFilter: + allOf: + - $ref: '#/components/schemas/_common.analysis:TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - word_delimiter + catenate_all: + type: boolean + catenate_numbers: + type: boolean + catenate_words: + type: boolean + generate_number_parts: + type: boolean + generate_word_parts: + type: boolean + preserve_original: + $ref: '#/components/schemas/_common:Stringifiedboolean' + protected_words: + type: array + items: + type: string + protected_words_path: + type: string + split_on_case_change: + type: boolean + split_on_numerics: + type: boolean + stem_english_possessive: + type: boolean + type_table: + type: array + items: + type: string + type_table_path: + type: string + required: + - type + _common.mapping:AggregateMetricDoubleProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + type: + type: string + enum: + - aggregate_metric_double + default_metric: + type: string + metrics: + type: array + items: + type: string + time_series_metric: + $ref: '#/components/schemas/_common.mapping:TimeSeriesMetricType' + required: + - type + - default_metric + - metrics + _common.mapping:AllField: + type: object + properties: + analyzer: + type: string + enabled: + type: boolean + omit_norms: + type: boolean + search_analyzer: + type: string + similarity: + type: string + store: + type: boolean + store_term_vector_offsets: + type: boolean + store_term_vector_payloads: + type: boolean + store_term_vector_positions: + type: boolean + store_term_vectors: + type: boolean + required: + - analyzer + - enabled + - omit_norms + - search_analyzer + - similarity + - store + - store_term_vector_offsets + - store_term_vector_payloads + - store_term_vector_positions + - store_term_vectors + _common.mapping:BinaryProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + type: + type: string + enum: + - binary + required: + - type + _common.mapping:BooleanProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + boost: + type: number + fielddata: + $ref: '#/components/schemas/indices._common:NumericFielddata' + index: + type: boolean + null_value: + type: boolean + type: + type: string + enum: + - boolean + required: + - type + _common.mapping:ByteNumberProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - byte + null_value: + $ref: '#/components/schemas/_common:byte' + required: + - type + _common.mapping:CompletionProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + analyzer: + type: string + contexts: + type: array + items: + $ref: '#/components/schemas/_common.mapping:SuggestContext' + max_input_length: + type: number + preserve_position_increments: + type: boolean + preserve_separators: + type: boolean + search_analyzer: + type: string + type: + type: string + enum: + - completion + required: + - type + _common.mapping:ConstantKeywordProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + value: + type: object + type: + type: string + enum: + - constant_keyword + required: + - type + _common.mapping:CorePropertyBase: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + copy_to: + $ref: '#/components/schemas/_common:Fields' + similarity: + type: string + store: + type: boolean + _common.mapping:DataStreamTimestamp: + type: object + properties: + enabled: + type: boolean + required: + - enabled + _common.mapping:DateNanosProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + boost: + type: number + format: + type: string + ignore_malformed: + type: boolean + index: + type: boolean + null_value: + $ref: '#/components/schemas/_common:DateTime' + precision_step: + type: number + type: + type: string + enum: + - date_nanos + required: + - type + _common.mapping:DateProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + boost: + type: number + fielddata: + $ref: '#/components/schemas/indices._common:NumericFielddata' + format: + type: string + ignore_malformed: + type: boolean + index: + type: boolean + null_value: + $ref: '#/components/schemas/_common:DateTime' + precision_step: + type: number + locale: + type: string + type: + type: string + enum: + - date + required: + - type + _common.mapping:DateRangeProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - type: object + properties: + format: + type: string + type: + type: string + enum: + - date_range + required: + - type + _common.mapping:DenseVectorIndexOptions: + type: object + properties: + type: + type: string + m: + type: number + ef_construction: + type: number + required: + - type + - m + - ef_construction + _common.mapping:DenseVectorProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + type: + type: string + enum: + - dense_vector + dims: + type: number + similarity: + type: string + index: + type: boolean + index_options: + $ref: '#/components/schemas/_common.mapping:DenseVectorIndexOptions' + required: + - type + - dims + _common.mapping:DocValuesPropertyBase: + allOf: + - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' + - type: object + properties: + doc_values: + type: boolean + _common.mapping:DoubleNumberProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - double + null_value: + type: number + required: + - type + _common.mapping:DoubleRangeProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - type: object + properties: + type: + type: string + enum: + - double_range + required: + - type + _common.mapping:DynamicMapping: + type: string + enum: + - strict + - runtime + - 'true' + - 'false' + _common.mapping:DynamicProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + type: + type: string + enum: + - '{dynamic_property}' + enabled: + type: boolean + null_value: + $ref: '#/components/schemas/_common:FieldValue' + boost: + type: number + coerce: + type: boolean + script: + $ref: '#/components/schemas/_common:Script' + on_script_error: + $ref: '#/components/schemas/_common.mapping:OnScriptError' + ignore_malformed: + type: boolean + time_series_metric: + $ref: '#/components/schemas/_common.mapping:TimeSeriesMetricType' + analyzer: + type: string + eager_global_ordinals: + type: boolean + index: + type: boolean + index_options: + $ref: '#/components/schemas/_common.mapping:IndexOptions' + index_phrases: + type: boolean + index_prefixes: + $ref: '#/components/schemas/_common.mapping:TextIndexPrefixes' + norms: + type: boolean + position_increment_gap: + type: number + search_analyzer: + type: string + search_quote_analyzer: + type: string + term_vector: + $ref: '#/components/schemas/_common.mapping:TermVectorOption' + format: + type: string + precision_step: + type: number + locale: + type: string + required: + - type + _common.mapping:DynamicTemplate: + type: object + properties: + mapping: + $ref: '#/components/schemas/_common.mapping:Property' + match: + type: string + match_mapping_type: + type: string + match_pattern: + $ref: '#/components/schemas/_common.mapping:MatchType' + path_match: + type: string + path_unmatch: + type: string + unmatch: + type: string + _common.mapping:FieldAliasProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + path: + $ref: '#/components/schemas/_common:Field' + type: + type: string + enum: + - alias + required: + - type + _common.mapping:FieldMapping: + type: object + properties: + full_name: + type: string + mapping: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:Property' + minProperties: 1 + maxProperties: 1 + required: + - full_name + - mapping + _common.mapping:FieldNamesField: + type: object + properties: + enabled: + type: boolean + required: + - enabled + _common.mapping:FlattenedProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + boost: + type: number + depth_limit: + type: number + doc_values: + type: boolean + eager_global_ordinals: + type: boolean + index: + type: boolean + index_options: + $ref: '#/components/schemas/_common.mapping:IndexOptions' + null_value: + type: string + similarity: + type: string + split_queries_on_whitespace: + type: boolean + type: + type: string + enum: + - flattened + required: + - type + _common.mapping:FloatNumberProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - float + null_value: + type: number + required: + - type + _common.mapping:FloatRangeProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - type: object + properties: + type: + type: string + enum: + - float_range + required: + - type + _common.mapping:GeoOrientation: + type: string + enum: + - right + - left + _common.mapping:GeoPointProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + ignore_malformed: + type: boolean + ignore_z_value: + type: boolean + null_value: + $ref: '#/components/schemas/_common:GeoLocation' + type: + type: string + enum: + - geo_point + required: + - type + _common.mapping:GeoShapeProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + coerce: + type: boolean + ignore_malformed: + type: boolean + ignore_z_value: + type: boolean + orientation: + $ref: '#/components/schemas/_common.mapping:GeoOrientation' + strategy: + $ref: '#/components/schemas/_common.mapping:GeoStrategy' + type: + type: string + enum: + - geo_shape + required: + - type + _common.mapping:GeoStrategy: + type: string + enum: + - recursive + - term + _common.mapping:HalfFloatNumberProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - half_float + null_value: + type: number + required: + - type + _common.mapping:HistogramProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + ignore_malformed: + type: boolean + type: + type: string + enum: + - histogram + required: + - type + _common.mapping:IndexField: + type: object + properties: + enabled: + type: boolean + required: + - enabled + _common.mapping:IndexOptions: + type: string + enum: + - docs + - freqs + - positions + - offsets + _common.mapping:IntegerNumberProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - integer + null_value: + type: number + required: + - type + _common.mapping:IntegerRangeProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - type: object + properties: + type: + type: string + enum: + - integer_range + required: + - type + _common.mapping:IpProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + boost: + type: number + index: + type: boolean + ignore_malformed: + type: boolean + null_value: + type: string + on_script_error: + $ref: '#/components/schemas/_common.mapping:OnScriptError' + script: + $ref: '#/components/schemas/_common:Script' + time_series_dimension: + description: For internal use by Opensearch only. Marks the field as a time series dimension. Defaults to false. + type: boolean + type: + type: string + enum: + - ip + required: + - type + _common.mapping:IpRangeProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - type: object + properties: + type: + type: string + enum: + - ip_range + required: + - type + _common.mapping:JoinProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + relations: + type: object + additionalProperties: + oneOf: + - $ref: '#/components/schemas/_common:RelationName' + - type: array + items: + $ref: '#/components/schemas/_common:RelationName' + eager_global_ordinals: + type: boolean + type: + type: string + enum: + - join + required: + - type + _common.mapping:KeywordProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + boost: + type: number + eager_global_ordinals: + type: boolean + index: + type: boolean + index_options: + $ref: '#/components/schemas/_common.mapping:IndexOptions' + normalizer: + type: string + norms: + type: boolean + null_value: + type: string + split_queries_on_whitespace: + type: boolean + time_series_dimension: + description: For internal use by Opensearch only. Marks the field as a time series dimension. Defaults to false. + type: boolean + type: + type: string + enum: + - keyword + required: + - type + _common.mapping:LongNumberProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - long + null_value: + type: number + required: + - type + _common.mapping:LongRangeProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:RangePropertyBase' + - type: object + properties: + type: + type: string + enum: + - long_range + required: + - type + _common.mapping:MatchOnlyTextProperty: + type: object + properties: + type: + type: string + enum: + - match_only_text + fields: + description: |- + 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. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:Property' + meta: + description: Metadata about the field. + type: object + additionalProperties: + type: string + copy_to: + $ref: '#/components/schemas/_common:Fields' + required: + - type + _common.mapping:MatchType: + type: string + enum: + - simple + - regex + _common.mapping:Murmur3HashProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + type: + type: string + enum: + - murmur3 + required: + - type + _common.mapping:NestedProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' + - type: object + properties: + enabled: + type: boolean + include_in_parent: + type: boolean + include_in_root: + type: boolean + type: + type: string + enum: + - nested + required: + - type + _common.mapping:NumberPropertyBase: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + boost: + type: number + coerce: + type: boolean + ignore_malformed: + type: boolean + index: + type: boolean + on_script_error: + $ref: '#/components/schemas/_common.mapping:OnScriptError' + script: + $ref: '#/components/schemas/_common:Script' + time_series_metric: + $ref: '#/components/schemas/_common.mapping:TimeSeriesMetricType' + time_series_dimension: + description: For internal use by Opensearch only. Marks the field as a time series dimension. Defaults to false. + type: boolean + _common.mapping:ObjectProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' + - type: object + properties: + enabled: + type: boolean + type: + type: string + enum: + - object + _common.mapping:OnScriptError: + type: string + enum: + - fail + - continue + _common.mapping:PercolatorProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + type: + type: string + enum: + - percolator + required: + - type + _common.mapping:PointProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + ignore_malformed: + type: boolean + ignore_z_value: + type: boolean + null_value: + type: string + type: + type: string + enum: + - point + required: + - type + _common.mapping:Property: + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/_common.mapping:BinaryProperty' + - $ref: '#/components/schemas/_common.mapping:BooleanProperty' + - $ref: '#/components/schemas/_common.mapping:DynamicProperty' + - $ref: '#/components/schemas/_common.mapping:JoinProperty' + - $ref: '#/components/schemas/_common.mapping:KeywordProperty' + - $ref: '#/components/schemas/_common.mapping:MatchOnlyTextProperty' + - $ref: '#/components/schemas/_common.mapping:PercolatorProperty' + - $ref: '#/components/schemas/_common.mapping:RankFeatureProperty' + - $ref: '#/components/schemas/_common.mapping:RankFeaturesProperty' + - $ref: '#/components/schemas/_common.mapping:SearchAsYouTypeProperty' + - $ref: '#/components/schemas/_common.mapping:TextProperty' + - $ref: '#/components/schemas/_common.mapping:VersionProperty' + - $ref: '#/components/schemas/_common.mapping:WildcardProperty' + - $ref: '#/components/schemas/_common.mapping:DateNanosProperty' + - $ref: '#/components/schemas/_common.mapping:DateProperty' + - $ref: '#/components/schemas/_common.mapping:AggregateMetricDoubleProperty' + - $ref: '#/components/schemas/_common.mapping:DenseVectorProperty' + - $ref: '#/components/schemas/_common.mapping:SparseVectorProperty' + - $ref: '#/components/schemas/_common.mapping:FlattenedProperty' + - $ref: '#/components/schemas/_common.mapping:NestedProperty' + - $ref: '#/components/schemas/_common.mapping:ObjectProperty' + - $ref: '#/components/schemas/_common.mapping:CompletionProperty' + - $ref: '#/components/schemas/_common.mapping:ConstantKeywordProperty' + - $ref: '#/components/schemas/_common.mapping:FieldAliasProperty' + - $ref: '#/components/schemas/_common.mapping:HistogramProperty' + - $ref: '#/components/schemas/_common.mapping:IpProperty' + - $ref: '#/components/schemas/_common.mapping:Murmur3HashProperty' + - $ref: '#/components/schemas/_common.mapping:TokenCountProperty' + - $ref: '#/components/schemas/_common.mapping:GeoPointProperty' + - $ref: '#/components/schemas/_common.mapping:GeoShapeProperty' + - $ref: '#/components/schemas/_common.mapping:PointProperty' + - $ref: '#/components/schemas/_common.mapping:ShapeProperty' + - $ref: '#/components/schemas/_common.mapping:ByteNumberProperty' + - $ref: '#/components/schemas/_common.mapping:DoubleNumberProperty' + - $ref: '#/components/schemas/_common.mapping:FloatNumberProperty' + - $ref: '#/components/schemas/_common.mapping:HalfFloatNumberProperty' + - $ref: '#/components/schemas/_common.mapping:IntegerNumberProperty' + - $ref: '#/components/schemas/_common.mapping:LongNumberProperty' + - $ref: '#/components/schemas/_common.mapping:ScaledFloatNumberProperty' + - $ref: '#/components/schemas/_common.mapping:ShortNumberProperty' + - $ref: '#/components/schemas/_common.mapping:UnsignedLongNumberProperty' + - $ref: '#/components/schemas/_common.mapping:DateRangeProperty' + - $ref: '#/components/schemas/_common.mapping:DoubleRangeProperty' + - $ref: '#/components/schemas/_common.mapping:FloatRangeProperty' + - $ref: '#/components/schemas/_common.mapping:IntegerRangeProperty' + - $ref: '#/components/schemas/_common.mapping:IpRangeProperty' + - $ref: '#/components/schemas/_common.mapping:LongRangeProperty' + _common.mapping:PropertyBase: + type: object + properties: + meta: + description: Metadata about the field. + type: object + additionalProperties: + type: string + properties: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:Property' + ignore_above: + type: number + dynamic: + $ref: '#/components/schemas/_common.mapping:DynamicMapping' + fields: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:Property' + _common.mapping:RangePropertyBase: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + boost: + type: number + coerce: + type: boolean + index: + type: boolean + _common.mapping:RankFeatureProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + positive_score_impact: + type: boolean + type: + type: string + enum: + - rank_feature + required: + - type + _common.mapping:RankFeaturesProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + type: + type: string + enum: + - rank_features + required: + - type + _common.mapping:RoutingField: + type: object + properties: + required: + type: boolean + required: + - required + _common.mapping:RuntimeField: + type: object + properties: + fetch_fields: + description: For type `lookup` + type: array + items: + $ref: '#/components/schemas/_common.mapping:RuntimeFieldFetchFields' + format: + description: A custom format for `date` type runtime fields. + type: string + input_field: + $ref: '#/components/schemas/_common:Field' + target_field: + $ref: '#/components/schemas/_common:Field' + target_index: + $ref: '#/components/schemas/_common:IndexName' + script: + $ref: '#/components/schemas/_common:Script' + type: + $ref: '#/components/schemas/_common.mapping:RuntimeFieldType' + required: + - type + _common.mapping:RuntimeFieldFetchFields: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + format: + type: string + required: + - field + _common.mapping:RuntimeFieldType: + type: string + enum: + - boolean + - date + - double + - geo_point + - ip + - keyword + - long + - lookup + _common.mapping:RuntimeFields: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:RuntimeField' + _common.mapping:ScaledFloatNumberProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - scaled_float + null_value: + type: number + scaling_factor: + type: number + required: + - type + _common.mapping:SearchAsYouTypeProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' + - type: object + properties: + analyzer: + type: string + index: + type: boolean + index_options: + $ref: '#/components/schemas/_common.mapping:IndexOptions' + max_shingle_size: + type: number + norms: + type: boolean + search_analyzer: + type: string + search_quote_analyzer: + type: string + term_vector: + $ref: '#/components/schemas/_common.mapping:TermVectorOption' + type: + type: string + enum: + - search_as_you_type + required: + - type + _common.mapping:ShapeProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + coerce: + type: boolean + ignore_malformed: + type: boolean + ignore_z_value: + type: boolean + orientation: + $ref: '#/components/schemas/_common.mapping:GeoOrientation' + type: + type: string + enum: + - shape + required: + - type + _common.mapping:ShortNumberProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - short + null_value: + $ref: '#/components/schemas/_common:short' + required: + - type + _common.mapping:SizeField: + type: object + properties: + enabled: + type: boolean + required: + - enabled + _common.mapping:SourceField: + type: object + properties: + compress: + type: boolean + compress_threshold: + type: string + enabled: + type: boolean + excludes: + type: array + items: + type: string + includes: + type: array + items: + type: string + mode: + $ref: '#/components/schemas/_common.mapping:SourceFieldMode' + _common.mapping:SourceFieldMode: + type: string + enum: + - disabled + - stored + - synthetic + _common.mapping:SparseVectorProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:PropertyBase' + - type: object + properties: + type: + type: string + enum: + - sparse_vector + required: + - type + _common.mapping:SuggestContext: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + path: + $ref: '#/components/schemas/_common:Field' + type: + type: string + precision: + oneOf: + - type: number + - type: string + required: + - name + - type + _common.mapping:TermVectorOption: + type: string + enum: + - no + - yes + - with_offsets + - with_positions + - with_positions_offsets + - with_positions_offsets_payloads + - with_positions_payloads + _common.mapping:TextIndexPrefixes: + type: object + properties: + max_chars: + type: number + min_chars: + type: number + required: + - max_chars + - min_chars + _common.mapping:TextProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:CorePropertyBase' + - type: object + properties: + analyzer: + type: string + boost: + type: number + eager_global_ordinals: + type: boolean + fielddata: + type: boolean + fielddata_frequency_filter: + $ref: '#/components/schemas/indices._common:FielddataFrequencyFilter' + index: + type: boolean + index_options: + $ref: '#/components/schemas/_common.mapping:IndexOptions' + index_phrases: + type: boolean + index_prefixes: + $ref: '#/components/schemas/_common.mapping:TextIndexPrefixes' + norms: + type: boolean + position_increment_gap: + type: number + search_analyzer: + type: string + search_quote_analyzer: + type: string + term_vector: + $ref: '#/components/schemas/_common.mapping:TermVectorOption' + type: + type: string + enum: + - text + required: + - type + _common.mapping:TimeSeriesMetricType: + type: string + enum: + - gauge + - counter + - summary + - histogram + - position + _common.mapping:TokenCountProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + analyzer: + type: string + boost: + type: number + index: + type: boolean + null_value: + type: number + enable_position_increments: + type: boolean + type: + type: string + enum: + - token_count + required: + - type + _common.mapping:TypeMapping: + type: object + properties: + all_field: + $ref: '#/components/schemas/_common.mapping:AllField' + date_detection: + type: boolean + dynamic: + $ref: '#/components/schemas/_common.mapping:DynamicMapping' + dynamic_date_formats: + type: array + items: + type: string + dynamic_templates: + type: array + items: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:DynamicTemplate' + _field_names: + $ref: '#/components/schemas/_common.mapping:FieldNamesField' + index_field: + $ref: '#/components/schemas/_common.mapping:IndexField' + _meta: + $ref: '#/components/schemas/_common:Metadata' + numeric_detection: + type: boolean + properties: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:Property' + _routing: + $ref: '#/components/schemas/_common.mapping:RoutingField' + _size: + $ref: '#/components/schemas/_common.mapping:SizeField' + _source: + $ref: '#/components/schemas/_common.mapping:SourceField' + runtime: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:RuntimeField' + enabled: + type: boolean + _data_stream_timestamp: + $ref: '#/components/schemas/_common.mapping:DataStreamTimestamp' + _common.mapping:UnsignedLongNumberProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - unsigned_long + null_value: + $ref: '#/components/schemas/_common:ulong' + required: + - type + _common.mapping:VersionProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + type: + type: string + enum: + - version + required: + - type + _common.mapping:WildcardProperty: + allOf: + - $ref: '#/components/schemas/_common.mapping:DocValuesPropertyBase' + - type: object + properties: + type: + type: string + enum: + - wildcard + null_value: + type: string + required: + - type + _common.query_dsl:BoolQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + filter: + description: |- + The clause (query) must appear in matching documents. + However, unlike `must`, the score of the query will be ignored. + oneOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + - type: array + items: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + minimum_should_match: + $ref: '#/components/schemas/_common:MinimumShouldMatch' + must: + description: The clause (query) must appear in matching documents and will contribute to the score. + oneOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + - type: array + items: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + must_not: + description: |- + The clause (query) must not appear in the matching documents. + Because scoring is ignored, a score of `0` is returned for all documents. + oneOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + - type: array + items: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + should: + description: The clause (query) should appear in the matching document. + oneOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + - type: array + items: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + _common.query_dsl:BoostingQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + negative_boost: + description: Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query. + type: number + negative: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + positive: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + required: + - negative_boost + - negative + - positive + _common.query_dsl:ChildScoreMode: + type: string + enum: + - none + - avg + - sum + - max + - min + _common.query_dsl:CombinedFieldsOperator: + type: string + enum: + - or + - and + _common.query_dsl:CombinedFieldsQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + fields: + description: List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`. + type: array + items: + $ref: '#/components/schemas/_common:Field' + query: + description: |- + Text to search for in the provided `fields`. + The `combined_fields` query analyzes the provided text before performing a search. + type: string + auto_generate_synonyms_phrase_query: + description: If true, match phrase queries are automatically created for multi-term synonyms. + type: boolean + operator: + $ref: '#/components/schemas/_common.query_dsl:CombinedFieldsOperator' + minimum_should_match: + $ref: '#/components/schemas/_common:MinimumShouldMatch' + zero_terms_query: + $ref: '#/components/schemas/_common.query_dsl:CombinedFieldsZeroTerms' + required: + - fields + - query + _common.query_dsl:CombinedFieldsZeroTerms: + type: string + enum: + - none + - all + _common.query_dsl:CommonTermsQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + analyzer: + type: string + cutoff_frequency: + type: number + high_freq_operator: + $ref: '#/components/schemas/_common.query_dsl:Operator' + low_freq_operator: + $ref: '#/components/schemas/_common.query_dsl:Operator' + minimum_should_match: + $ref: '#/components/schemas/_common:MinimumShouldMatch' + query: + type: string + required: + - query + _common.query_dsl:ConstantScoreQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + required: + - filter + _common.query_dsl:DateDecayFunction: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:DecayFunctionBase' + - type: object + _common.query_dsl:DateDistanceFeatureQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:DistanceFeatureQueryBaseDateMathDuration' + - type: object + _common.query_dsl:DateRangeQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:RangeQueryBase' + - type: object + properties: + gt: + $ref: '#/components/schemas/_common:DateMath' + gte: + $ref: '#/components/schemas/_common:DateMath' + lt: + $ref: '#/components/schemas/_common:DateMath' + lte: + $ref: '#/components/schemas/_common:DateMath' + from: + oneOf: + - $ref: '#/components/schemas/_common:DateMath' + - nullable: true + type: string + to: + oneOf: + - $ref: '#/components/schemas/_common:DateMath' + - nullable: true + type: string + format: + $ref: '#/components/schemas/_common:DateFormat' + time_zone: + $ref: '#/components/schemas/_common:TimeZone' + _common.query_dsl:DecayFunction: + oneOf: + - $ref: '#/components/schemas/_common.query_dsl:DateDecayFunction' + - $ref: '#/components/schemas/_common.query_dsl:NumericDecayFunction' + - $ref: '#/components/schemas/_common.query_dsl:GeoDecayFunction' + _common.query_dsl:DecayFunctionBase: + type: object + properties: + multi_value_mode: + $ref: '#/components/schemas/_common.query_dsl:MultiValueMode' + _common.query_dsl:DisMaxQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + queries: + description: |- + One or more query clauses. + Returned documents must match one or more of these queries. + If a document matches multiple queries, Opensearch uses the highest relevance score. + type: array + items: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + tie_breaker: + description: Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses. + type: number + required: + - queries + _common.query_dsl:DistanceFeatureQuery: + oneOf: + - $ref: '#/components/schemas/_common.query_dsl:GeoDistanceFeatureQuery' + - $ref: '#/components/schemas/_common.query_dsl:DateDistanceFeatureQuery' + _common.query_dsl:DistanceFeatureQueryBaseDateMathDuration: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + origin: + $ref: '#/components/schemas/_common:DateMath' + pivot: + $ref: '#/components/schemas/_common:Duration' + field: + $ref: '#/components/schemas/_common:Field' + required: + - origin + - pivot + - field + _common.query_dsl:DistanceFeatureQueryBaseGeoLocationDistance: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + origin: + $ref: '#/components/schemas/_common:GeoLocation' + pivot: + $ref: '#/components/schemas/_common:Distance' + field: + $ref: '#/components/schemas/_common:Field' + required: + - origin + - pivot + - field + _common.query_dsl:ExistsQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + required: + - field + _common.query_dsl:FieldAndFormat: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + format: + description: Format in which the values are returned. + type: string + include_unmapped: + type: boolean + required: + - field + _common.query_dsl:FieldValueFactorModifier: + type: string + enum: + - none + - log + - log1p + - log2p + - ln + - ln1p + - ln2p + - square + - sqrt + - reciprocal + _common.query_dsl:FieldValueFactorScoreFunction: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + factor: + description: Optional factor to multiply the field value with. + type: number + missing: + description: |- + Value used if the document doesn’t have that field. + The modifier and factor are still applied to it as though it were read from the document. + type: number + modifier: + $ref: '#/components/schemas/_common.query_dsl:FieldValueFactorModifier' + required: + - field + _common.query_dsl:FunctionBoostMode: + type: string + enum: + - multiply + - replace + - sum + - avg + - max + - min + _common.query_dsl:FunctionScoreContainer: + allOf: + - type: object + properties: + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + weight: + type: number + - type: object + properties: + exp: + $ref: '#/components/schemas/_common.query_dsl:DecayFunction' + gauss: + $ref: '#/components/schemas/_common.query_dsl:DecayFunction' + linear: + $ref: '#/components/schemas/_common.query_dsl:DecayFunction' + field_value_factor: + $ref: '#/components/schemas/_common.query_dsl:FieldValueFactorScoreFunction' + random_score: + $ref: '#/components/schemas/_common.query_dsl:RandomScoreFunction' + script_score: + $ref: '#/components/schemas/_common.query_dsl:ScriptScoreFunction' + minProperties: 1 + maxProperties: 1 + _common.query_dsl:FunctionScoreMode: + type: string + enum: + - multiply + - sum + - avg + - first + - max + - min + _common.query_dsl:FunctionScoreQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + boost_mode: + $ref: '#/components/schemas/_common.query_dsl:FunctionBoostMode' + functions: + description: One or more functions that compute a new score for each document returned by the query. + type: array + items: + $ref: '#/components/schemas/_common.query_dsl:FunctionScoreContainer' + max_boost: + description: Restricts the new score to not exceed the provided limit. + type: number + min_score: + description: Excludes documents that do not meet the provided score threshold. + type: number + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + score_mode: + $ref: '#/components/schemas/_common.query_dsl:FunctionScoreMode' + _common.query_dsl:FuzzyQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + max_expansions: + description: Maximum number of variations created. + type: number + prefix_length: + description: Number of beginning characters left unchanged when creating expansions. + type: number + rewrite: + $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + transpositions: + description: Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). + type: boolean + fuzziness: + $ref: '#/components/schemas/_common:Fuzziness' + value: + description: Term you wish to find in the provided field. + oneOf: + - type: string + - type: number + - type: boolean + required: + - value + _common.query_dsl:GeoBoundingBoxQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + type: + $ref: '#/components/schemas/_common.query_dsl:GeoExecution' + validation_method: + $ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod' + ignore_unmapped: + description: |- + 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. + type: boolean + _common.query_dsl:GeoDecayFunction: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:DecayFunctionBase' + - type: object + _common.query_dsl:GeoDistanceFeatureQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:DistanceFeatureQueryBaseGeoLocationDistance' + - type: object + _common.query_dsl:GeoDistanceQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + distance: + $ref: '#/components/schemas/_common:Distance' + distance_type: + $ref: '#/components/schemas/_common:GeoDistanceType' + validation_method: + $ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod' + required: + - distance + _common.query_dsl:GeoExecution: + type: string + enum: + - memory + - indexed + _common.query_dsl:GeoPolygonQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + validation_method: + $ref: '#/components/schemas/_common.query_dsl:GeoValidationMethod' + ignore_unmapped: + type: boolean + _common.query_dsl:GeoShapeQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + ignore_unmapped: + description: |- + 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. + type: boolean + _common.query_dsl:GeoValidationMethod: + type: string + enum: + - coerce + - ignore_malformed + - strict + _common.query_dsl:HasChildQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + ignore_unmapped: + description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + type: boolean + inner_hits: + $ref: '#/components/schemas/_core.search:InnerHits' + max_children: + description: |- + Maximum number of child documents that match the query allowed for a returned parent document. + If the parent document exceeds this limit, it is excluded from the search results. + type: number + min_children: + description: |- + Minimum number of child documents that match the query required to match the query for a returned parent document. + If the parent document does not meet this limit, it is excluded from the search results. + type: number + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + score_mode: + $ref: '#/components/schemas/_common.query_dsl:ChildScoreMode' + type: + $ref: '#/components/schemas/_common:RelationName' + required: + - query + - type + _common.query_dsl:HasParentQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + ignore_unmapped: + description: |- + Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error. + You can use this parameter to query multiple indices that may not contain the `parent_type`. + type: boolean + inner_hits: + $ref: '#/components/schemas/_core.search:InnerHits' + parent_type: + $ref: '#/components/schemas/_common:RelationName' + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + score: + description: Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + type: boolean + required: + - parent_type + - query + _common.query_dsl:IdsQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + values: + $ref: '#/components/schemas/_common:Ids' + _common.query_dsl:IntervalsAllOf: + type: object + properties: + intervals: + description: An array of rules to combine. All rules must produce a match in a document for the overall source to match. + type: array + items: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + max_gaps: + description: |- + Maximum number of positions between the matching terms. + Intervals produced by the rules further apart than this are not considered matches. + type: number + ordered: + description: If `true`, intervals produced by the rules should appear in the order in which they are specified. + type: boolean + filter: + $ref: '#/components/schemas/_common.query_dsl:IntervalsFilter' + required: + - intervals + _common.query_dsl:IntervalsAnyOf: + type: object + properties: + intervals: + description: An array of rules to match. + type: array + items: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + filter: + $ref: '#/components/schemas/_common.query_dsl:IntervalsFilter' + required: + - intervals + _common.query_dsl:IntervalsContainer: + type: object + properties: + all_of: + $ref: '#/components/schemas/_common.query_dsl:IntervalsAllOf' + any_of: + $ref: '#/components/schemas/_common.query_dsl:IntervalsAnyOf' + fuzzy: + $ref: '#/components/schemas/_common.query_dsl:IntervalsFuzzy' + match: + $ref: '#/components/schemas/_common.query_dsl:IntervalsMatch' + prefix: + $ref: '#/components/schemas/_common.query_dsl:IntervalsPrefix' + wildcard: + $ref: '#/components/schemas/_common.query_dsl:IntervalsWildcard' + minProperties: 1 + maxProperties: 1 + _common.query_dsl:IntervalsFilter: + type: object + properties: + after: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + before: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + contained_by: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + containing: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + not_contained_by: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + not_containing: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + not_overlapping: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + overlapping: + $ref: '#/components/schemas/_common.query_dsl:IntervalsContainer' + script: + $ref: '#/components/schemas/_common:Script' + minProperties: 1 + maxProperties: 1 + _common.query_dsl:IntervalsFuzzy: + type: object + properties: + analyzer: + description: Analyzer used to normalize the term. + type: string + fuzziness: + $ref: '#/components/schemas/_common:Fuzziness' + prefix_length: + description: Number of beginning characters left unchanged when creating expansions. + type: number + term: + description: The term to match. + type: string + transpositions: + description: Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). + type: boolean + use_field: + $ref: '#/components/schemas/_common:Field' + required: + - term + _common.query_dsl:IntervalsMatch: + type: object + properties: + analyzer: + description: Analyzer used to analyze terms in the query. + type: string + max_gaps: + description: |- + Maximum number of positions between the matching terms. + Terms further apart than this are not considered matches. + type: number + ordered: + description: If `true`, matching terms must appear in their specified order. + type: boolean + query: + description: Text you wish to find in the provided field. + type: string + use_field: + $ref: '#/components/schemas/_common:Field' + filter: + $ref: '#/components/schemas/_common.query_dsl:IntervalsFilter' + required: + - query + _common.query_dsl:IntervalsPrefix: + type: object + properties: + analyzer: + description: Analyzer used to analyze the `prefix`. + type: string + prefix: + description: Beginning characters of terms you wish to find in the top-level field. + type: string + use_field: + $ref: '#/components/schemas/_common:Field' + required: + - prefix + _common.query_dsl:IntervalsQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + all_of: + $ref: '#/components/schemas/_common.query_dsl:IntervalsAllOf' + any_of: + $ref: '#/components/schemas/_common.query_dsl:IntervalsAnyOf' + fuzzy: + $ref: '#/components/schemas/_common.query_dsl:IntervalsFuzzy' + match: + $ref: '#/components/schemas/_common.query_dsl:IntervalsMatch' + prefix: + $ref: '#/components/schemas/_common.query_dsl:IntervalsPrefix' + wildcard: + $ref: '#/components/schemas/_common.query_dsl:IntervalsWildcard' + minProperties: 1 + maxProperties: 1 + _common.query_dsl:IntervalsWildcard: + type: object + properties: + analyzer: + description: |- + Analyzer used to analyze the `pattern`. + Defaults to the top-level field's analyzer. + type: string + pattern: + description: Wildcard pattern used to find matching terms. + type: string + use_field: + $ref: '#/components/schemas/_common:Field' + required: + - pattern + _common.query_dsl:Like: + description: Text that we want similar documents for or a lookup to a document's field for the text. + oneOf: + - type: string + - $ref: '#/components/schemas/_common.query_dsl:LikeDocument' + _common.query_dsl:LikeDocument: + type: object + properties: + doc: + description: A document not present in the index. + type: object + fields: + type: array + items: + $ref: '#/components/schemas/_common:Field' + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' + per_field_analyzer: + type: object + additionalProperties: + type: string + routing: + $ref: '#/components/schemas/_common:Routing' + version: + $ref: '#/components/schemas/_common:VersionNumber' + version_type: + $ref: '#/components/schemas/_common:VersionType' + _common.query_dsl:MatchAllQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + _common.query_dsl:MatchBoolPrefixQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert the text in the query value into tokens. + type: string + fuzziness: + $ref: '#/components/schemas/_common:Fuzziness' + fuzzy_rewrite: + $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + fuzzy_transpositions: + description: |- + If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + Can be applied to the term subqueries constructed for all terms but the final term. + type: boolean + max_expansions: + description: |- + Maximum number of terms to which the query will expand. + Can be applied to the term subqueries constructed for all terms but the final term. + type: number + minimum_should_match: + $ref: '#/components/schemas/_common:MinimumShouldMatch' + operator: + $ref: '#/components/schemas/_common.query_dsl:Operator' + prefix_length: + description: |- + Number of beginning characters left unchanged for fuzzy matching. + Can be applied to the term subqueries constructed for all terms but the final term. + type: number + query: + description: |- + Terms you wish to find in the provided field. + The last term is used in a prefix query. + type: string + required: + - query + _common.query_dsl:MatchNoneQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + _common.query_dsl:MatchPhrasePrefixQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert text in the query value into tokens. + type: string + max_expansions: + description: Maximum number of terms to which the last provided term of the query value will expand. + type: number + query: + description: Text you wish to find in the provided field. + type: string + slop: + description: Maximum number of positions allowed between matching tokens. + type: number + zero_terms_query: + $ref: '#/components/schemas/_common.query_dsl:ZeroTermsQuery' + required: + - query + _common.query_dsl:MatchPhraseQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert the text in the query value into tokens. + type: string + query: + description: Query terms that are analyzed and turned into a phrase query. + type: string + slop: + description: Maximum number of positions allowed between matching tokens. + type: number + zero_terms_query: + $ref: '#/components/schemas/_common.query_dsl:ZeroTermsQuery' + required: + - query + _common.query_dsl:MatchQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert the text in the query value into tokens. + type: string + auto_generate_synonyms_phrase_query: + description: If `true`, match phrase queries are automatically created for multi-term synonyms. + type: boolean + cutoff_frequency: + deprecated: true + type: number + fuzziness: + $ref: '#/components/schemas/_common:Fuzziness' + fuzzy_rewrite: + $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + fuzzy_transpositions: + description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + type: boolean + lenient: + description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + type: boolean + max_expansions: + description: Maximum number of terms to which the query will expand. + type: number + minimum_should_match: + $ref: '#/components/schemas/_common:MinimumShouldMatch' + operator: + $ref: '#/components/schemas/_common.query_dsl:Operator' + prefix_length: + description: Number of beginning characters left unchanged for fuzzy matching. + type: number + query: + description: Text, number, boolean value or date you wish to find in the provided field. + oneOf: + - type: string + - type: number + - type: boolean + zero_terms_query: + $ref: '#/components/schemas/_common.query_dsl:ZeroTermsQuery' + required: + - query + _common.query_dsl:MoreLikeThisQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + analyzer: + description: |- + The analyzer that is used to analyze the free form text. + Defaults to the analyzer associated with the first field in fields. + type: string + boost_terms: + description: |- + Each term in the formed query could be further boosted by their tf-idf score. + This sets the boost factor to use when using this feature. + Defaults to deactivated (0). + type: number + fail_on_unsupported_field: + description: Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`). + type: boolean + fields: + description: |- + A list of fields to fetch and analyze the text from. + Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + type: array + items: + $ref: '#/components/schemas/_common:Field' + include: + description: Specifies whether the input documents should also be included in the search results returned. + type: boolean + like: + description: Specifies free form text and/or a single or multiple documents for which you want to find similar documents. + oneOf: + - $ref: '#/components/schemas/_common.query_dsl:Like' + - type: array + items: + $ref: '#/components/schemas/_common.query_dsl:Like' + max_doc_freq: + description: The maximum document frequency above which the terms are ignored from the input document. + type: number + max_query_terms: + description: The maximum number of query terms that can be selected. + type: number + max_word_length: + description: |- + The maximum word length above which the terms are ignored. + Defaults to unbounded (`0`). + type: number + min_doc_freq: + description: The minimum document frequency below which the terms are ignored from the input document. + type: number + minimum_should_match: + $ref: '#/components/schemas/_common:MinimumShouldMatch' + min_term_freq: + description: The minimum term frequency below which the terms are ignored from the input document. + type: number + min_word_length: + description: The minimum word length below which the terms are ignored. + type: number + per_field_analyzer: + description: Overrides the default analyzer. + type: object + additionalProperties: + type: string + routing: + $ref: '#/components/schemas/_common:Routing' + stop_words: + $ref: '#/components/schemas/_common.analysis:StopWords' + unlike: + description: Used in combination with `like` to exclude documents that match a set of terms. + oneOf: + - $ref: '#/components/schemas/_common.query_dsl:Like' + - type: array + items: + $ref: '#/components/schemas/_common.query_dsl:Like' + version: + $ref: '#/components/schemas/_common:VersionNumber' + version_type: + $ref: '#/components/schemas/_common:VersionType' + required: + - like + _common.query_dsl:MultiMatchQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert the text in the query value into tokens. + type: string + auto_generate_synonyms_phrase_query: + description: If `true`, match phrase queries are automatically created for multi-term synonyms. + type: boolean + cutoff_frequency: + deprecated: true + type: number + fields: + $ref: '#/components/schemas/_common:Fields' + fuzziness: + $ref: '#/components/schemas/_common:Fuzziness' + fuzzy_rewrite: + $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + fuzzy_transpositions: + description: |- + If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + Can be applied to the term subqueries constructed for all terms but the final term. + type: boolean + lenient: + description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + type: boolean + max_expansions: + description: Maximum number of terms to which the query will expand. + type: number + minimum_should_match: + $ref: '#/components/schemas/_common:MinimumShouldMatch' + operator: + $ref: '#/components/schemas/_common.query_dsl:Operator' + prefix_length: + description: Number of beginning characters left unchanged for fuzzy matching. + type: number + query: + description: Text, number, boolean value or date you wish to find in the provided field. + type: string + slop: + description: Maximum number of positions allowed between matching tokens. + type: number + tie_breaker: + description: Determines how scores for each per-term blended query and scores across groups are combined. + type: number + type: + $ref: '#/components/schemas/_common.query_dsl:TextQueryType' + zero_terms_query: + $ref: '#/components/schemas/_common.query_dsl:ZeroTermsQuery' + required: + - query + _common.query_dsl:MultiValueMode: + type: string + enum: + - min + - max + - avg + - sum + _common.query_dsl:NestedQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + ignore_unmapped: + description: Indicates whether to ignore an unmapped path and not return any documents instead of an error. + type: boolean + inner_hits: + $ref: '#/components/schemas/_core.search:InnerHits' + path: + $ref: '#/components/schemas/_common:Field' + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + score_mode: + $ref: '#/components/schemas/_common.query_dsl:ChildScoreMode' + required: + - path + - query + _common.query_dsl:NumberRangeQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:RangeQueryBase' + - type: object + properties: + gt: + description: Greater than. + type: number + gte: + description: Greater than or equal to. + type: number + lt: + description: Less than. + type: number + lte: + description: Less than or equal to. + type: number + from: + oneOf: + - type: number + - nullable: true + type: string + to: + oneOf: + - type: number + - nullable: true + type: string + _common.query_dsl:NumericDecayFunction: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:DecayFunctionBase' + - type: object + _common.query_dsl:Operator: + type: string + enum: + - and + - or + _common.query_dsl:ParentIdQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + id: + $ref: '#/components/schemas/_common:Id' + ignore_unmapped: + description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + type: boolean + type: + $ref: '#/components/schemas/_common:RelationName' + _common.query_dsl:PercolateQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + document: + description: The source of the document being percolated. + type: object + documents: + description: An array of sources of the documents being percolated. + type: array + items: + type: object + field: + $ref: '#/components/schemas/_common:Field' + id: + $ref: '#/components/schemas/_common:Id' + index: + $ref: '#/components/schemas/_common:IndexName' + name: + description: The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. + type: string + preference: + description: Preference used to fetch document to percolate. + type: string + routing: + $ref: '#/components/schemas/_common:Routing' + version: + $ref: '#/components/schemas/_common:VersionNumber' + required: + - field + _common.query_dsl:PinnedDoc: + type: object + properties: + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' + required: + - _id + - _index + _common.query_dsl:PinnedQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - allOf: + - type: object + properties: + organic: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + required: + - organic + - type: object + properties: + ids: + description: |- + Document IDs listed in the order they are to appear in results. + Required if `docs` is not specified. + type: array + items: + $ref: '#/components/schemas/_common:Id' + docs: + description: |- + Documents listed in the order they are to appear in results. + Required if `ids` is not specified. + type: array + items: + $ref: '#/components/schemas/_common.query_dsl:PinnedDoc' + minProperties: 1 + maxProperties: 1 + _common.query_dsl:PrefixQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + rewrite: + $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + value: + description: Beginning characters of terms you wish to find in the provided field. + type: string + case_insensitive: + description: |- + Allows ASCII case insensitive matching of the value 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. + type: boolean + required: + - value + _common.query_dsl:QueryBase: + type: object + properties: + boost: + description: |- + Floating point number used to decrease or increase the relevance scores of the query. + Boost values are relative to the default value of 1.0. + A boost value between 0 and 1.0 decreases the relevance score. + A value greater than 1.0 increases the relevance score. + type: number + _name: + type: string + _common.query_dsl:QueryContainer: + type: object + properties: + bool: + $ref: '#/components/schemas/_common.query_dsl:BoolQuery' + boosting: + $ref: '#/components/schemas/_common.query_dsl:BoostingQuery' + common: + deprecated: true + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:CommonTermsQuery' + minProperties: 1 + maxProperties: 1 + combined_fields: + $ref: '#/components/schemas/_common.query_dsl:CombinedFieldsQuery' + constant_score: + $ref: '#/components/schemas/_common.query_dsl:ConstantScoreQuery' + dis_max: + $ref: '#/components/schemas/_common.query_dsl:DisMaxQuery' + distance_feature: + $ref: '#/components/schemas/_common.query_dsl:DistanceFeatureQuery' + exists: + $ref: '#/components/schemas/_common.query_dsl:ExistsQuery' + function_score: + $ref: '#/components/schemas/_common.query_dsl:FunctionScoreQuery' + fuzzy: + description: Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:FuzzyQuery' + minProperties: 1 + maxProperties: 1 + geo_bounding_box: + $ref: '#/components/schemas/_common.query_dsl:GeoBoundingBoxQuery' + geo_distance: + $ref: '#/components/schemas/_common.query_dsl:GeoDistanceQuery' + geo_polygon: + $ref: '#/components/schemas/_common.query_dsl:GeoPolygonQuery' + geo_shape: + $ref: '#/components/schemas/_common.query_dsl:GeoShapeQuery' + has_child: + $ref: '#/components/schemas/_common.query_dsl:HasChildQuery' + has_parent: + $ref: '#/components/schemas/_common.query_dsl:HasParentQuery' + ids: + $ref: '#/components/schemas/_common.query_dsl:IdsQuery' + intervals: + description: Returns documents based on the order and proximity of matching terms. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:IntervalsQuery' + minProperties: 1 + maxProperties: 1 + match: + description: |- + Returns documents that match a provided text, number, date or boolean value. + The provided text is analyzed before matching. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:MatchQuery' + minProperties: 1 + maxProperties: 1 + match_all: + $ref: '#/components/schemas/_common.query_dsl:MatchAllQuery' + match_bool_prefix: + description: |- + Analyzes its input and constructs a `bool` query from the terms. + Each term except the last is used in a `term` query. + The last term is used in a prefix query. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:MatchBoolPrefixQuery' + minProperties: 1 + maxProperties: 1 + match_none: + $ref: '#/components/schemas/_common.query_dsl:MatchNoneQuery' + match_phrase: + description: Analyzes the text and creates a phrase query out of the analyzed text. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:MatchPhraseQuery' + minProperties: 1 + maxProperties: 1 + match_phrase_prefix: + description: |- + Returns documents that contain the words of a provided text, in the same order as provided. + The last term of the provided text is treated as a prefix, matching any words that begin with that term. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:MatchPhrasePrefixQuery' + minProperties: 1 + maxProperties: 1 + more_like_this: + $ref: '#/components/schemas/_common.query_dsl:MoreLikeThisQuery' + multi_match: + $ref: '#/components/schemas/_common.query_dsl:MultiMatchQuery' + nested: + $ref: '#/components/schemas/_common.query_dsl:NestedQuery' + parent_id: + $ref: '#/components/schemas/_common.query_dsl:ParentIdQuery' + percolate: + $ref: '#/components/schemas/_common.query_dsl:PercolateQuery' + pinned: + $ref: '#/components/schemas/_common.query_dsl:PinnedQuery' + prefix: + description: Returns documents that contain a specific prefix in a provided field. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:PrefixQuery' + minProperties: 1 + maxProperties: 1 + query_string: + $ref: '#/components/schemas/_common.query_dsl:QueryStringQuery' + range: + description: Returns documents that contain terms within a provided range. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:RangeQuery' + minProperties: 1 + maxProperties: 1 + rank_feature: + $ref: '#/components/schemas/_common.query_dsl:RankFeatureQuery' + regexp: + description: Returns documents that contain terms matching a regular expression. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:RegexpQuery' + minProperties: 1 + maxProperties: 1 + rule_query: + $ref: '#/components/schemas/_common.query_dsl:RuleQuery' + script: + $ref: '#/components/schemas/_common.query_dsl:ScriptQuery' + script_score: + $ref: '#/components/schemas/_common.query_dsl:ScriptScoreQuery' + shape: + $ref: '#/components/schemas/_common.query_dsl:ShapeQuery' + simple_query_string: + $ref: '#/components/schemas/_common.query_dsl:SimpleQueryStringQuery' + span_containing: + $ref: '#/components/schemas/_common.query_dsl:SpanContainingQuery' + field_masking_span: + $ref: '#/components/schemas/_common.query_dsl:SpanFieldMaskingQuery' + span_first: + $ref: '#/components/schemas/_common.query_dsl:SpanFirstQuery' + span_multi: + $ref: '#/components/schemas/_common.query_dsl:SpanMultiTermQuery' + span_near: + $ref: '#/components/schemas/_common.query_dsl:SpanNearQuery' + span_not: + $ref: '#/components/schemas/_common.query_dsl:SpanNotQuery' + span_or: + $ref: '#/components/schemas/_common.query_dsl:SpanOrQuery' + span_term: + description: Matches spans containing a term. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:SpanTermQuery' + minProperties: 1 + maxProperties: 1 + span_within: + $ref: '#/components/schemas/_common.query_dsl:SpanWithinQuery' + term: + description: |- + Returns documents that contain an exact term in a provided field. + To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:TermQuery' + minProperties: 1 + maxProperties: 1 + terms: + $ref: '#/components/schemas/_common.query_dsl:TermsQuery' + terms_set: + description: |- + Returns documents that contain a minimum number of exact terms in a provided field. + To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:TermsSetQuery' + minProperties: 1 + maxProperties: 1 + text_expansion: + description: Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:TextExpansionQuery' + minProperties: 1 + maxProperties: 1 + weighted_tokens: + description: Supports returning text_expansion query results by sending in precomputed tokens with the query. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:WeightedTokensQuery' + minProperties: 1 + maxProperties: 1 + wildcard: + description: Returns documents that contain terms matching a wildcard pattern. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:WildcardQuery' + minProperties: 1 + maxProperties: 1 + wrapper: + $ref: '#/components/schemas/_common.query_dsl:WrapperQuery' + type: + $ref: '#/components/schemas/_common.query_dsl:TypeQuery' + minProperties: 1 + maxProperties: 1 + _common.query_dsl:QueryStringQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + allow_leading_wildcard: + description: If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. + type: boolean + analyzer: + description: Analyzer used to convert text in the query string into tokens. + type: string + analyze_wildcard: + description: If `true`, the query attempts to analyze wildcard terms in the query string. + type: boolean + auto_generate_synonyms_phrase_query: + description: If `true`, match phrase queries are automatically created for multi-term synonyms. + type: boolean + default_field: + $ref: '#/components/schemas/_common:Field' + default_operator: + $ref: '#/components/schemas/_common.query_dsl:Operator' + enable_position_increments: + description: If `true`, enable position increments in queries constructed from a `query_string` search. + type: boolean + escape: + type: boolean + fields: + description: Array of fields to search. Supports wildcards (`*`). + type: array + items: + $ref: '#/components/schemas/_common:Field' + fuzziness: + $ref: '#/components/schemas/_common:Fuzziness' + fuzzy_max_expansions: + description: Maximum number of terms to which the query expands for fuzzy matching. + type: number + fuzzy_prefix_length: + description: Number of beginning characters left unchanged for fuzzy matching. + type: number + fuzzy_rewrite: + $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + fuzzy_transpositions: + description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + type: boolean + lenient: + description: If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + type: boolean + max_determinized_states: + description: Maximum number of automaton states required for the query. + type: number + minimum_should_match: + $ref: '#/components/schemas/_common:MinimumShouldMatch' + phrase_slop: + description: Maximum number of positions allowed between matching tokens for phrases. + type: number + query: + description: Query string you wish to parse and use for search. + type: string + quote_analyzer: + description: |- + Analyzer used to convert quoted text in the query string into tokens. + For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter. + type: string + quote_field_suffix: + description: |- + Suffix appended to quoted text in the query string. + You can use this suffix to use a different analysis method for exact matches. + type: string + rewrite: + $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + tie_breaker: + description: How to combine the queries generated from the individual search terms in the resulting `dis_max` query. + type: number + time_zone: + $ref: '#/components/schemas/_common:TimeZone' + type: + $ref: '#/components/schemas/_common.query_dsl:TextQueryType' + required: + - query + _common.query_dsl:RandomScoreFunction: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + seed: + oneOf: + - type: number + - type: string + _common.query_dsl:RangeQuery: + oneOf: + - $ref: '#/components/schemas/_common.query_dsl:DateRangeQuery' + - $ref: '#/components/schemas/_common.query_dsl:NumberRangeQuery' + _common.query_dsl:RangeQueryBase: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + relation: + $ref: '#/components/schemas/_common.query_dsl:RangeRelation' + _common.query_dsl:RangeRelation: + type: string + enum: + - within + - contains + - intersects + _common.query_dsl:RankFeatureFunction: + type: object + _common.query_dsl:RankFeatureFunctionLinear: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunction' + - type: object + _common.query_dsl:RankFeatureFunctionLogarithm: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunction' + - type: object + properties: + scaling_factor: + description: Configurable scaling factor. + type: number + required: + - scaling_factor + _common.query_dsl:RankFeatureFunctionSaturation: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunction' + - type: object + properties: + pivot: + description: Configurable pivot value so that the result will be less than 0.5. + type: number + _common.query_dsl:RankFeatureFunctionSigmoid: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunction' + - type: object + properties: + pivot: + description: Configurable pivot value so that the result will be less than 0.5. + type: number + exponent: + description: Configurable Exponent. + type: number + required: + - pivot + - exponent + _common.query_dsl:RankFeatureQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + saturation: + $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunctionSaturation' + log: + $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunctionLogarithm' + linear: + $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunctionLinear' + sigmoid: + $ref: '#/components/schemas/_common.query_dsl:RankFeatureFunctionSigmoid' + required: + - field + _common.query_dsl:RegexpQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + case_insensitive: + description: |- + Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`. + When `false`, case sensitivity of matching depends on the underlying field’s mapping. + type: boolean + flags: + description: Enables optional operators for the regular expression. + type: string + max_determinized_states: + description: Maximum number of automaton states required for the query. + type: number + rewrite: + $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + value: + description: Regular expression for terms you wish to find in the provided field. + type: string + required: + - value + _common.query_dsl:RuleQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + organic: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + ruleset_id: + $ref: '#/components/schemas/_common:Id' + match_criteria: + type: object + required: + - organic + - ruleset_id + - match_criteria + _common.query_dsl:ScriptQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + script: + $ref: '#/components/schemas/_common:Script' + required: + - script + _common.query_dsl:ScriptScoreFunction: + type: object + properties: + script: + $ref: '#/components/schemas/_common:Script' + required: + - script + _common.query_dsl:ScriptScoreQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + min_score: + description: Documents with a score lower than this floating point number are excluded from the search results. + type: number + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + script: + $ref: '#/components/schemas/_common:Script' + required: + - query + - script + _common.query_dsl:ShapeQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + ignore_unmapped: + description: When set to `true` the query ignores an unmapped field and will not match any documents. + type: boolean + _common.query_dsl:SimpleQueryStringFlag: + type: string + enum: + - NONE + - AND + - NOT + - OR + - PREFIX + - PHRASE + - PRECEDENCE + - ESCAPE + - WHITESPACE + - FUZZY + - NEAR + - SLOP + - ALL + _common.query_dsl:SimpleQueryStringFlags: + description: Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX` + allOf: + - $ref: '#/components/schemas/_common:PipeSeparatedFlagsSimpleQueryStringFlag' + _common.query_dsl:SimpleQueryStringQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert text in the query string into tokens. + type: string + analyze_wildcard: + description: If `true`, the query attempts to analyze wildcard terms in the query string. + type: boolean + auto_generate_synonyms_phrase_query: + description: If `true`, the parser creates a match_phrase query for each multi-position token. + type: boolean + default_operator: + $ref: '#/components/schemas/_common.query_dsl:Operator' + fields: + description: |- + Array of fields you wish to search. + Accepts wildcard expressions. + You also can boost relevance scores for matches to particular fields using a caret (`^`) notation. + Defaults to the `index.query.default_field index` setting, which has a default value of `*`. + type: array + items: + $ref: '#/components/schemas/_common:Field' + flags: + $ref: '#/components/schemas/_common.query_dsl:SimpleQueryStringFlags' + fuzzy_max_expansions: + description: Maximum number of terms to which the query expands for fuzzy matching. + type: number + fuzzy_prefix_length: + description: Number of beginning characters left unchanged for fuzzy matching. + type: number + fuzzy_transpositions: + description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`). + type: boolean + lenient: + description: If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + type: boolean + minimum_should_match: + $ref: '#/components/schemas/_common:MinimumShouldMatch' + query: + description: Query string in the simple query string syntax you wish to parse and use for search. + type: string + quote_field_suffix: + description: Suffix appended to quoted text in the query string. + type: string + required: + - query + _common.query_dsl:SpanContainingQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + big: + $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + little: + $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + required: + - big + - little + _common.query_dsl:SpanFieldMaskingQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + query: + $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + required: + - field + - query + _common.query_dsl:SpanFirstQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + end: + description: Controls the maximum end position permitted in a match. + type: number + match: + $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + required: + - end + - match + _common.query_dsl:SpanGapQuery: + description: Can only be used as a clause in a span_near query. + type: object + additionalProperties: + type: number + minProperties: 1 + maxProperties: 1 + _common.query_dsl:SpanMultiTermQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + match: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + required: + - match + _common.query_dsl:SpanNearQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + clauses: + description: Array of one or more other span type queries. + type: array + items: + $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + in_order: + description: Controls whether matches are required to be in-order. + type: boolean + slop: + description: Controls the maximum number of intervening unmatched positions permitted. + type: number + required: + - clauses + _common.query_dsl:SpanNotQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + dist: + description: |- + The number of tokens from within the include span that can’t have overlap with the exclude span. + Equivalent to setting both `pre` and `post`. + type: number + exclude: + $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + include: + $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + post: + description: The number of tokens after the include span that can’t have overlap with the exclude span. + type: number + pre: + description: The number of tokens before the include span that can’t have overlap with the exclude span. + type: number + required: + - exclude + - include + _common.query_dsl:SpanOrQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + clauses: + description: Array of one or more other span type queries. + type: array + items: + $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + required: + - clauses + _common.query_dsl:SpanQuery: + type: object + properties: + span_containing: + $ref: '#/components/schemas/_common.query_dsl:SpanContainingQuery' + field_masking_span: + $ref: '#/components/schemas/_common.query_dsl:SpanFieldMaskingQuery' + span_first: + $ref: '#/components/schemas/_common.query_dsl:SpanFirstQuery' + span_gap: + $ref: '#/components/schemas/_common.query_dsl:SpanGapQuery' + span_multi: + $ref: '#/components/schemas/_common.query_dsl:SpanMultiTermQuery' + span_near: + $ref: '#/components/schemas/_common.query_dsl:SpanNearQuery' + span_not: + $ref: '#/components/schemas/_common.query_dsl:SpanNotQuery' + span_or: + $ref: '#/components/schemas/_common.query_dsl:SpanOrQuery' + span_term: + description: The equivalent of the `term` query but for use with other span queries. + type: object + additionalProperties: + $ref: '#/components/schemas/_common.query_dsl:SpanTermQuery' + minProperties: 1 + maxProperties: 1 + span_within: + $ref: '#/components/schemas/_common.query_dsl:SpanWithinQuery' + minProperties: 1 + maxProperties: 1 + _common.query_dsl:SpanTermQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + value: + type: string + required: + - value + _common.query_dsl:SpanWithinQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + big: + $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + little: + $ref: '#/components/schemas/_common.query_dsl:SpanQuery' + required: + - big + - little + _common.query_dsl:TermQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + value: + $ref: '#/components/schemas/_common:FieldValue' + case_insensitive: + description: |- + Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`. + When `false`, the case sensitivity of matching depends on the underlying field’s mapping. + type: boolean + required: + - value + _common.query_dsl:TermsQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + _common.query_dsl:TermsSetQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + minimum_should_match_field: + $ref: '#/components/schemas/_common:Field' + minimum_should_match_script: + $ref: '#/components/schemas/_common:Script' + terms: + description: Array of terms you wish to find in the provided field. + type: array + items: + type: string + required: + - terms + _common.query_dsl:TextExpansionQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + model_id: + description: The text expansion NLP model to use + type: string + model_text: + description: The query text + type: string + pruning_config: + $ref: '#/components/schemas/_common.query_dsl:TokenPruningConfig' + required: + - model_id + - model_text + _common.query_dsl:TextQueryType: + type: string + enum: + - best_fields + - most_fields + - cross_fields + - phrase + - phrase_prefix + - bool_prefix + _common.query_dsl:TokenPruningConfig: + type: object + properties: + tokens_freq_ratio_threshold: + description: Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned. + type: number + tokens_weight_threshold: + description: Tokens whose weight is less than this threshold are considered nonsignificant and pruned. + type: number + only_score_pruned_tokens: + description: Whether to only score pruned tokens, vs only scoring kept tokens. + type: boolean + _common.query_dsl:TypeQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + value: + type: string + required: + - value + _common.query_dsl:WeightedTokensQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + tokens: + description: The tokens representing this query + type: object + additionalProperties: + type: number + pruning_config: + $ref: '#/components/schemas/_common.query_dsl:TokenPruningConfig' + required: + - tokens + _common.query_dsl:WildcardQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + case_insensitive: + 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. + type: boolean + rewrite: + $ref: '#/components/schemas/_common:MultiTermQueryRewrite' + value: + description: Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. + type: string + wildcard: + description: Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. + type: string + _common.query_dsl:WrapperQuery: + allOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryBase' + - type: object + properties: + query: + description: |- + A base64 encoded query. + The binary data format can be any of JSON, YAML, CBOR or SMILE encodings + type: string + required: + - query + _common.query_dsl:ZeroTermsQuery: + type: string + enum: + - all + - none + _common:AcknowledgedResponseBase: + type: object + properties: + acknowledged: + description: For a successful response, this value is always true. On failure, an exception is returned instead. + type: boolean + required: + - acknowledged + _common:ActionStatusOptions: + type: string + enum: + - success + - failure + - simulated + - throttled + _common:BaseNode: + type: object + properties: + attributes: + type: object + additionalProperties: + type: string + host: + $ref: '#/components/schemas/_common:Host' + ip: + $ref: '#/components/schemas/_common:Ip' + name: + $ref: '#/components/schemas/_common:Name' + roles: + $ref: '#/components/schemas/_common:NodeRoles' + transport_address: + $ref: '#/components/schemas/_common:TransportAddress' + required: + - attributes + - host + - ip + - name + - transport_address + _common:BulkIndexByScrollFailure: + type: object + properties: + cause: + $ref: '#/components/schemas/_common:ErrorCause' + id: + $ref: '#/components/schemas/_common:Id' + index: + $ref: '#/components/schemas/_common:IndexName' + status: + type: number + type: + type: string + required: + - cause + - id + - index + - status + - type + _common:BulkStats: + type: object + properties: + total_operations: + type: number + total_time: + $ref: '#/components/schemas/_common:Duration' + total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total_size: + $ref: '#/components/schemas/_common:ByteSize' + total_size_in_bytes: + type: number + avg_time: + $ref: '#/components/schemas/_common:Duration' + avg_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + avg_size: + $ref: '#/components/schemas/_common:ByteSize' + avg_size_in_bytes: + type: number + required: + - total_operations + - total_time_in_millis + - total_size_in_bytes + - avg_time_in_millis + - avg_size_in_bytes + _common:ByteSize: + oneOf: + - type: number + - type: string + _common:Bytes: + type: string + enum: + - b + - kb + - mb + - gb + - tb + - pb + _common:ClusterDetails: + type: object + properties: + status: + $ref: '#/components/schemas/_common:ClusterSearchStatus' + indices: + type: string + took: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + timed_out: + type: boolean + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + failures: + type: array + items: + $ref: '#/components/schemas/_common:ShardFailure' + required: + - status + - indices + - timed_out + _common:ClusterSearchStatus: + type: string + enum: + - running + - successful + - partial + - skipped + - failed + _common:ClusterStatistics: + type: object + properties: + skipped: + type: number + successful: + type: number + total: + type: number + running: + type: number + partial: + type: number + failed: + type: number + details: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:ClusterDetails' + required: + - skipped + - successful + - total + - running + - partial + - failed + _common:CompletionStats: + type: object + properties: + size_in_bytes: + description: Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes. + type: number + size: + $ref: '#/components/schemas/_common:ByteSize' + fields: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:FieldSizeUsage' + required: + - size_in_bytes + _common:Conflicts: + type: string + enum: + - abort + - proceed + _common:CoordsGeoBounds: + type: object + properties: + top: + type: number + bottom: + type: number + left: + type: number + right: + type: number + required: + - top + - bottom + - left + - right + _common:DFIIndependenceMeasure: + type: string + enum: + - standardized + - saturated + - chisquared + _common:DFRAfterEffect: + type: string + enum: + - no + - b + - l + _common:DFRBasicModel: + type: string + enum: + - be + - d + - g + - if + - in + - ine + - p + _common:DataStreamName: + type: string + _common:DataStreamNames: + oneOf: + - $ref: '#/components/schemas/_common:DataStreamName' + - type: array + items: + $ref: '#/components/schemas/_common:DataStreamName' + _common:DateFormat: + type: string + _common:DateMath: + type: string + _common:DateTime: + description: |- + A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a + number of milliseconds since the Epoch. Opensearch accepts both as input, but will generally output a string + representation. + oneOf: + - type: string + - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + _common:Distance: + type: string + _common:DistanceUnit: + type: string + enum: + - in + - ft + - yd + - mi + - nmi + - km + - m + - cm + - mm + _common:DocStats: + type: object + properties: + count: + description: |- + Total number of non-deleted documents across all primary shards assigned to selected nodes. + This number is based on documents in Lucene segments and may include documents from nested fields. + type: number + deleted: + description: |- + Total number of deleted documents across all primary shards assigned to selected nodes. + This number is based on documents in Lucene segments. + Opensearch reclaims the disk space of deleted Lucene documents when a segment is merged. + type: number + required: + - count + _common:Duration: + description: |- + A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and + `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + x-data-type: time + pattern: ^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$ + type: string + _common:DurationLarge: + description: |- + A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) and + `y` (year) + type: string + _common:DurationValueUnitMillis: + allOf: + - $ref: '#/components/schemas/_common:UnitMillis' + _common:DurationValueUnitNanos: + allOf: + - $ref: '#/components/schemas/_common:UnitNanos' + _common:EmptyObject: + type: object + _common:EpochTimeUnitMillis: + allOf: + - $ref: '#/components/schemas/_common:UnitMillis' + _common:EpochTimeUnitSeconds: + allOf: + - $ref: '#/components/schemas/_common:UnitSeconds' + _common:ErrorCause: + type: object + properties: + type: + description: The type of error + type: string + reason: + description: A human-readable explanation of the error, in english + type: string + stack_trace: + description: The server stack trace. Present only if the `error_trace=true` parameter was sent with the request. + type: string + caused_by: + $ref: '#/components/schemas/_common:ErrorCause' + root_cause: + type: array + items: + $ref: '#/components/schemas/_common:ErrorCause' + suppressed: + type: array + items: + $ref: '#/components/schemas/_common:ErrorCause' + required: + - type + _common:ErrorResponseBase: + type: object + properties: + error: + $ref: '#/components/schemas/_common:ErrorCause' + status: + type: number + required: + - error + - status + _common:ExpandWildcard: + type: string + enum: + - all + - open + - closed + - hidden + - none + _common:ExpandWildcards: + oneOf: + - $ref: '#/components/schemas/_common:ExpandWildcard' + - type: array + items: + $ref: '#/components/schemas/_common:ExpandWildcard' + _common:Field: + description: Path to field or array of paths. Some API's support wildcards in the path to select multiple fields. + type: string + _common:FieldMemoryUsage: + type: object + properties: + memory_size: + $ref: '#/components/schemas/_common:ByteSize' + memory_size_in_bytes: + type: number + required: + - memory_size_in_bytes + _common:FieldSizeUsage: + type: object + properties: + size: + $ref: '#/components/schemas/_common:ByteSize' + size_in_bytes: + type: number + required: + - size_in_bytes + _common:FieldValue: + description: A field value. + oneOf: + - type: number + - type: number + - type: string + - type: boolean + - nullable: true + type: string + - type: object + _common:FielddataStats: + type: object + properties: + evictions: + type: number + memory_size: + $ref: '#/components/schemas/_common:ByteSize' + memory_size_in_bytes: + type: number + fields: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:FieldMemoryUsage' + required: + - memory_size_in_bytes + _common:Fields: + oneOf: + - $ref: '#/components/schemas/_common:Field' + - type: array + items: + $ref: '#/components/schemas/_common:Field' + _common:FlushStats: + type: object + properties: + periodic: + type: number + total: + type: number + total_time: + $ref: '#/components/schemas/_common:Duration' + total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - periodic + - total + - total_time_in_millis + _common:Fuzziness: + oneOf: + - type: string + - type: number + _common:GeoBounds: + description: |- + 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 + oneOf: + - $ref: '#/components/schemas/_common:CoordsGeoBounds' + - $ref: '#/components/schemas/_common:TopLeftBottomRightGeoBounds' + - $ref: '#/components/schemas/_common:TopRightBottomLeftGeoBounds' + - $ref: '#/components/schemas/_common:WktGeoBounds' + _common:GeoDistanceSort: + type: object + properties: + mode: + $ref: '#/components/schemas/_common:SortMode' + distance_type: + $ref: '#/components/schemas/_common:GeoDistanceType' + ignore_unmapped: + type: boolean + order: + $ref: '#/components/schemas/_common:SortOrder' + unit: + $ref: '#/components/schemas/_common:DistanceUnit' + _common:GeoDistanceType: + type: string + enum: + - arc + - plane + _common:GeoHash: + type: string + _common:GeoHashLocation: + type: object + properties: + geohash: + $ref: '#/components/schemas/_common:GeoHash' + required: + - geohash + _common:GeoHashPrecision: + description: A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m". + oneOf: + - type: number + - type: string + _common:GeoHexCell: + description: A map hex cell (H3) reference + type: string + _common:GeoLine: + type: object + properties: + type: + description: Always `"LineString"` + type: string + coordinates: + description: Array of `[lon, lat]` coordinates + type: array + items: + type: array + items: + type: number + required: + - type + - coordinates + _common:GeoLocation: + description: |- + 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 + oneOf: + - $ref: '#/components/schemas/_common:LatLonGeoLocation' + - $ref: '#/components/schemas/_common:GeoHashLocation' + - type: array + items: + type: number + - type: string + _common:GeoShapeRelation: + type: string + enum: + - intersects + - disjoint + - within + - contains + _common:GeoTile: + description: A map tile reference, represented as `{zoom}/{x}/{y}` + type: string + _common:GeoTilePrecision: + type: number + _common:GetStats: + type: object + properties: + current: + type: number + exists_time: + $ref: '#/components/schemas/_common:Duration' + exists_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + exists_total: + type: number + missing_time: + $ref: '#/components/schemas/_common:Duration' + missing_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + missing_total: + type: number + time: + $ref: '#/components/schemas/_common:Duration' + time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total: + type: number + required: + - current + - exists_time_in_millis + - exists_total + - missing_time_in_millis + - missing_total + - time_in_millis + - total + _common:HealthStatus: + type: string + enum: + - green + - yellow + - red + _common:Host: + type: string + _common:HourAndMinute: + type: object + properties: + hour: + type: array + items: + type: number + minute: + type: array + items: + type: number + required: + - hour + - minute + _common:HttpHeaders: + type: object + additionalProperties: + oneOf: + - type: string + - type: array + items: + type: string + _common:IBDistribution: + type: string + enum: + - ll + - spl + _common:IBLambda: + type: string + enum: + - df + - ttf + _common:Id: + type: string + _common:Ids: + oneOf: + - $ref: '#/components/schemas/_common:Id' + - type: array + items: + $ref: '#/components/schemas/_common:Id' + _common:IndexAlias: + type: string + _common:IndexName: + type: string + _common:IndexingStats: + type: object + properties: + index_current: + type: number + delete_current: + type: number + delete_time: + $ref: '#/components/schemas/_common:Duration' + delete_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + delete_total: + type: number + is_throttled: + type: boolean + noop_update_total: + type: number + throttle_time: + $ref: '#/components/schemas/_common:Duration' + throttle_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + index_time: + $ref: '#/components/schemas/_common:Duration' + index_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + index_total: + type: number + index_failed: + type: number + types: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:IndexingStats' + write_load: + type: number + required: + - index_current + - delete_current + - delete_time_in_millis + - delete_total + - is_throttled + - noop_update_total + - throttle_time_in_millis + - index_time_in_millis + - index_total + - index_failed + _common:Indices: + oneOf: + - $ref: '#/components/schemas/_common:IndexName' + - type: array + items: + $ref: '#/components/schemas/_common:IndexName' + _common:IndicesResponseBase: + allOf: + - $ref: '#/components/schemas/_common:AcknowledgedResponseBase' + - type: object + properties: + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + _common:InlineGet: + type: object + properties: + fields: + type: object + additionalProperties: + type: object + found: + type: boolean + _seq_no: + $ref: '#/components/schemas/_common:SequenceNumber' + _primary_term: + type: number + _routing: + $ref: '#/components/schemas/_common:Routing' + _source: + type: object + required: + - found + - _source + _common:InlineGetDictUserDefined: + type: object + properties: + fields: + type: object + additionalProperties: + type: object + found: + type: boolean + _seq_no: + $ref: '#/components/schemas/_common:SequenceNumber' + _primary_term: + type: number + _routing: + $ref: '#/components/schemas/_common:Routing' + _source: + type: object + additionalProperties: + type: object + required: + - found + - _source + _common:InlineScript: + allOf: + - $ref: '#/components/schemas/_common:ScriptBase' + - type: object + properties: + lang: + $ref: '#/components/schemas/_common:ScriptLanguage' + options: + type: object + additionalProperties: + type: string + source: + description: The script source. + type: string + required: + - source + _common:Ip: + type: string + _common:KnnQuery: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + query_vector: + $ref: '#/components/schemas/_common:QueryVector' + query_vector_builder: + $ref: '#/components/schemas/_common:QueryVectorBuilder' + k: + description: The final number of nearest neighbors to return as top hits + type: number + num_candidates: + description: The number of nearest neighbor candidates to consider per shard + type: number + boost: + description: Boost value to apply to kNN scores + type: number + filter: + description: Filters for the kNN search query + oneOf: + - $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + - type: array + items: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + similarity: + description: The minimum similarity for a vector to be considered a match + type: number + required: + - field + - k + - num_candidates + _common:LatLonGeoLocation: + type: object + properties: + lat: + description: Latitude + type: number + lon: + description: Longitude + type: number + required: + - lat + - lon + _common:Level: + type: string + enum: + - cluster + - indices + - shards + _common:MergesStats: + type: object + properties: + current: + type: number + current_docs: + type: number + current_size: + type: string + current_size_in_bytes: + type: number + total: + type: number + total_auto_throttle: + type: string + total_auto_throttle_in_bytes: + type: number + total_docs: + type: number + total_size: + type: string + total_size_in_bytes: + type: number + total_stopped_time: + $ref: '#/components/schemas/_common:Duration' + total_stopped_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total_throttled_time: + $ref: '#/components/schemas/_common:Duration' + total_throttled_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total_time: + $ref: '#/components/schemas/_common:Duration' + total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - current + - current_docs + - current_size_in_bytes + - total + - total_auto_throttle_in_bytes + - total_docs + - total_size_in_bytes + - total_stopped_time_in_millis + - total_throttled_time_in_millis + - total_time_in_millis + _common:Metadata: + type: object + additionalProperties: + type: object + _common:Metrics: + oneOf: + - type: string + - type: array + items: + type: string + _common:MinimumShouldMatch: + description: The minimum number of terms that should match as integer, percentage or range + oneOf: + - type: number + - type: string + _common:MultiTermQueryRewrite: + type: string + _common:Name: + type: string + _common:Names: + oneOf: + - $ref: '#/components/schemas/_common:Name' + - type: array + items: + $ref: '#/components/schemas/_common:Name' + _common:NestedSortValue: + type: object + properties: + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + max_children: + type: number + nested: + $ref: '#/components/schemas/_common:NestedSortValue' + path: + $ref: '#/components/schemas/_common:Field' + required: + - path + _common:NodeAttributes: + type: object + properties: + attributes: + description: Lists node attributes. + type: object + additionalProperties: + type: string + ephemeral_id: + $ref: '#/components/schemas/_common:Id' + id: + $ref: '#/components/schemas/_common:NodeId' + name: + $ref: '#/components/schemas/_common:NodeName' + transport_address: + $ref: '#/components/schemas/_common:TransportAddress' + roles: + $ref: '#/components/schemas/_common:NodeRoles' + external_id: + type: string + required: + - attributes + - ephemeral_id + - name + - transport_address + _common:NodeId: + type: string + _common:NodeIds: + oneOf: + - $ref: '#/components/schemas/_common:NodeId' + - type: array + items: + $ref: '#/components/schemas/_common:NodeId' + _common:NodeName: + type: string + _common:NodeRole: + type: string + enum: + - master + - data + - data_cold + - data_content + - data_frozen + - data_hot + - data_warm + - client + - ingest + - ml + - voting_only + - transform + - remote_cluster_client + - coordinating_only + _common:NodeRoles: + description: '* @doc_id node-roles' + type: array + items: + $ref: '#/components/schemas/_common:NodeRole' + _common:NodeShard: + type: object + properties: + state: + $ref: '#/components/schemas/indices.stats:ShardRoutingState' + primary: + type: boolean + node: + $ref: '#/components/schemas/_common:NodeName' + shard: + type: number + index: + $ref: '#/components/schemas/_common:IndexName' + allocation_id: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:Id' + recovery_source: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:Id' + unassigned_info: + $ref: '#/components/schemas/cluster.allocation_explain:UnassignedInformation' + relocating_node: + oneOf: + - $ref: '#/components/schemas/_common:NodeId' + - nullable: true + type: string + relocation_failure_info: + $ref: '#/components/schemas/_common:RelocationFailureInfo' + required: + - state + - primary + - shard + - index + _common:NodeStatistics: + type: object + properties: + failures: + type: array + items: + $ref: '#/components/schemas/_common:ErrorCause' + total: + description: Total number of nodes selected by the request. + type: number + successful: + description: Number of nodes that responded successfully to the request. + type: number + failed: + description: Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response. + type: number + required: + - total + - successful + - failed + _common:Normalization: + type: string + enum: + - no + - h1 + - h2 + - h3 + - z + _common:OpType: + type: string + enum: + - index + - create + _common:OpensearchVersionInfo: + type: object + properties: + build_date: + $ref: '#/components/schemas/_common:DateTime' + build_flavor: + type: string + build_hash: + type: string + build_snapshot: + type: boolean + build_type: + type: string + lucene_version: + $ref: '#/components/schemas/_common:VersionString' + minimum_index_compatibility_version: + $ref: '#/components/schemas/_common:VersionString' + minimum_wire_compatibility_version: + $ref: '#/components/schemas/_common:VersionString' + number: + type: string + required: + - build_date + - build_flavor + - build_hash + - build_snapshot + - build_type + - lucene_version + - minimum_index_compatibility_version + - minimum_wire_compatibility_version + - number + _common:Password: + type: string + _common:Percentage: + oneOf: + - type: string + - type: number + _common:PipeSeparatedFlagsSimpleQueryStringFlag: + description: |- + A set of flags that can be represented as a single enum value or a set of values that are encoded + as a pipe-separated string + + Depending on the target language, code generators can use this hint to generate language specific + flags enum constructs and the corresponding (de-)serialization code. + oneOf: + - $ref: '#/components/schemas/_common.query_dsl:SimpleQueryStringFlag' + - type: string + _common:PipelineName: + type: string + _common:PluginStats: + type: object + properties: + classname: + type: string + description: + type: string + extended_plugins: + type: array + items: + type: string + has_native_controller: + type: boolean + java_version: + $ref: '#/components/schemas/_common:VersionString' + name: + $ref: '#/components/schemas/_common:Name' + version: + $ref: '#/components/schemas/_common:VersionString' + licensed: + type: boolean + opensearch_version: + $ref: '#/components/schemas/_common:VersionString' + required: + - classname + - description + - opensearch_version + - extended_plugins + - has_native_controller + - java_version + - name + - version + - licensed + _common:QueryCacheStats: + type: object + properties: + cache_count: + description: |- + Total number of entries added to the query cache across all shards assigned to selected nodes. + This number includes current and evicted entries. + type: number + cache_size: + description: Total number of entries currently in the query cache across all shards assigned to selected nodes. + type: number + evictions: + description: Total number of query cache evictions across all shards assigned to selected nodes. + type: number + hit_count: + description: Total count of query cache hits across all shards assigned to selected nodes. + type: number + memory_size: + $ref: '#/components/schemas/_common:ByteSize' + memory_size_in_bytes: + description: Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes. + type: number + miss_count: + description: Total count of query cache misses across all shards assigned to selected nodes. + type: number + total_count: + description: Total count of hits and misses in the query cache across all shards assigned to selected nodes. + type: number + required: + - cache_count + - cache_size + - evictions + - hit_count + - memory_size_in_bytes + - miss_count + - total_count + _common:QueryVector: + type: array + items: + type: number + _common:QueryVectorBuilder: + type: object + properties: + text_embedding: + $ref: '#/components/schemas/_common:TextEmbedding' + minProperties: 1 + maxProperties: 1 + _common:RankBase: + type: object + _common:RankContainer: + type: object + properties: + rrf: + $ref: '#/components/schemas/_common:RrfRank' + minProperties: 1 + maxProperties: 1 + _common:RecoveryStats: + type: object + properties: + current_as_source: + type: number + current_as_target: + type: number + throttle_time: + $ref: '#/components/schemas/_common:Duration' + throttle_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - current_as_source + - current_as_target + - throttle_time_in_millis + _common:Refresh: + type: string + enum: + - 'true' + - 'false' + - wait_for + _common:RefreshStats: + type: object + properties: + external_total: + type: number + external_total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + listeners: + type: number + total: + type: number + total_time: + $ref: '#/components/schemas/_common:Duration' + total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - external_total + - external_total_time_in_millis + - listeners + - total + - total_time_in_millis + _common:RelationName: + type: string + _common:RelocationFailureInfo: + type: object + properties: + failed_attempts: + type: number + required: + - failed_attempts + _common:RequestCacheStats: + type: object + properties: + evictions: + type: number + hit_count: + type: number + memory_size: + type: string + memory_size_in_bytes: + type: number + miss_count: + type: number + required: + - evictions + - hit_count + - memory_size_in_bytes + - miss_count + _common:Result: + type: string + enum: + - created + - updated + - deleted + - not_found + - noop + _common:Retries: + type: object + properties: + bulk: + type: number + search: + type: number + required: + - bulk + - search + _common:Routing: + type: string + _common:RrfRank: + allOf: + - $ref: '#/components/schemas/_common:RankBase' + - type: object + properties: + rank_constant: + description: How much influence documents in individual result sets per query have over the final ranked result set + type: number + window_size: + description: Size of the individual result sets per query + type: number + _common:ScheduleTimeOfDay: + description: A time of day, expressed either as `hh:mm`, `noon`, `midnight`, or an hour/minutes structure. + oneOf: + - type: string + - $ref: '#/components/schemas/_common:HourAndMinute' + _common:ScoreSort: + type: object + properties: + order: + $ref: '#/components/schemas/_common:SortOrder' + _common:Script: + oneOf: + - $ref: '#/components/schemas/_common:InlineScript' + - $ref: '#/components/schemas/_common:StoredScriptId' + _common:ScriptBase: + type: object + properties: + params: + description: |- + Specifies any named parameters that are passed into the script as variables. + Use parameters instead of hard-coded values to decrease compile time. + type: object + additionalProperties: + type: object + _common:ScriptField: + type: object + properties: + script: + $ref: '#/components/schemas/_common:Script' + ignore_failure: + type: boolean + required: + - script + _common:ScriptLanguage: + type: string + enum: + - painless + - expression + - mustache + - java + _common:ScriptSort: + type: object + properties: + order: + $ref: '#/components/schemas/_common:SortOrder' + script: + $ref: '#/components/schemas/_common:Script' + type: + $ref: '#/components/schemas/_common:ScriptSortType' + mode: + $ref: '#/components/schemas/_common:SortMode' + nested: + $ref: '#/components/schemas/_common:NestedSortValue' + required: + - script + _common:ScriptSortType: + type: string + enum: + - string + - number + - version + _common:ScrollId: + type: string + _common:ScrollIds: + oneOf: + - $ref: '#/components/schemas/_common:ScrollId' + - type: array + items: + $ref: '#/components/schemas/_common:ScrollId' + _common:SearchStats: + type: object + properties: + fetch_current: + type: number + fetch_time: + $ref: '#/components/schemas/_common:Duration' + fetch_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + fetch_total: + type: number + open_contexts: + type: number + query_current: + type: number + query_time: + $ref: '#/components/schemas/_common:Duration' + query_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + query_total: + type: number + scroll_current: + type: number + scroll_time: + $ref: '#/components/schemas/_common:Duration' + scroll_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + scroll_total: + type: number + suggest_current: + type: number + suggest_time: + $ref: '#/components/schemas/_common:Duration' + suggest_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + suggest_total: + type: number + groups: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:SearchStats' + required: + - fetch_current + - fetch_time_in_millis + - fetch_total + - query_current + - query_time_in_millis + - query_total + - scroll_current + - scroll_time_in_millis + - scroll_total + - suggest_current + - suggest_time_in_millis + - suggest_total + _common:SearchType: + type: string + enum: + - query_then_fetch + - dfs_query_then_fetch + _common:SegmentsStats: + type: object + properties: + count: + description: Total number of segments across all shards assigned to selected nodes. + type: number + doc_values_memory: + $ref: '#/components/schemas/_common:ByteSize' + doc_values_memory_in_bytes: + description: Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes. + type: number + file_sizes: + description: |- + This object is not populated by the cluster stats API. + To get information on segment files, use the node stats API. + type: object + additionalProperties: + $ref: '#/components/schemas/indices.stats:ShardFileSizeInfo' + fixed_bit_set: + $ref: '#/components/schemas/_common:ByteSize' + fixed_bit_set_memory_in_bytes: + description: Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes. + type: number + index_writer_memory: + $ref: '#/components/schemas/_common:ByteSize' + index_writer_max_memory_in_bytes: + type: number + index_writer_memory_in_bytes: + description: Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes. + type: number + max_unsafe_auto_id_timestamp: + description: Unix timestamp, in milliseconds, of the most recently retried indexing request. + type: number + memory: + $ref: '#/components/schemas/_common:ByteSize' + memory_in_bytes: + description: Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes. + type: number + norms_memory: + $ref: '#/components/schemas/_common:ByteSize' + norms_memory_in_bytes: + description: Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes. + type: number + points_memory: + $ref: '#/components/schemas/_common:ByteSize' + points_memory_in_bytes: + description: Total amount, in bytes, of memory used for points across all shards assigned to selected nodes. + type: number + stored_memory: + $ref: '#/components/schemas/_common:ByteSize' + stored_fields_memory_in_bytes: + description: Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes. + type: number + terms_memory_in_bytes: + description: Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes. + type: number + terms_memory: + $ref: '#/components/schemas/_common:ByteSize' + term_vectory_memory: + $ref: '#/components/schemas/_common:ByteSize' + term_vectors_memory_in_bytes: + description: Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes. + type: number + version_map_memory: + $ref: '#/components/schemas/_common:ByteSize' + version_map_memory_in_bytes: + description: Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes. + type: number + required: + - count + - doc_values_memory_in_bytes + - file_sizes + - fixed_bit_set_memory_in_bytes + - index_writer_memory_in_bytes + - max_unsafe_auto_id_timestamp + - memory_in_bytes + - norms_memory_in_bytes + - points_memory_in_bytes + - stored_fields_memory_in_bytes + - terms_memory_in_bytes + - term_vectors_memory_in_bytes + - version_map_memory_in_bytes + _common:SequenceNumber: + type: number + _common:ShardFailure: + type: object + properties: + index: + $ref: '#/components/schemas/_common:IndexName' + node: + type: string + reason: + $ref: '#/components/schemas/_common:ErrorCause' + shard: + type: number + status: + type: string + required: + - reason + - shard + _common:ShardStatistics: + type: object + properties: + failed: + $ref: '#/components/schemas/_common:uint' + successful: + $ref: '#/components/schemas/_common:uint' + total: + $ref: '#/components/schemas/_common:uint' + failures: + type: array + items: + $ref: '#/components/schemas/_common:ShardFailure' + skipped: + $ref: '#/components/schemas/_common:uint' + required: + - failed + - successful + - total + _common:ShardsOperationResponseBase: + type: object + properties: + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + required: + - _shards + _common:SlicedScroll: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + id: + $ref: '#/components/schemas/_common:Id' + max: + type: number + required: + - id + - max + _common:Slices: + description: Slices configuration used to parallelize a process. + oneOf: + - type: number + - $ref: '#/components/schemas/_common:SlicesCalculation' + _common:SlicesCalculation: + type: string + enum: + - auto + _common:Sort: + oneOf: + - $ref: '#/components/schemas/_common:SortCombinations' + - type: array + items: + $ref: '#/components/schemas/_common:SortCombinations' + _common:SortCombinations: + oneOf: + - $ref: '#/components/schemas/_common:Field' + - $ref: '#/components/schemas/_common:SortOptions' + _common:SortMode: + type: string + enum: + - min + - max + - sum + - avg + - median + _common:SortOptions: + type: object + properties: + _score: + $ref: '#/components/schemas/_common:ScoreSort' + _doc: + $ref: '#/components/schemas/_common:ScoreSort' + _geo_distance: + $ref: '#/components/schemas/_common:GeoDistanceSort' + _script: + $ref: '#/components/schemas/_common:ScriptSort' + minProperties: 1 + maxProperties: 1 + _common:SortOrder: + type: string + enum: + - asc + - desc + _common:SortResults: + type: array + items: + $ref: '#/components/schemas/_common:FieldValue' + _common:StoreStats: + type: object + properties: + size: + $ref: '#/components/schemas/_common:ByteSize' + size_in_bytes: + description: Total size, in bytes, of all shards assigned to selected nodes. + type: number + reserved: + $ref: '#/components/schemas/_common:ByteSize' + reserved_in_bytes: + description: A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. + type: number + total_data_set_size: + $ref: '#/components/schemas/_common:ByteSize' + total_data_set_size_in_bytes: + description: |- + Total data set size, in bytes, of all shards assigned to selected nodes. + This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. + type: number + required: + - size_in_bytes + - reserved_in_bytes + _common:StoredScript: + type: object + properties: + lang: + $ref: '#/components/schemas/_common:ScriptLanguage' + options: + type: object + additionalProperties: + type: string + source: + description: The script source. + type: string + required: + - lang + - source + _common:StoredScriptId: + allOf: + - $ref: '#/components/schemas/_common:ScriptBase' + - type: object + properties: + id: + $ref: '#/components/schemas/_common:Id' + required: + - id + _common:StringifiedEpochTimeUnitMillis: + description: |- + 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. + + Depending on the target language, code generators can keep the union or remove it and leniently parse + strings to the target type. + oneOf: + - $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + - type: string + _common:StringifiedEpochTimeUnitSeconds: + description: |- + 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. + + Depending on the target language, code generators can keep the union or remove it and leniently parse + strings to the target type. + oneOf: + - $ref: '#/components/schemas/_common:EpochTimeUnitSeconds' + - type: string + _common:StringifiedVersionNumber: + description: |- + 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. + + Depending on the target language, code generators can keep the union or remove it and leniently parse + strings to the target type. + oneOf: + - $ref: '#/components/schemas/_common:VersionNumber' + - type: string + _common:Stringifiedboolean: + description: |- + 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. + + Depending on the target language, code generators can keep the union or remove it and leniently parse + strings to the target type. + oneOf: + - type: boolean + - type: string + _common:Stringifiedinteger: + description: |- + 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. + + Depending on the target language, code generators can keep the union or remove it and leniently parse + strings to the target type. + oneOf: + - type: number + - type: string + _common:SuggestMode: + type: string + enum: + - missing + - popular + - always + _common:TaskFailure: + type: object + properties: + task_id: + type: number + node_id: + $ref: '#/components/schemas/_common:NodeId' + status: + type: string + reason: + $ref: '#/components/schemas/_common:ErrorCause' + required: + - task_id + - node_id + - status + - reason + _common:TaskId: + oneOf: + - type: string + - type: number + _common:TextEmbedding: + type: object + properties: + model_id: + type: string + model_text: + type: string + required: + - model_id + - model_text + _common:TimeOfDay: + description: Time of day, expressed as HH:MM:SS + type: string + _common:TimeUnit: + type: string + enum: + - nanos + - micros + - ms + - s + - m + - h + - d + _common:TimeZone: + type: string + _common:TopLeftBottomRightGeoBounds: + type: object + properties: + top_left: + $ref: '#/components/schemas/_common:GeoLocation' + bottom_right: + $ref: '#/components/schemas/_common:GeoLocation' + required: + - top_left + - bottom_right + _common:TopRightBottomLeftGeoBounds: + type: object + properties: + top_right: + $ref: '#/components/schemas/_common:GeoLocation' + bottom_left: + $ref: '#/components/schemas/_common:GeoLocation' + required: + - top_right + - bottom_left + _common:TranslogStats: + type: object + properties: + earliest_last_modified_age: + type: number + operations: + type: number + size: + type: string + size_in_bytes: + type: number + uncommitted_operations: + type: number + uncommitted_size: + type: string + uncommitted_size_in_bytes: + type: number + required: + - earliest_last_modified_age + - operations + - size_in_bytes + - uncommitted_operations + - uncommitted_size_in_bytes + _common:TransportAddress: + type: string + _common:UnitMillis: + description: Time unit for milliseconds + type: number + _common:UnitNanos: + description: Time unit for nanoseconds + type: number + _common:UnitSeconds: + description: Time unit for seconds + type: number + _common:Username: + type: string + _common:Uuid: + type: string + _common:VersionNumber: + type: number + _common:VersionString: + type: string + _common:VersionType: + type: string + enum: + - internal + - external + - external_gte + - force + _common:Void: + description: |- + 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 + type: object + _common:WaitForActiveShardOptions: + type: string + enum: + - all + - index-setting + _common:WaitForActiveShards: + oneOf: + - type: number + - $ref: '#/components/schemas/_common:WaitForActiveShardOptions' + _common:WaitForEvents: + type: string + enum: + - immediate + - urgent + - high + - normal + - low + - languid + _common:WarmerStats: + type: object + properties: + current: + type: number + total: + type: number + total_time: + $ref: '#/components/schemas/_common:Duration' + total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - current + - total + - total_time_in_millis + _common:WktGeoBounds: + type: object + properties: + wkt: + type: string + required: + - wkt + _common:WriteResponseBase: + type: object + properties: + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' + _primary_term: + type: number + result: + $ref: '#/components/schemas/_common:Result' + _seq_no: + $ref: '#/components/schemas/_common:SequenceNumber' + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + _version: + $ref: '#/components/schemas/_common:VersionNumber' + forced_refresh: + type: boolean + required: + - _id + - _index + - _primary_term + - result + - _seq_no + - _shards + - _version + _common:byte: + type: number + _common:short: + type: number + _common:uint: + type: number + _common:ulong: + type: number + _core._common:DeletedPit: + type: object + properties: + successful: + type: boolean + pit_id: + type: string + _core._common:PitDetail: + type: object + properties: + pit_id: + type: string + creation_time: + type: integer + format: int64 + keep_alive: + type: integer + format: int64 + _core._common:PitsDetailsDeleteAll: + type: object + properties: + successful: + type: boolean + pit_id: + type: string + _core._common:ShardStatistics: + type: object + properties: + total: + type: integer + format: int32 + successful: + type: integer + format: int32 + skipped: + type: integer + format: int32 + failed: + type: integer + format: int32 + _core.bulk:CreateOperation: + allOf: + - $ref: '#/components/schemas/_core.bulk:WriteOperation' + - type: object + _core.bulk:DeleteOperation: + allOf: + - $ref: '#/components/schemas/_core.bulk:OperationBase' + - type: object + _core.bulk:IndexOperation: + allOf: + - $ref: '#/components/schemas/_core.bulk:WriteOperation' + - type: object + _core.bulk:OperationBase: + type: object + properties: + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' + routing: + $ref: '#/components/schemas/_common:Routing' + if_primary_term: + type: number + if_seq_no: + $ref: '#/components/schemas/_common:SequenceNumber' + version: + $ref: '#/components/schemas/_common:VersionNumber' + version_type: + $ref: '#/components/schemas/_common:VersionType' + _core.bulk:OperationContainer: + type: object + properties: + index: + $ref: '#/components/schemas/_core.bulk:IndexOperation' + create: + $ref: '#/components/schemas/_core.bulk:CreateOperation' + update: + $ref: '#/components/schemas/_core.bulk:UpdateOperation' + delete: + $ref: '#/components/schemas/_core.bulk:DeleteOperation' + minProperties: 1 + maxProperties: 1 + _core.bulk:ResponseItem: + type: object + properties: + _id: + description: The document ID associated with the operation. + oneOf: + - type: string + - nullable: true + type: string + _index: + description: |- + Name of the index associated with the operation. + If the operation targeted a data stream, this is the backing index into which the document was written. + type: string + status: + description: HTTP status code returned for the operation. + type: number + error: + $ref: '#/components/schemas/_common:ErrorCause' + _primary_term: + description: The primary term assigned to the document for the operation. + type: number + result: + description: |- + Result of the operation. + Successful values are `created`, `deleted`, and `updated`. + type: string + _seq_no: + $ref: '#/components/schemas/_common:SequenceNumber' + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + _version: + $ref: '#/components/schemas/_common:VersionNumber' + forced_refresh: + type: boolean + get: + $ref: '#/components/schemas/_common:InlineGetDictUserDefined' + required: + - _index + - status + _core.bulk:UpdateAction: + type: object + properties: + detect_noop: + description: |- + Set to false to disable setting 'result' in the response + to 'noop' if no change to the document occurred. + type: boolean + doc: + description: A partial update to an existing document. + type: object + doc_as_upsert: + description: Set to true to use the contents of 'doc' as the value of 'upsert' + type: boolean + script: + $ref: '#/components/schemas/_common:Script' + scripted_upsert: + description: Set to true to execute the script whether or not the document exists. + type: boolean + _source: + $ref: '#/components/schemas/_core.search:SourceConfig' + upsert: + description: |- + 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. + type: object + _core.bulk:UpdateOperation: + allOf: + - $ref: '#/components/schemas/_core.bulk:OperationBase' + - type: object + properties: + require_alias: + description: If `true`, the request’s actions must target an index alias. + type: boolean + retry_on_conflict: + type: number + _core.bulk:WriteOperation: + allOf: + - $ref: '#/components/schemas/_core.bulk:OperationBase' + - type: object + properties: + dynamic_templates: + description: |- + A map from the full name of fields to the name of dynamic templates. + Defaults to an empty map. + If a name matches a dynamic template, then that template will be applied regardless of other match predicates defined in the template. + If a field is already defined in the mapping, then this parameter won’t be used. + type: object + additionalProperties: + type: string + pipeline: + description: |- + ID of the pipeline to use to preprocess incoming documents. + If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. + If a final pipeline is configured it will always run, regardless of the value of this parameter. + type: string + require_alias: + description: If `true`, the request’s actions must target an index alias. + type: boolean + _core.explain:Explanation: + type: object + properties: + description: + type: string + details: + type: array + items: + $ref: '#/components/schemas/_core.explain:ExplanationDetail' + value: + type: number + required: + - description + - details + - value + _core.explain:ExplanationDetail: + type: object + properties: + description: + type: string + details: + type: array + items: + $ref: '#/components/schemas/_core.explain:ExplanationDetail' + value: + type: number + required: + - description + - value + _core.field_caps:FieldCapability: + type: object + properties: + aggregatable: + description: Whether this field can be aggregated on all indices. + type: boolean + indices: + $ref: '#/components/schemas/_common:Indices' + meta: + $ref: '#/components/schemas/_common:Metadata' + non_aggregatable_indices: + $ref: '#/components/schemas/_common:Indices' + non_searchable_indices: + $ref: '#/components/schemas/_common:Indices' + searchable: + description: Whether this field is indexed for search on all indices. + type: boolean + type: + type: string + metadata_field: + description: Whether this field is registered as a metadata field. + type: boolean + time_series_dimension: + description: Whether this field is used as a time series dimension. + type: boolean + time_series_metric: + $ref: '#/components/schemas/_common.mapping:TimeSeriesMetricType' + non_dimension_indices: + description: |- + If this list is present in response then some indices have the + field marked as a dimension and other indices, the ones in this list, do not. + type: array + items: + $ref: '#/components/schemas/_common:IndexName' + metric_conflicts_indices: + description: |- + The list of indices where this field is present if these indices + don’t have the same `time_series_metric` value for this field. + type: array + items: + $ref: '#/components/schemas/_common:IndexName' + required: + - aggregatable + - searchable + - type + _core.get:GetResult: + type: object + properties: + _index: + $ref: '#/components/schemas/_common:IndexName' + fields: + type: object + additionalProperties: + type: object + found: + type: boolean + _id: + $ref: '#/components/schemas/_common:Id' + _primary_term: + type: number + _routing: + type: string + _seq_no: + $ref: '#/components/schemas/_common:SequenceNumber' + _source: + type: object + _version: + $ref: '#/components/schemas/_common:VersionNumber' + required: + - _index + - found + - _id + _core.get_script_context:Context: + type: object + properties: + methods: + type: array + items: + $ref: '#/components/schemas/_core.get_script_context:ContextMethod' + name: + $ref: '#/components/schemas/_common:Name' + required: + - methods + - name + _core.get_script_context:ContextMethod: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + return_type: + type: string + params: + type: array + items: + $ref: '#/components/schemas/_core.get_script_context:ContextMethodParam' + required: + - name + - return_type + - params + _core.get_script_context:ContextMethodParam: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + type: + type: string + required: + - name + - type + _core.get_script_languages:LanguageContext: + type: object + properties: + contexts: + type: array + items: + type: string + language: + $ref: '#/components/schemas/_common:ScriptLanguage' + required: + - contexts + - language + _core.mget:MultiGetError: + type: object + properties: + error: + $ref: '#/components/schemas/_common:ErrorCause' + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' + required: + - error + - _id + - _index + _core.mget:Operation: + type: object + properties: + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' + routing: + $ref: '#/components/schemas/_common:Routing' + _source: + $ref: '#/components/schemas/_core.search:SourceConfig' + stored_fields: + $ref: '#/components/schemas/_common:Fields' + version: + $ref: '#/components/schemas/_common:VersionNumber' + version_type: + $ref: '#/components/schemas/_common:VersionType' + required: + - _id + _core.mget:ResponseItem: + oneOf: + - $ref: '#/components/schemas/_core.get:GetResult' + - $ref: '#/components/schemas/_core.mget:MultiGetError' + _core.msearch:MultiSearchItem: + allOf: + - $ref: '#/components/schemas/_core.search:ResponseBody' + - type: object + properties: + status: + type: number + _core.msearch:MultiSearchResult: + type: object + properties: + took: + type: number + responses: + type: array + items: + $ref: '#/components/schemas/_core.msearch:ResponseItem' + required: + - took + - responses + _core.msearch:MultisearchBody: + type: object + properties: + aggregations: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:AggregationContainer' + collapse: + $ref: '#/components/schemas/_core.search:FieldCollapse' + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + explain: + description: If true, returns detailed information about score computation as part of a hit. + type: boolean + ext: + description: Configuration of search extensions defined by Opensearch plugins. + type: object + additionalProperties: + type: object + stored_fields: + $ref: '#/components/schemas/_common:Fields' + docvalue_fields: + description: |- + Array of wildcard (*) patterns. The request returns doc values for field + names matching these patterns in the hits.fields property of the response. + type: array + items: + $ref: '#/components/schemas/_common.query_dsl:FieldAndFormat' + knn: + description: Defines the approximate kNN search to run. + oneOf: + - $ref: '#/components/schemas/_common:KnnQuery' + - type: array + items: + $ref: '#/components/schemas/_common:KnnQuery' + from: + description: |- + 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. + type: number + highlight: + $ref: '#/components/schemas/_core.search:Highlight' + indices_boost: + description: Boosts the _score of documents from specified indices. + type: array + items: + type: object + additionalProperties: + type: number + min_score: + description: |- + Minimum _score for matching documents. Documents with a lower _score are + not included in the search results. + type: number + post_filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + profile: + type: boolean + rescore: + oneOf: + - $ref: '#/components/schemas/_core.search:Rescore' + - type: array + items: + $ref: '#/components/schemas/_core.search:Rescore' + script_fields: + description: Retrieve a script evaluation (based on different fields) for each hit. + type: object + additionalProperties: + $ref: '#/components/schemas/_common:ScriptField' + search_after: + $ref: '#/components/schemas/_common:SortResults' + size: + description: |- + 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. + type: number + sort: + $ref: '#/components/schemas/_common:Sort' + _source: + $ref: '#/components/schemas/_core.search:SourceConfig' + fields: + description: |- + Array of wildcard (*) patterns. The request returns values for field names + matching these patterns in the hits.fields property of the response. + type: array + items: + $ref: '#/components/schemas/_common.query_dsl:FieldAndFormat' + terminate_after: + description: |- + Maximum number of documents to collect for each shard. If a query reaches this + limit, Opensearch terminates the query early. Opensearch collects documents + before sorting. Defaults to 0, which does not terminate query execution early. + type: number + stats: + description: |- + 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. + type: array + items: + type: string + timeout: + description: |- + 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. + type: string + track_scores: + description: If true, calculate and return document scores, even if the scores are not used for sorting. + type: boolean + track_total_hits: + $ref: '#/components/schemas/_core.search:TrackHits' + version: + description: If true, returns document version as part of a hit. + type: boolean + runtime_mappings: + $ref: '#/components/schemas/_common.mapping:RuntimeFields' + seq_no_primary_term: + description: |- + If true, returns sequence number and primary term of the last modification + of each hit. See Optimistic concurrency control. + type: boolean + pit: + $ref: '#/components/schemas/_core.search:PointInTimeReference' + suggest: + $ref: '#/components/schemas/_core.search:Suggester' + _core.msearch:MultisearchHeader: + type: object + properties: + allow_no_indices: + type: boolean + expand_wildcards: + $ref: '#/components/schemas/_common:ExpandWildcards' + ignore_unavailable: + type: boolean + index: + $ref: '#/components/schemas/_common:Indices' + preference: + type: string + request_cache: + type: boolean + routing: + $ref: '#/components/schemas/_common:Routing' + search_type: + $ref: '#/components/schemas/_common:SearchType' + ccs_minimize_roundtrips: + type: boolean + allow_partial_search_results: + type: boolean + ignore_throttled: + type: boolean + _core.msearch:RequestItem: + oneOf: + - $ref: '#/components/schemas/_core.msearch:MultisearchHeader' + - $ref: '#/components/schemas/_core.msearch:MultisearchBody' + _core.msearch:ResponseItem: + oneOf: + - $ref: '#/components/schemas/_core.msearch:MultiSearchItem' + - $ref: '#/components/schemas/_common:ErrorResponseBase' + _core.msearch_template:RequestItem: + oneOf: + - $ref: '#/components/schemas/_core.msearch:MultisearchHeader' + - $ref: '#/components/schemas/_core.msearch_template:TemplateConfig' + _core.msearch_template:TemplateConfig: + type: object + properties: + explain: + description: If `true`, returns detailed information about score calculation as part of each hit. + type: boolean + id: + $ref: '#/components/schemas/_common:Id' + params: + description: |- + Key-value pairs used to replace Mustache variables in the template. + The key is the variable name. + The value is the variable value. + type: object + additionalProperties: + type: object + profile: + description: If `true`, the query execution is profiled. + type: boolean + source: + description: |- + 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. + type: string + _core.mtermvectors:Operation: + type: object + properties: + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' + doc: + description: An artificial document (a document not present in the index) for which you want to retrieve term vectors. + type: object + fields: + $ref: '#/components/schemas/_common:Fields' + field_statistics: + description: If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. + type: boolean + filter: + $ref: '#/components/schemas/_core.termvectors:Filter' + offsets: + description: If `true`, the response includes term offsets. + type: boolean + payloads: + description: If `true`, the response includes term payloads. + type: boolean + positions: + description: If `true`, the response includes term positions. + type: boolean + routing: + $ref: '#/components/schemas/_common:Routing' + term_statistics: + description: If true, the response includes term frequency and document frequency. + type: boolean + version: + $ref: '#/components/schemas/_common:VersionNumber' + version_type: + $ref: '#/components/schemas/_common:VersionType' + required: + - _id + _core.mtermvectors:TermVectorsResult: + type: object + properties: + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' + _version: + $ref: '#/components/schemas/_common:VersionNumber' + took: + type: number + found: + type: boolean + term_vectors: + type: object + additionalProperties: + $ref: '#/components/schemas/_core.termvectors:TermVector' + error: + $ref: '#/components/schemas/_common:ErrorCause' + required: + - _id + - _index + _core.rank_eval:DocumentRating: + type: object + properties: + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' + rating: + description: The document’s relevance with regard to this search request. + type: number + required: + - _id + - _index + - rating + _core.rank_eval:RankEvalHit: + type: object + properties: + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' + _score: + type: number + required: + - _id + - _index + - _score + _core.rank_eval:RankEvalHitItem: + type: object + properties: + hit: + $ref: '#/components/schemas/_core.rank_eval:RankEvalHit' + rating: + oneOf: + - type: number + - nullable: true + type: string + required: + - hit + _core.rank_eval:RankEvalMetric: + type: object + properties: + precision: + $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricPrecision' + recall: + $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricRecall' + mean_reciprocal_rank: + $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricMeanReciprocalRank' + dcg: + $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricDiscountedCumulativeGain' + expected_reciprocal_rank: + $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricExpectedReciprocalRank' + _core.rank_eval:RankEvalMetricBase: + type: object + properties: + k: + description: Sets the maximum number of documents retrieved per query. This value will act in place of the usual size parameter in the query. + type: number + _core.rank_eval:RankEvalMetricDetail: + type: object + properties: + metric_score: + description: The metric_score in the details section shows the contribution of this query to the global quality metric score + type: number + unrated_docs: + description: The unrated_docs section contains an _index and _id entry for each document in the search result for this query that didn’t have a ratings value. This can be used to ask the user to supply ratings for these documents + type: array + items: + $ref: '#/components/schemas/_core.rank_eval:UnratedDocument' + hits: + description: The hits section shows a grouping of the search results with their supplied ratings + type: array + items: + $ref: '#/components/schemas/_core.rank_eval:RankEvalHitItem' + metric_details: + description: The metric_details give additional information about the calculated quality metric (e.g. how many of the retrieved documents were relevant). The content varies for each metric but allows for better interpretation of the results + type: object + additionalProperties: + type: object + additionalProperties: + type: object + required: + - metric_score + - unrated_docs + - hits + - metric_details + _core.rank_eval:RankEvalMetricDiscountedCumulativeGain: + allOf: + - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricBase' + - type: object + properties: + normalize: + externalDocs: + url: https://en.wikipedia.org/wiki/Discounted_cumulative_gain#Normalized_DCG + description: If set to true, this metric will calculate the Normalized DCG. + type: boolean + _core.rank_eval:RankEvalMetricExpectedReciprocalRank: + allOf: + - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricBase' + - type: object + properties: + maximum_relevance: + description: The highest relevance grade used in the user-supplied relevance judgments. + type: number + required: + - maximum_relevance + _core.rank_eval:RankEvalMetricMeanReciprocalRank: + allOf: + - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricRatingTreshold' + - type: object + _core.rank_eval:RankEvalMetricPrecision: + allOf: + - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricRatingTreshold' + - type: object + properties: + ignore_unlabeled: + description: Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as irrelevant. + type: boolean + _core.rank_eval:RankEvalMetricRatingTreshold: + allOf: + - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricBase' + - type: object + properties: + relevant_rating_threshold: + description: Sets the rating threshold above which documents are considered to be "relevant". + type: number + _core.rank_eval:RankEvalMetricRecall: + allOf: + - $ref: '#/components/schemas/_core.rank_eval:RankEvalMetricRatingTreshold' + - type: object + _core.rank_eval:RankEvalQuery: + type: object + properties: + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + size: + type: number + required: + - query + _core.rank_eval:RankEvalRequestItem: + type: object + properties: + id: + $ref: '#/components/schemas/_common:Id' + request: + $ref: '#/components/schemas/_core.rank_eval:RankEvalQuery' + ratings: + description: List of document ratings + type: array + items: + $ref: '#/components/schemas/_core.rank_eval:DocumentRating' + template_id: + $ref: '#/components/schemas/_common:Id' + params: + description: The search template parameters. + type: object + additionalProperties: + type: object + required: + - id + - ratings + _core.rank_eval:UnratedDocument: + type: object + properties: + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' + required: + - _id + - _index + _core.reindex:Destination: + type: object + properties: + index: + $ref: '#/components/schemas/_common:IndexName' + op_type: + $ref: '#/components/schemas/_common:OpType' + pipeline: + description: The name of the pipeline to use. + type: string + routing: + $ref: '#/components/schemas/_common:Routing' + version_type: + $ref: '#/components/schemas/_common:VersionType' + required: + - index + _core.reindex:RemoteSource: + type: object + properties: + connect_timeout: + $ref: '#/components/schemas/_common:Duration' + headers: + description: An object containing the headers of the request. + type: object + additionalProperties: + type: string + host: + $ref: '#/components/schemas/_common:Host' + username: + $ref: '#/components/schemas/_common:Username' + password: + $ref: '#/components/schemas/_common:Password' + socket_timeout: + $ref: '#/components/schemas/_common:Duration' + required: + - host + _core.reindex:Source: + type: object + properties: + index: + $ref: '#/components/schemas/_common:Indices' + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + remote: + $ref: '#/components/schemas/_core.reindex:RemoteSource' + size: + description: |- + The number of documents to index per batch. + Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. + type: number + slice: + $ref: '#/components/schemas/_common:SlicedScroll' + sort: + $ref: '#/components/schemas/_common:Sort' + _source: + $ref: '#/components/schemas/_common:Fields' + runtime_mappings: + $ref: '#/components/schemas/_common.mapping:RuntimeFields' + required: + - index + _core.reindex_rethrottle:ReindexNode: + allOf: + - $ref: '#/components/schemas/_common:BaseNode' + - type: object + properties: + tasks: + type: object + additionalProperties: + $ref: '#/components/schemas/_core.reindex_rethrottle:ReindexTask' + required: + - tasks + _core.reindex_rethrottle:ReindexStatus: + type: object + properties: + batches: + description: The number of scroll responses pulled back by the reindex. + type: number + created: + description: The number of documents that were successfully created. + type: number + deleted: + description: The number of documents that were successfully deleted. + type: number + noops: + description: The number of documents that were ignored because the script used for the reindex returned a `noop` value for `ctx.op`. + type: number + requests_per_second: + description: The number of requests per second effectively executed during the reindex. + type: number + retries: + $ref: '#/components/schemas/_common:Retries' + throttled: + $ref: '#/components/schemas/_common:Duration' + throttled_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + throttled_until: + $ref: '#/components/schemas/_common:Duration' + throttled_until_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total: + description: The number of documents that were successfully processed. + type: number + updated: + description: The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it. + type: number + version_conflicts: + description: The number of version conflicts that reindex hits. + type: number + required: + - batches + - created + - deleted + - noops + - requests_per_second + - retries + - throttled_millis + - throttled_until_millis + - total + - updated + - version_conflicts + _core.reindex_rethrottle:ReindexTask: + type: object + properties: + action: + type: string + cancellable: + type: boolean + description: + type: string + id: + type: number + node: + $ref: '#/components/schemas/_common:Name' + running_time_in_nanos: + $ref: '#/components/schemas/_common:DurationValueUnitNanos' + start_time_in_millis: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + status: + $ref: '#/components/schemas/_core.reindex_rethrottle:ReindexStatus' + type: + type: string + headers: + $ref: '#/components/schemas/_common:HttpHeaders' + required: + - action + - cancellable + - description + - id + - node + - running_time_in_nanos + - start_time_in_millis + - status + - type + - headers + _core.scripts_painless_execute:PainlessContextSetup: + type: object + properties: + document: + description: Document that’s temporarily indexed in-memory and accessible from the script. + type: object + index: + $ref: '#/components/schemas/_common:IndexName' + query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + required: + - document + - index + - query + _core.search:AggregationBreakdown: + type: object + properties: + build_aggregation: + type: number + build_aggregation_count: + type: number + build_leaf_collector: + type: number + build_leaf_collector_count: + type: number + collect: + type: number + collect_count: + type: number + initialize: + type: number + initialize_count: + type: number + post_collection: + type: number + post_collection_count: + type: number + reduce: + type: number + reduce_count: + type: number + required: + - build_aggregation + - build_aggregation_count + - build_leaf_collector + - build_leaf_collector_count + - collect + - collect_count + - initialize + - initialize_count + - reduce + - reduce_count + _core.search:AggregationProfile: + type: object + properties: + breakdown: + $ref: '#/components/schemas/_core.search:AggregationBreakdown' + description: + type: string + time_in_nanos: + $ref: '#/components/schemas/_common:DurationValueUnitNanos' + type: + type: string + debug: + $ref: '#/components/schemas/_core.search:AggregationProfileDebug' + children: + type: array + items: + $ref: '#/components/schemas/_core.search:AggregationProfile' + required: + - breakdown + - description + - time_in_nanos + - type + _core.search:AggregationProfileDebug: + type: object + properties: + segments_with_multi_valued_ords: + type: number + collection_strategy: + type: string + segments_with_single_valued_ords: + type: number + total_buckets: + type: number + built_buckets: + type: number + result_strategy: + type: string + has_filter: + type: boolean + delegate: + type: string + delegate_debug: + $ref: '#/components/schemas/_core.search:AggregationProfileDebug' + chars_fetched: + type: number + extract_count: + type: number + extract_ns: + type: number + values_fetched: + type: number + collect_analyzed_ns: + type: number + collect_analyzed_count: + type: number + surviving_buckets: + type: number + ordinals_collectors_used: + type: number + ordinals_collectors_overhead_too_high: + type: number + string_hashing_collectors_used: + type: number + numeric_collectors_used: + type: number + empty_collectors_used: + type: number + deferred_aggregators: + type: array + items: + type: string + segments_with_doc_count_field: + type: number + segments_with_deleted_docs: + type: number + filters: + type: array + items: + $ref: '#/components/schemas/_core.search:AggregationProfileDelegateDebugFilter' + segments_counted: + type: number + segments_collected: + type: number + map_reducer: + type: string + _core.search:AggregationProfileDelegateDebugFilter: + type: object + properties: + results_from_metadata: + type: number + query: + type: string + specialized_for: + type: string + segments_counted_in_constant_time: + type: number + _core.search:BoundaryScanner: + type: string + enum: + - chars + - sentence + - word + _core.search:Collector: + type: object + properties: + name: + type: string + reason: + type: string + time_in_nanos: + $ref: '#/components/schemas/_common:DurationValueUnitNanos' + children: + type: array + items: + $ref: '#/components/schemas/_core.search:Collector' + required: + - name + - reason + - time_in_nanos + _core.search:CompletionSuggest: + allOf: + - $ref: '#/components/schemas/_core.search:SuggestBase' + - type: object + properties: + options: + oneOf: + - $ref: '#/components/schemas/_core.search:CompletionSuggestOption' + - type: array + items: + $ref: '#/components/schemas/_core.search:CompletionSuggestOption' + required: + - options + _core.search:CompletionSuggestOption: + type: object + properties: + collate_match: + type: boolean + contexts: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/_core.search:Context' + fields: + type: object + additionalProperties: + type: object + _id: + type: string + _index: + $ref: '#/components/schemas/_common:IndexName' + _routing: + $ref: '#/components/schemas/_common:Routing' + _score: + type: number + _source: + type: object + text: + type: string + score: + type: number + required: + - text + _core.search:Context: + description: Text or location that we want similar documents for or a lookup to a document's field for the text. + oneOf: + - type: string + - $ref: '#/components/schemas/_common:GeoLocation' + _core.search:FetchProfile: + type: object + properties: + type: + type: string + description: + type: string + time_in_nanos: + $ref: '#/components/schemas/_common:DurationValueUnitNanos' + breakdown: + $ref: '#/components/schemas/_core.search:FetchProfileBreakdown' + debug: + $ref: '#/components/schemas/_core.search:FetchProfileDebug' + children: + type: array + items: + $ref: '#/components/schemas/_core.search:FetchProfile' + required: + - type + - description + - time_in_nanos + - breakdown + _core.search:FetchProfileBreakdown: + type: object + properties: + load_source: + type: number + load_source_count: + type: number + load_stored_fields: + type: number + load_stored_fields_count: + type: number + next_reader: + type: number + next_reader_count: + type: number + process_count: + type: number + process: + type: number + _core.search:FetchProfileDebug: + type: object + properties: + stored_fields: + type: array + items: + type: string + fast_path: + type: number + _core.search:FieldCollapse: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + inner_hits: + description: The number of inner hits and their sort order + oneOf: + - $ref: '#/components/schemas/_core.search:InnerHits' + - type: array + items: + $ref: '#/components/schemas/_core.search:InnerHits' + max_concurrent_group_searches: + description: The number of concurrent requests allowed to retrieve the inner_hits per group + type: number + collapse: + $ref: '#/components/schemas/_core.search:FieldCollapse' + required: + - field + _core.search:Highlight: + allOf: + - $ref: '#/components/schemas/_core.search:HighlightBase' + - type: object + properties: + encoder: + $ref: '#/components/schemas/_core.search:HighlighterEncoder' + fields: + type: object + additionalProperties: + $ref: '#/components/schemas/_core.search:HighlightField' + required: + - fields + _core.search:HighlightBase: + type: object + properties: + type: + $ref: '#/components/schemas/_core.search:HighlighterType' + boundary_chars: + description: A string that contains each boundary character. + type: string + boundary_max_scan: + description: How far to scan for boundary characters. + type: number + boundary_scanner: + $ref: '#/components/schemas/_core.search:BoundaryScanner' + boundary_scanner_locale: + description: |- + Controls which locale is used to search for sentence and word boundaries. + This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. + type: string + force_source: + deprecated: true + type: boolean + fragmenter: + $ref: '#/components/schemas/_core.search:HighlighterFragmenter' + fragment_size: + description: The size of the highlighted fragment in characters. + type: number + highlight_filter: + type: boolean + highlight_query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + max_fragment_length: + type: number + max_analyzed_offset: + description: |- + If set to a non-negative value, highlighting stops at this defined maximum limit. + The rest of the text is not processed, thus not highlighted and no error is returned + The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. + type: number + no_match_size: + description: The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight. + type: number + number_of_fragments: + description: |- + The maximum number of fragments to return. + If the number of fragments is set to `0`, no fragments are returned. + Instead, the entire field contents are highlighted and returned. + This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. + If `number_of_fragments` is `0`, `fragment_size` is ignored. + type: number + options: + type: object + additionalProperties: + type: object + order: + $ref: '#/components/schemas/_core.search:HighlighterOrder' + phrase_limit: + description: |- + Controls the number of matching phrases in a document that are considered. + Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory. + When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory. + Only supported by the `fvh` highlighter. + type: number + post_tags: + description: |- + Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text. + By default, highlighted text is wrapped in `` and `` tags. + type: array + items: + type: string + pre_tags: + description: |- + Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text. + By default, highlighted text is wrapped in `` and `` tags. + type: array + items: + type: string + require_field_match: + description: |- + By default, only fields that contains a query match are highlighted. + Set to `false` to highlight all fields. + type: boolean + tags_schema: + $ref: '#/components/schemas/_core.search:HighlighterTagsSchema' + _core.search:HighlightField: + allOf: + - $ref: '#/components/schemas/_core.search:HighlightBase' + - type: object + properties: + fragment_offset: + type: number + matched_fields: + $ref: '#/components/schemas/_common:Fields' + analyzer: + $ref: '#/components/schemas/_common.analysis:Analyzer' + _core.search:HighlighterEncoder: + type: string + enum: + - default + - html + _core.search:HighlighterFragmenter: + type: string + enum: + - simple + - span + _core.search:HighlighterOrder: + type: string + enum: + - score + _core.search:HighlighterTagsSchema: + type: string + enum: + - styled + _core.search:HighlighterType: + type: string + enum: + - plain + - fvh + - unified + _core.search:Hit: + type: object + properties: + _index: + $ref: '#/components/schemas/_common:IndexName' + _id: + $ref: '#/components/schemas/_common:Id' + _score: + oneOf: + - type: number + - nullable: true + type: string + _explanation: + $ref: '#/components/schemas/_core.explain:Explanation' + fields: + type: object + additionalProperties: + type: object + highlight: + type: object + additionalProperties: + type: array + items: + type: string + inner_hits: + type: object + additionalProperties: + $ref: '#/components/schemas/_core.search:InnerHitsResult' + matched_queries: + type: array + items: + type: string + _nested: + $ref: '#/components/schemas/_core.search:NestedIdentity' + _ignored: + type: array + items: + type: string + ignored_field_values: + type: object + additionalProperties: + type: array + items: + type: string + _shard: + type: string + _node: + type: string + _routing: + type: string + _source: + type: object + _seq_no: + $ref: '#/components/schemas/_common:SequenceNumber' + _primary_term: + type: number + _version: + $ref: '#/components/schemas/_common:VersionNumber' + sort: + $ref: '#/components/schemas/_common:SortResults' + required: + - _index + - _id + _core.search:HitsMetadata: + type: object + properties: + total: + description: Total hit count information, present only if `track_total_hits` wasn't `false` in the search request. + oneOf: + - $ref: '#/components/schemas/_core.search:TotalHits' + - type: number + hits: + type: array + items: + $ref: '#/components/schemas/_core.search:Hit' + max_score: + oneOf: + - type: number + - nullable: true + type: string + required: + - hits + _core.search:InnerHits: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + size: + description: The maximum number of hits to return per `inner_hits`. + type: number + from: + description: Inner hit starting document offset. + type: number + collapse: + $ref: '#/components/schemas/_core.search:FieldCollapse' + docvalue_fields: + type: array + items: + $ref: '#/components/schemas/_common.query_dsl:FieldAndFormat' + explain: + type: boolean + highlight: + $ref: '#/components/schemas/_core.search:Highlight' + ignore_unmapped: + type: boolean + script_fields: + type: object + additionalProperties: + $ref: '#/components/schemas/_common:ScriptField' + seq_no_primary_term: + type: boolean + fields: + $ref: '#/components/schemas/_common:Fields' + sort: + $ref: '#/components/schemas/_common:Sort' + _source: + $ref: '#/components/schemas/_core.search:SourceConfig' + stored_field: + $ref: '#/components/schemas/_common:Fields' + track_scores: + type: boolean + version: + type: boolean + _core.search:InnerHitsResult: + type: object + properties: + hits: + $ref: '#/components/schemas/_core.search:HitsMetadata' + required: + - hits + _core.search:NestedIdentity: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + offset: + type: number + _nested: + $ref: '#/components/schemas/_core.search:NestedIdentity' + required: + - field + - offset + _core.search:PhraseSuggest: + allOf: + - $ref: '#/components/schemas/_core.search:SuggestBase' + - type: object + properties: + options: + oneOf: + - $ref: '#/components/schemas/_core.search:PhraseSuggestOption' + - type: array + items: + $ref: '#/components/schemas/_core.search:PhraseSuggestOption' + required: + - options + _core.search:PhraseSuggestOption: + type: object + properties: + text: + type: string + score: + type: number + highlighted: + type: string + collate_match: + type: boolean + required: + - text + - score + _core.search:PointInTimeReference: + type: object + properties: + id: + $ref: '#/components/schemas/_common:Id' + keep_alive: + $ref: '#/components/schemas/_common:Duration' + required: + - id + _core.search:Profile: + type: object + properties: + shards: + type: array + items: + $ref: '#/components/schemas/_core.search:ShardProfile' + required: + - shards + _core.search:QueryBreakdown: + type: object + properties: + advance: + type: number + advance_count: + type: number + build_scorer: + type: number + build_scorer_count: + type: number + create_weight: + type: number + create_weight_count: + type: number + match: + type: number + match_count: + type: number + shallow_advance: + type: number + shallow_advance_count: + type: number + next_doc: + type: number + next_doc_count: + type: number + score: + type: number + score_count: + type: number + compute_max_score: + type: number + compute_max_score_count: + type: number + set_min_competitive_score: + type: number + set_min_competitive_score_count: + type: number + required: + - advance + - advance_count + - build_scorer + - build_scorer_count + - create_weight + - create_weight_count + - match + - match_count + - shallow_advance + - shallow_advance_count + - next_doc + - next_doc_count + - score + - score_count + - compute_max_score + - compute_max_score_count + - set_min_competitive_score + - set_min_competitive_score_count + _core.search:QueryProfile: + type: object + properties: + breakdown: + $ref: '#/components/schemas/_core.search:QueryBreakdown' + description: + type: string + time_in_nanos: + $ref: '#/components/schemas/_common:DurationValueUnitNanos' + type: + type: string + children: + type: array + items: + $ref: '#/components/schemas/_core.search:QueryProfile' + required: + - breakdown + - description + - time_in_nanos + - type + _core.search:Rescore: + type: object + properties: + query: + $ref: '#/components/schemas/_core.search:RescoreQuery' + window_size: + type: number + required: + - query + _core.search:RescoreQuery: + type: object + properties: + rescore_query: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + query_weight: + description: Relative importance of the original query versus the rescore query. + type: number + rescore_query_weight: + description: Relative importance of the rescore query versus the original query. + type: number + score_mode: + $ref: '#/components/schemas/_core.search:ScoreMode' + required: + - rescore_query + _core.search:ResponseBody: + type: object + properties: + took: + type: number + timed_out: + type: boolean + _shards: + $ref: '#/components/schemas/_common:ShardStatistics' + hits: + $ref: '#/components/schemas/_core.search:HitsMetadata' + aggregations: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.aggregations:Aggregate' + _clusters: + $ref: '#/components/schemas/_common:ClusterStatistics' + fields: + type: object + additionalProperties: + type: object + max_score: + type: number + num_reduce_phases: + type: number + profile: + $ref: '#/components/schemas/_core.search:Profile' + pit_id: + $ref: '#/components/schemas/_common:Id' + _scroll_id: + $ref: '#/components/schemas/_common:ScrollId' + suggest: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/_core.search:Suggest' + terminated_early: + type: boolean + required: + - took + - timed_out + - _shards + - hits + _core.search:ScoreMode: + type: string + enum: + - avg + - max + - min + - multiply + - total + _core.search:SearchProfile: + type: object + properties: + collector: + type: array + items: + $ref: '#/components/schemas/_core.search:Collector' + query: + type: array + items: + $ref: '#/components/schemas/_core.search:QueryProfile' + rewrite_time: + type: number + required: + - collector + - query + - rewrite_time + _core.search:ShardProfile: + type: object + properties: + aggregations: + type: array + items: + $ref: '#/components/schemas/_core.search:AggregationProfile' + id: + type: string + searches: + type: array + items: + $ref: '#/components/schemas/_core.search:SearchProfile' + fetch: + $ref: '#/components/schemas/_core.search:FetchProfile' + required: + - aggregations + - id + - searches + _core.search:SourceConfig: + description: Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. + oneOf: + - type: boolean + - $ref: '#/components/schemas/_core.search:SourceFilter' + _core.search:SourceConfigParam: + description: |- + 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. + oneOf: + - type: boolean + - $ref: '#/components/schemas/_common:Fields' + _core.search:SourceFilter: + type: object + properties: + excludes: + $ref: '#/components/schemas/_common:Fields' + includes: + $ref: '#/components/schemas/_common:Fields' + _core.search:Suggest: + oneOf: + - $ref: '#/components/schemas/_core.search:CompletionSuggest' + - $ref: '#/components/schemas/_core.search:PhraseSuggest' + - $ref: '#/components/schemas/_core.search:TermSuggest' + _core.search:SuggestBase: + type: object + properties: + length: + type: number + offset: + type: number + text: + type: string + required: + - length + - offset + - text + _core.search:Suggester: + type: object + properties: + text: + description: Global suggest text, to avoid repetition when the same text is used in several suggesters + type: string + _core.search:TermSuggest: + allOf: + - $ref: '#/components/schemas/_core.search:SuggestBase' + - type: object + properties: + options: + oneOf: + - $ref: '#/components/schemas/_core.search:TermSuggestOption' + - type: array + items: + $ref: '#/components/schemas/_core.search:TermSuggestOption' + required: + - options + _core.search:TermSuggestOption: + type: object + properties: + text: + type: string + score: + type: number + freq: + type: number + highlighted: + type: string + collate_match: + type: boolean + required: + - text + - score + - freq + _core.search:TotalHits: + type: object + properties: + relation: + $ref: '#/components/schemas/_core.search:TotalHitsRelation' + value: + type: number + required: + - relation + - value + _core.search:TotalHitsRelation: + type: string + enum: + - eq + - gte + _core.search:TrackHits: + description: |- + 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. + oneOf: + - type: boolean + - type: number + _core.search_shards:ShardStoreIndex: + type: object + properties: + aliases: + type: array + items: + $ref: '#/components/schemas/_common:Name' + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + _core.termvectors:FieldStatistics: + type: object + properties: + doc_count: + type: number + sum_doc_freq: + type: number + sum_ttf: + type: number + required: + - doc_count + - sum_doc_freq + - sum_ttf + _core.termvectors:Filter: + type: object + properties: + max_doc_freq: + description: |- + Ignore words which occur in more than this many docs. + Defaults to unbounded. + type: number + max_num_terms: + description: Maximum number of terms that must be returned per field. + type: number + max_term_freq: + description: |- + Ignore words with more than this frequency in the source doc. + Defaults to unbounded. + type: number + max_word_length: + description: |- + The maximum word length above which words will be ignored. + Defaults to unbounded. + type: number + min_doc_freq: + description: Ignore terms which do not occur in at least this many docs. + type: number + min_term_freq: + description: Ignore words with less than this frequency in the source doc. + type: number + min_word_length: + description: The minimum word length below which words will be ignored. + type: number + _core.termvectors:Term: + type: object + properties: + doc_freq: + type: number + score: + type: number + term_freq: + type: number + tokens: + type: array + items: + $ref: '#/components/schemas/_core.termvectors:Token' + ttf: + type: number + required: + - term_freq + _core.termvectors:TermVector: + type: object + properties: + field_statistics: + $ref: '#/components/schemas/_core.termvectors:FieldStatistics' + terms: + type: object + additionalProperties: + $ref: '#/components/schemas/_core.termvectors:Term' + required: + - field_statistics + - terms + _core.termvectors:Token: + type: object + properties: + end_offset: + type: number + payload: + type: string + position: + type: number + start_offset: + type: number + required: + - position + _core.update:UpdateWriteResponseBase: + allOf: + - $ref: '#/components/schemas/_common:WriteResponseBase' + - type: object + properties: + get: + $ref: '#/components/schemas/_common:InlineGet' + _core.update_by_query_rethrottle:UpdateByQueryRethrottleNode: + allOf: + - $ref: '#/components/schemas/_common:BaseNode' + - type: object + properties: + tasks: + type: object + additionalProperties: + $ref: '#/components/schemas/tasks._common:TaskInfo' + required: + - tasks + cat._common:CatPitSegmentsRecord: + type: object + properties: + index: + type: string + shard: + type: string + prirep: + type: string + ip: + type: string + segment: + type: string + generation: + type: string + docs.count: + type: string + docs.deleted: + type: string + size: + type: string + size.memory: + type: string + committed: + type: string + searchable: + type: string + version: + type: string + compound: + type: string + cat._common:CatSegmentReplicationRecord: + type: object + properties: + shardId: + type: string + target_node: + type: string + target_host: + type: string + checkpoints_behind: + type: string + bytes_behind: + type: string + current_lag: + type: string + last_completed_lag: + type: string + rejected_requests: + type: string + stage: + type: string + time: + type: string + files_fetched: + type: string + files_percent: + type: string + bytes_fetched: + type: string + bytes_percent: + type: string + start_time: + type: string + stop_time: + type: string + files: + type: string + files_total: + type: string + bytes: + type: string + bytes_total: + type: string + replicating_stage_time_taken: + type: string + get_checkpoint_info_stage_time_taken: + type: string + file_diff_stage_time_taken: + type: string + get_files_stage_time_taken: + type: string + finalize_replication_stage_time_taken: + type: string + cat.aliases:AliasesRecord: + type: object + properties: + alias: + description: alias name + type: string + index: + $ref: '#/components/schemas/_common:IndexName' + filter: + description: filter + type: string + routing.index: + description: index routing + type: string + routing.search: + description: search routing + type: string + is_write_index: + description: write index + type: string + cat.allocation:AllocationRecord: + type: object + properties: + shards: + description: Number of primary and replica shards assigned to the node. + type: string + disk.indices: + description: |- + Disk space used by the node’s shards. Does not include disk space for the translog or unassigned shards. + IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index. + oneOf: + - $ref: '#/components/schemas/_common:ByteSize' + - nullable: true + type: string + disk.used: + description: |- + Total disk space in use. + Opensearch retrieves this metric from the node’s operating system (OS). + The metric includes disk space for: Opensearch, including the translog and unassigned shards; the node’s operating system; any other applications or files on the node. + Unlike `disk.indices`, this metric does not double-count disk space for hard-linked files. + oneOf: + - $ref: '#/components/schemas/_common:ByteSize' + - nullable: true + type: string + disk.avail: + description: |- + Free disk space available to Opensearch. + Opensearch retrieves this metric from the node’s operating system. + Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space. + oneOf: + - $ref: '#/components/schemas/_common:ByteSize' + - nullable: true + type: string + disk.total: + description: Total disk space for the node, including in-use and available space. + oneOf: + - $ref: '#/components/schemas/_common:ByteSize' + - nullable: true + type: string + disk.percent: + description: Total percentage of disk space in use. Calculated as `disk.used / disk.total`. + oneOf: + - $ref: '#/components/schemas/_common:Percentage' + - nullable: true + type: string + host: + description: Network host for the node. Set using the `network.host` setting. + oneOf: + - $ref: '#/components/schemas/_common:Host' + - nullable: true + type: string + ip: + description: IP address and port for the node. + oneOf: + - $ref: '#/components/schemas/_common:Ip' + - nullable: true + type: string + node: + description: Name for the node. Set using the `node.name` setting. + type: string + cat.count:CountRecord: + type: object + properties: + epoch: + $ref: '#/components/schemas/_common:StringifiedEpochTimeUnitSeconds' + timestamp: + $ref: '#/components/schemas/_common:TimeOfDay' + count: + description: the document count + type: string + cat.fielddata:FielddataRecord: + type: object + properties: + id: + description: node id + type: string + host: + description: host name + type: string + ip: + description: ip address + type: string + node: + description: node name + type: string + field: + description: field name + type: string + size: + description: field data usage + type: string + cat.health:HealthRecord: + type: object + properties: + epoch: + $ref: '#/components/schemas/_common:StringifiedEpochTimeUnitSeconds' + timestamp: + $ref: '#/components/schemas/_common:TimeOfDay' + cluster: + description: cluster name + type: string + status: + description: health status + type: string + node.total: + description: total number of nodes + type: string + node.data: + description: number of nodes that can store data + type: string + shards: + description: total number of shards + type: string + pri: + description: number of primary shards + type: string + relo: + description: number of relocating nodes + type: string + init: + description: number of initializing nodes + type: string + unassign: + description: number of unassigned shards + type: string + pending_tasks: + description: number of pending tasks + type: string + max_task_wait_time: + description: wait time of longest task pending + type: string + active_shards_percent: + description: active number of shards in percent + type: string + cat.help:HelpRecord: + type: object + properties: + endpoint: + type: string + required: + - endpoint + cat.indices:IndicesRecord: + type: object + properties: + health: + description: current health status + type: string + status: + description: open/close status + type: string + index: + description: index name + type: string + uuid: + description: index uuid + type: string + pri: + description: number of primary shards + type: string + rep: + description: number of replica shards + type: string + docs.count: + description: available docs + oneOf: + - type: string + - nullable: true + type: string + docs.deleted: + description: deleted docs + oneOf: + - type: string + - nullable: true + type: string + creation.date: + description: index creation date (millisecond value) + type: string + creation.date.string: + description: index creation date (as string) + type: string + store.size: + description: store size of primaries & replicas + oneOf: + - type: string + - nullable: true + type: string + pri.store.size: + description: store size of primaries + oneOf: + - type: string + - nullable: true + type: string + completion.size: + description: size of completion + type: string + pri.completion.size: + description: size of completion + type: string + fielddata.memory_size: + description: used fielddata cache + type: string + pri.fielddata.memory_size: + description: used fielddata cache + type: string + fielddata.evictions: + description: fielddata evictions + type: string + pri.fielddata.evictions: + description: fielddata evictions + type: string + query_cache.memory_size: + description: used query cache + type: string + pri.query_cache.memory_size: + description: used query cache + type: string + query_cache.evictions: + description: query cache evictions + type: string + pri.query_cache.evictions: + description: query cache evictions + type: string + request_cache.memory_size: + description: used request cache + type: string + pri.request_cache.memory_size: + description: used request cache + type: string + request_cache.evictions: + description: request cache evictions + type: string + pri.request_cache.evictions: + description: request cache evictions + type: string + request_cache.hit_count: + description: request cache hit count + type: string + pri.request_cache.hit_count: + description: request cache hit count + type: string + request_cache.miss_count: + description: request cache miss count + type: string + pri.request_cache.miss_count: + description: request cache miss count + type: string + flush.total: + description: number of flushes + type: string + pri.flush.total: + description: number of flushes + type: string + flush.total_time: + description: time spent in flush + type: string + pri.flush.total_time: + description: time spent in flush + type: string + get.current: + description: number of current get ops + type: string + pri.get.current: + description: number of current get ops + type: string + get.time: + description: time spent in get + type: string + pri.get.time: + description: time spent in get + type: string + get.total: + description: number of get ops + type: string + pri.get.total: + description: number of get ops + type: string + get.exists_time: + description: time spent in successful gets + type: string + pri.get.exists_time: + description: time spent in successful gets + type: string + get.exists_total: + description: number of successful gets + type: string + pri.get.exists_total: + description: number of successful gets + type: string + get.missing_time: + description: time spent in failed gets + type: string + pri.get.missing_time: + description: time spent in failed gets + type: string + get.missing_total: + description: number of failed gets + type: string + pri.get.missing_total: + description: number of failed gets + type: string + indexing.delete_current: + description: number of current deletions + type: string + pri.indexing.delete_current: + description: number of current deletions + type: string + indexing.delete_time: + description: time spent in deletions + type: string + pri.indexing.delete_time: + description: time spent in deletions + type: string + indexing.delete_total: + description: number of delete ops + type: string + pri.indexing.delete_total: + description: number of delete ops + type: string + indexing.index_current: + description: number of current indexing ops + type: string + pri.indexing.index_current: + description: number of current indexing ops + type: string + indexing.index_time: + description: time spent in indexing + type: string + pri.indexing.index_time: + description: time spent in indexing + type: string + indexing.index_total: + description: number of indexing ops + type: string + pri.indexing.index_total: + description: number of indexing ops + type: string + indexing.index_failed: + description: number of failed indexing ops + type: string + pri.indexing.index_failed: + description: number of failed indexing ops + type: string + merges.current: + description: number of current merges + type: string + pri.merges.current: + description: number of current merges + type: string + merges.current_docs: + description: number of current merging docs + type: string + pri.merges.current_docs: + description: number of current merging docs + type: string + merges.current_size: + description: size of current merges + type: string + pri.merges.current_size: + description: size of current merges + type: string + merges.total: + description: number of completed merge ops + type: string + pri.merges.total: + description: number of completed merge ops + type: string + merges.total_docs: + description: docs merged + type: string + pri.merges.total_docs: + description: docs merged + type: string + merges.total_size: + description: size merged + type: string + pri.merges.total_size: + description: size merged + type: string + merges.total_time: + description: time spent in merges + type: string + pri.merges.total_time: + description: time spent in merges + type: string + refresh.total: + description: total refreshes + type: string + pri.refresh.total: + description: total refreshes + type: string + refresh.time: + description: time spent in refreshes + type: string + pri.refresh.time: + description: time spent in refreshes + type: string + refresh.external_total: + description: total external refreshes + type: string + pri.refresh.external_total: + description: total external refreshes + type: string + refresh.external_time: + description: time spent in external refreshes + type: string + pri.refresh.external_time: + description: time spent in external refreshes + type: string + refresh.listeners: + description: number of pending refresh listeners + type: string + pri.refresh.listeners: + description: number of pending refresh listeners + type: string + search.fetch_current: + description: current fetch phase ops + type: string + pri.search.fetch_current: + description: current fetch phase ops + type: string + search.fetch_time: + description: time spent in fetch phase + type: string + pri.search.fetch_time: + description: time spent in fetch phase + type: string + search.fetch_total: + description: total fetch ops + type: string + pri.search.fetch_total: + description: total fetch ops + type: string + search.open_contexts: + description: open search contexts + type: string + pri.search.open_contexts: + description: open search contexts + type: string + search.query_current: + description: current query phase ops + type: string + pri.search.query_current: + description: current query phase ops + type: string + search.query_time: + description: time spent in query phase + type: string + pri.search.query_time: + description: time spent in query phase + type: string + search.query_total: + description: total query phase ops + type: string + pri.search.query_total: + description: total query phase ops + type: string + search.scroll_current: + description: open scroll contexts + type: string + pri.search.scroll_current: + description: open scroll contexts + type: string + search.scroll_time: + description: time scroll contexts held open + type: string + pri.search.scroll_time: + description: time scroll contexts held open + type: string + search.scroll_total: + description: completed scroll contexts + type: string + pri.search.scroll_total: + description: completed scroll contexts + type: string + segments.count: + description: number of segments + type: string + pri.segments.count: + description: number of segments + type: string + segments.memory: + description: memory used by segments + type: string + pri.segments.memory: + description: memory used by segments + type: string + segments.index_writer_memory: + description: memory used by index writer + type: string + pri.segments.index_writer_memory: + description: memory used by index writer + type: string + segments.version_map_memory: + description: memory used by version map + type: string + pri.segments.version_map_memory: + description: memory used by version map + type: string + segments.fixed_bitset_memory: + description: memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields + type: string + pri.segments.fixed_bitset_memory: + description: memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields + type: string + warmer.current: + description: current warmer ops + type: string + pri.warmer.current: + description: current warmer ops + type: string + warmer.total: + description: total warmer ops + type: string + pri.warmer.total: + description: total warmer ops + type: string + warmer.total_time: + description: time spent in warmers + type: string + pri.warmer.total_time: + description: time spent in warmers + type: string + suggest.current: + description: number of current suggest ops + type: string + pri.suggest.current: + description: number of current suggest ops + type: string + suggest.time: + description: time spend in suggest + type: string + pri.suggest.time: + description: time spend in suggest + type: string + suggest.total: + description: number of suggest ops + type: string + pri.suggest.total: + description: number of suggest ops + type: string + memory.total: + description: total used memory + type: string + pri.memory.total: + description: total user memory + type: string + search.throttled: + description: indicates if the index is search throttled + type: string + bulk.total_operations: + description: number of bulk shard ops + type: string + pri.bulk.total_operations: + description: number of bulk shard ops + type: string + bulk.total_time: + description: time spend in shard bulk + type: string + pri.bulk.total_time: + description: time spend in shard bulk + type: string + bulk.total_size_in_bytes: + description: total size in bytes of shard bulk + type: string + pri.bulk.total_size_in_bytes: + description: total size in bytes of shard bulk + type: string + bulk.avg_time: + description: average time spend in shard bulk + type: string + pri.bulk.avg_time: + description: average time spend in shard bulk + type: string + bulk.avg_size_in_bytes: + description: average size in bytes of shard bulk + type: string + pri.bulk.avg_size_in_bytes: + description: average size in bytes of shard bulk + type: string + cat.master:MasterRecord: + type: object + properties: + id: + description: node id + type: string + host: + description: host name + type: string + ip: + description: ip address + type: string + node: + description: node name + type: string + cat.nodeattrs:NodeAttributesRecord: + type: object + properties: + node: + description: The node name. + type: string + id: + description: The unique node identifier. + type: string + pid: + description: The process identifier. + type: string + host: + description: The host name. + type: string + ip: + description: The IP address. + type: string + port: + description: The bound transport port. + type: string + attr: + description: The attribute name. + type: string + value: + description: The attribute value. + type: string + cat.nodes:NodesRecord: + type: object + properties: + id: + $ref: '#/components/schemas/_common:Id' + pid: + description: The process identifier. + type: string + ip: + description: The IP address. + type: string + port: + description: The bound transport port. + type: string + http_address: + description: The bound HTTP address. + type: string + version: + $ref: '#/components/schemas/_common:VersionString' + flavor: + description: The Opensearch distribution flavor. + type: string + type: + description: The Opensearch distribution type. + type: string + build: + description: The Opensearch build hash. + type: string + jdk: + description: The Java version. + type: string + disk.total: + $ref: '#/components/schemas/_common:ByteSize' + disk.used: + $ref: '#/components/schemas/_common:ByteSize' + disk.avail: + $ref: '#/components/schemas/_common:ByteSize' + disk.used_percent: + $ref: '#/components/schemas/_common:Percentage' + heap.current: + description: The used heap. + type: string + heap.percent: + $ref: '#/components/schemas/_common:Percentage' + heap.max: + description: The maximum configured heap. + type: string + ram.current: + description: The used machine memory. + type: string + ram.percent: + $ref: '#/components/schemas/_common:Percentage' + ram.max: + description: The total machine memory. + type: string + file_desc.current: + description: The used file descriptors. + type: string + file_desc.percent: + $ref: '#/components/schemas/_common:Percentage' + file_desc.max: + description: The maximum number of file descriptors. + type: string + cpu: + description: The recent system CPU usage as a percentage. + type: string + load_1m: + description: The load average for the most recent minute. + type: string + load_5m: + description: The load average for the last five minutes. + type: string + load_15m: + description: The load average for the last fifteen minutes. + type: string + uptime: + description: The node uptime. + type: string + node.role: + description: |- + The roles of the node. + Returned values include `c`(cold node), `d`(data node), `f`(frozen node), `h`(hot node), `i`(ingest node), `l`(machine learning node), `m` (master eligible node), `r`(remote cluster client node), `s`(content node), `t`(transform node), `v`(voting-only node), `w`(warm node),and `-`(coordinating node only). + type: string + master: + description: |- + Indicates whether the node is the elected master node. + Returned values include `*`(elected master) and `-`(not elected master). + type: string + name: + $ref: '#/components/schemas/_common:Name' + completion.size: + description: The size of completion. + type: string + fielddata.memory_size: + description: The used fielddata cache. + type: string + fielddata.evictions: + description: The fielddata evictions. + type: string + query_cache.memory_size: + description: The used query cache. + type: string + query_cache.evictions: + description: The query cache evictions. + type: string + query_cache.hit_count: + description: The query cache hit counts. + type: string + query_cache.miss_count: + description: The query cache miss counts. + type: string + request_cache.memory_size: + description: The used request cache. + type: string + request_cache.evictions: + description: The request cache evictions. + type: string + request_cache.hit_count: + description: The request cache hit counts. + type: string + request_cache.miss_count: + description: The request cache miss counts. + type: string + flush.total: + description: The number of flushes. + type: string + flush.total_time: + description: The time spent in flush. + type: string + get.current: + description: The number of current get ops. + type: string + get.time: + description: The time spent in get. + type: string + get.total: + description: The number of get ops. + type: string + get.exists_time: + description: The time spent in successful gets. + type: string + get.exists_total: + description: The number of successful get operations. + type: string + get.missing_time: + description: The time spent in failed gets. + type: string + get.missing_total: + description: The number of failed gets. + type: string + indexing.delete_current: + description: The number of current deletions. + type: string + indexing.delete_time: + description: The time spent in deletions. + type: string + indexing.delete_total: + description: The number of delete operations. + type: string + indexing.index_current: + description: The number of current indexing operations. + type: string + indexing.index_time: + description: The time spent in indexing. + type: string + indexing.index_total: + description: The number of indexing operations. + type: string + indexing.index_failed: + description: The number of failed indexing operations. + type: string + merges.current: + description: The number of current merges. + type: string + merges.current_docs: + description: The number of current merging docs. + type: string + merges.current_size: + description: The size of current merges. + type: string + merges.total: + description: The number of completed merge operations. + type: string + merges.total_docs: + description: The docs merged. + type: string + merges.total_size: + description: The size merged. + type: string + merges.total_time: + description: The time spent in merges. + type: string + refresh.total: + description: The total refreshes. + type: string + refresh.time: + description: The time spent in refreshes. + type: string + refresh.external_total: + description: The total external refreshes. + type: string + refresh.external_time: + description: The time spent in external refreshes. + type: string + refresh.listeners: + description: The number of pending refresh listeners. + type: string + script.compilations: + description: The total script compilations. + type: string + script.cache_evictions: + description: The total compiled scripts evicted from the cache. + type: string + script.compilation_limit_triggered: + description: The script cache compilation limit triggered. + type: string + search.fetch_current: + description: The current fetch phase operations. + type: string + search.fetch_time: + description: The time spent in fetch phase. + type: string + search.fetch_total: + description: The total fetch operations. + type: string + search.open_contexts: + description: The open search contexts. + type: string + search.query_current: + description: The current query phase operations. + type: string + search.query_time: + description: The time spent in query phase. + type: string + search.query_total: + description: The total query phase operations. + type: string + search.scroll_current: + description: The open scroll contexts. + type: string + search.scroll_time: + description: The time scroll contexts held open. + type: string + search.scroll_total: + description: The completed scroll contexts. + type: string + segments.count: + description: The number of segments. + type: string + segments.memory: + description: The memory used by segments. + type: string + segments.index_writer_memory: + description: The memory used by the index writer. + type: string + segments.version_map_memory: + description: The memory used by the version map. + type: string + segments.fixed_bitset_memory: + description: The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields. + type: string + suggest.current: + description: The number of current suggest operations. + type: string + suggest.time: + description: The time spend in suggest. + type: string + suggest.total: + description: The number of suggest operations. + type: string + bulk.total_operations: + description: The number of bulk shard operations. + type: string + bulk.total_time: + description: The time spend in shard bulk. + type: string + bulk.total_size_in_bytes: + description: The total size in bytes of shard bulk. + type: string + bulk.avg_time: + description: The average time spend in shard bulk. + type: string + bulk.avg_size_in_bytes: + description: The average size in bytes of shard bulk. + type: string + cat.pending_tasks:PendingTasksRecord: + type: object + properties: + insertOrder: + description: The task insertion order. + type: string + timeInQueue: + description: Indicates how long the task has been in queue. + type: string + priority: + description: The task priority. + type: string + source: + description: The task source. + type: string + cat.plugins:PluginsRecord: + type: object + properties: + id: + $ref: '#/components/schemas/_common:NodeId' + name: + $ref: '#/components/schemas/_common:Name' + component: + description: The component name. + type: string + version: + $ref: '#/components/schemas/_common:VersionString' + description: + description: The plugin details. + type: string + type: + description: The plugin type. + type: string + cat.recovery:RecoveryRecord: + type: object + properties: + index: + $ref: '#/components/schemas/_common:IndexName' + shard: + description: The shard name. + type: string + start_time: + $ref: '#/components/schemas/_common:DateTime' + start_time_millis: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + stop_time: + $ref: '#/components/schemas/_common:DateTime' + stop_time_millis: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + time: + $ref: '#/components/schemas/_common:Duration' + type: + description: The recovery type. + type: string + stage: + description: The recovery stage. + type: string + source_host: + description: The source host. + type: string + source_node: + description: The source node name. + type: string + target_host: + description: The target host. + type: string + target_node: + description: The target node name. + type: string + repository: + description: The repository name. + type: string + snapshot: + description: The snapshot name. + type: string + files: + description: The number of files to recover. + type: string + files_recovered: + description: The files recovered. + type: string + files_percent: + $ref: '#/components/schemas/_common:Percentage' + files_total: + description: The total number of files. + type: string + bytes: + description: The number of bytes to recover. + type: string + bytes_recovered: + description: The bytes recovered. + type: string + bytes_percent: + $ref: '#/components/schemas/_common:Percentage' + bytes_total: + description: The total number of bytes. + type: string + translog_ops: + description: The number of translog operations to recover. + type: string + translog_ops_recovered: + description: The translog operations recovered. + type: string + translog_ops_percent: + $ref: '#/components/schemas/_common:Percentage' + cat.repositories:RepositoriesRecord: + type: object + properties: + id: + description: The unique repository identifier. + type: string + type: + description: The repository type. + type: string + cat.segments:SegmentsRecord: + type: object + properties: + index: + $ref: '#/components/schemas/_common:IndexName' + shard: + description: The shard name. + type: string + prirep: + description: 'The shard type: `primary` or `replica`.' + type: string + ip: + description: The IP address of the node where it lives. + type: string + id: + $ref: '#/components/schemas/_common:NodeId' + segment: + description: The segment name, which is derived from the segment generation and used internally to create file names in the directory of the shard. + type: string + generation: + description: |- + The segment generation number. + Opensearch increments this generation number for each segment written then uses this number to derive the segment name. + type: string + docs.count: + description: |- + The number of documents in the segment. + This excludes deleted documents and counts any nested documents separately from their parents. + It also excludes documents which were indexed recently and do not yet belong to a segment. + type: string + docs.deleted: + description: |- + The number of deleted documents in the segment, which might be higher or lower than the number of delete operations you have performed. + This number excludes deletes that were performed recently and do not yet belong to a segment. + Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. + Also, Opensearch creates extra deleted documents to internally track the recent history of operations on a shard. + type: string + size: + $ref: '#/components/schemas/_common:ByteSize' + size.memory: + $ref: '#/components/schemas/_common:ByteSize' + committed: + description: |- + If `true`, the segment is synced to disk. + Segments that are synced can survive a hard reboot. + If `false`, the data from uncommitted segments is also stored in the transaction log so that Opensearch is able to replay changes on the next start. + type: string + searchable: + description: |- + If `true`, the segment is searchable. + If `false`, the segment has most likely been written to disk but needs a refresh to be searchable. + type: string + version: + $ref: '#/components/schemas/_common:VersionString' + compound: + description: |- + If `true`, the segment is stored in a compound file. + This means Lucene merged all files from the segment in a single file to save file descriptors. + type: string + cat.shards:ShardsRecord: + type: object + properties: + index: + description: The index name. + type: string + shard: + description: The shard name. + type: string + prirep: + description: 'The shard type: `primary` or `replica`.' + type: string + state: + description: |- + The shard state. + Returned values include: + `INITIALIZING`: The shard is recovering from a peer shard or gateway. + `RELOCATING`: The shard is relocating. + `STARTED`: The shard has started. + `UNASSIGNED`: The shard is not assigned to any node. + type: string + docs: + description: The number of documents in the shard. + oneOf: + - type: string + - nullable: true + type: string + store: + description: The disk space used by the shard. + oneOf: + - type: string + - nullable: true + type: string + ip: + description: The IP address of the node. + oneOf: + - type: string + - nullable: true + type: string + id: + description: The unique identifier for the node. + type: string + node: + description: The name of node. + oneOf: + - type: string + - nullable: true + type: string + sync_id: + description: The sync identifier. + type: string + unassigned.reason: + description: |- + The reason for the last change to the state of an unassigned shard. + It does not explain why the shard is currently unassigned; use the cluster allocation explain API for that information. + Returned values include: + `ALLOCATION_FAILED`: Unassigned as a result of a failed allocation of the shard. + `CLUSTER_RECOVERED`: Unassigned as a result of a full cluster recovery. + `DANGLING_INDEX_IMPORTED`: Unassigned as a result of importing a dangling index. + `EXISTING_INDEX_RESTORED`: Unassigned as a result of restoring into a closed index. + `FORCED_EMPTY_PRIMARY`: The shard’s allocation was last modified by forcing an empty primary using the cluster reroute API. + `INDEX_CLOSED`: Unassigned because the index was closed. + `INDEX_CREATED`: Unassigned as a result of an API creation of an index. + `INDEX_REOPENED`: Unassigned as a result of opening a closed index. + `MANUAL_ALLOCATION`: The shard’s allocation was last modified by the cluster reroute API. + `NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index. + `NODE_LEFT`: Unassigned as a result of the node hosting it leaving the cluster. + `NODE_RESTARTING`: Similar to `NODE_LEFT`, except that the node was registered as restarting using the node shutdown API. + `PRIMARY_FAILED`: The shard was initializing as a replica, but the primary shard failed before the initialization completed. + `REALLOCATED_REPLICA`: A better replica location is identified and causes the existing replica allocation to be cancelled. + `REINITIALIZED`: When a shard moves from started back to initializing. + `REPLICA_ADDED`: Unassigned as a result of explicit addition of a replica. + `REROUTE_CANCELLED`: Unassigned as a result of explicit cancel reroute command. + type: string + unassigned.at: + description: The time at which the shard became unassigned in Coordinated Universal Time (UTC). + type: string + unassigned.for: + description: The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC). + type: string + unassigned.details: + description: |- + Additional details as to why the shard became unassigned. + It does not explain why the shard is not assigned; use the cluster allocation explain API for that information. + type: string + recoverysource.type: + description: The type of recovery source. + type: string + completion.size: + description: The size of completion. + type: string + fielddata.memory_size: + description: The used fielddata cache memory. + type: string + fielddata.evictions: + description: The fielddata cache evictions. + type: string + query_cache.memory_size: + description: The used query cache memory. + type: string + query_cache.evictions: + description: The query cache evictions. + type: string + flush.total: + description: The number of flushes. + type: string + flush.total_time: + description: The time spent in flush. + type: string + get.current: + description: The number of current get operations. + type: string + get.time: + description: The time spent in get operations. + type: string + get.total: + description: The number of get operations. + type: string + get.exists_time: + description: The time spent in successful get operations. + type: string + get.exists_total: + description: The number of successful get operations. + type: string + get.missing_time: + description: The time spent in failed get operations. + type: string + get.missing_total: + description: The number of failed get operations. + type: string + indexing.delete_current: + description: The number of current deletion operations. + type: string + indexing.delete_time: + description: The time spent in deletion operations. + type: string + indexing.delete_total: + description: The number of delete operations. + type: string + indexing.index_current: + description: The number of current indexing operations. + type: string + indexing.index_time: + description: The time spent in indexing operations. + type: string + indexing.index_total: + description: The number of indexing operations. + type: string + indexing.index_failed: + description: The number of failed indexing operations. + type: string + merges.current: + description: The number of current merge operations. + type: string + merges.current_docs: + description: The number of current merging documents. + type: string + merges.current_size: + description: The size of current merge operations. + type: string + merges.total: + description: The number of completed merge operations. + type: string + merges.total_docs: + description: The nuber of merged documents. + type: string + merges.total_size: + description: The size of current merges. + type: string + merges.total_time: + description: The time spent merging documents. + type: string + refresh.total: + description: The total number of refreshes. + type: string + refresh.time: + description: The time spent in refreshes. + type: string + refresh.external_total: + description: The total nunber of external refreshes. + type: string + refresh.external_time: + description: The time spent in external refreshes. + type: string + refresh.listeners: + description: The number of pending refresh listeners. + type: string + search.fetch_current: + description: The current fetch phase operations. + type: string + search.fetch_time: + description: The time spent in fetch phase. + type: string + search.fetch_total: + description: The total number of fetch operations. + type: string + search.open_contexts: + description: The number of open search contexts. + type: string + search.query_current: + description: The current query phase operations. + type: string + search.query_time: + description: The time spent in query phase. + type: string + search.query_total: + description: The total number of query phase operations. + type: string + search.scroll_current: + description: The open scroll contexts. + type: string + search.scroll_time: + description: The time scroll contexts were held open. + type: string + search.scroll_total: + description: The number of completed scroll contexts. + type: string + segments.count: + description: The number of segments. + type: string + segments.memory: + description: The memory used by segments. + type: string + segments.index_writer_memory: + description: The memory used by the index writer. + type: string + segments.version_map_memory: + description: The memory used by the version map. + type: string + segments.fixed_bitset_memory: + description: The memory used by fixed bit sets for nested object field types and export type filters for types referred in `_parent` fields. + type: string + seq_no.max: + description: The maximum sequence number. + type: string + seq_no.local_checkpoint: + description: The local checkpoint. + type: string + seq_no.global_checkpoint: + description: The global checkpoint. + type: string + warmer.current: + description: The number of current warmer operations. + type: string + warmer.total: + description: The total number of warmer operations. + type: string + warmer.total_time: + description: The time spent in warmer operations. + type: string + path.data: + description: The shard data path. + type: string + path.state: + description: The shard state path. + type: string + bulk.total_operations: + description: The number of bulk shard operations. + type: string + bulk.total_time: + description: The time spent in shard bulk operations. + type: string + bulk.total_size_in_bytes: + description: The total size in bytes of shard bulk operations. + type: string + bulk.avg_time: + description: The average time spent in shard bulk operations. + type: string + bulk.avg_size_in_bytes: + description: The average size in bytes of shard bulk operations. + type: string + cat.snapshots:SnapshotsRecord: + type: object + properties: + id: + description: The unique identifier for the snapshot. + type: string + repository: + description: The repository name. + type: string + status: + description: |- + The state of the snapshot process. + Returned values include: + `FAILED`: The snapshot process failed. + `INCOMPATIBLE`: The snapshot process is incompatible with the current cluster version. + `IN_PROGRESS`: The snapshot process started but has not completed. + `PARTIAL`: The snapshot process completed with a partial success. + `SUCCESS`: The snapshot process completed with a full success. + type: string + start_epoch: + $ref: '#/components/schemas/_common:StringifiedEpochTimeUnitSeconds' + start_time: + $ref: '#/components/schemas/_common:ScheduleTimeOfDay' + end_epoch: + $ref: '#/components/schemas/_common:StringifiedEpochTimeUnitSeconds' + end_time: + $ref: '#/components/schemas/_common:TimeOfDay' + duration: + $ref: '#/components/schemas/_common:Duration' + indices: + description: The number of indices in the snapshot. + type: string + successful_shards: + description: The number of successful shards in the snapshot. + type: string + failed_shards: + description: The number of failed shards in the snapshot. + type: string + total_shards: + description: The total number of shards in the snapshot. + type: string + reason: + description: The reason for any snapshot failures. + type: string + cat.tasks:TasksRecord: + type: object + properties: + id: + $ref: '#/components/schemas/_common:Id' + action: + description: The task action. + type: string + task_id: + $ref: '#/components/schemas/_common:Id' + parent_task_id: + description: The parent task identifier. + type: string + type: + description: The task type. + type: string + start_time: + description: The start time in milliseconds. + type: string + timestamp: + description: The start time in `HH:MM:SS` format. + type: string + running_time_ns: + description: The running time in nanoseconds. + type: string + running_time: + description: The running time. + type: string + node_id: + $ref: '#/components/schemas/_common:NodeId' + ip: + description: The IP address for the node. + type: string + port: + description: The bound transport port for the node. + type: string + node: + description: The node name. + type: string + version: + $ref: '#/components/schemas/_common:VersionString' + x_opaque_id: + description: The X-Opaque-ID header. + type: string + description: + description: The task action description. + type: string + cat.templates:TemplatesRecord: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + index_patterns: + description: The template index patterns. + type: string + order: + description: The template application order or priority number. + type: string + version: + description: The template version. + oneOf: + - $ref: '#/components/schemas/_common:VersionString' + - nullable: true + type: string + composed_of: + description: The component templates that comprise the index template. + type: string + cat.thread_pool:ThreadPoolRecord: + type: object + properties: + node_name: + description: The node name. + type: string + node_id: + $ref: '#/components/schemas/_common:NodeId' + ephemeral_node_id: + description: The ephemeral node identifier. + type: string + pid: + description: The process identifier. + type: string + host: + description: The host name for the current node. + type: string + ip: + description: The IP address for the current node. + type: string + port: + description: The bound transport port for the current node. + type: string + name: + description: The thread pool name. + type: string + type: + description: |- + The thread pool type. + Returned values include `fixed`, `fixed_auto_queue_size`, `direct`, and `scaling`. + type: string + active: + description: The number of active threads in the current thread pool. + type: string + pool_size: + description: The number of threads in the current thread pool. + type: string + queue: + description: The number of tasks currently in queue. + type: string + queue_size: + description: The maximum number of tasks permitted in the queue. + type: string + rejected: + description: The number of rejected tasks. + type: string + largest: + description: The highest number of active threads in the current thread pool. + type: string + completed: + description: The number of completed tasks. + type: string + core: + description: The core number of active threads allowed in a scaling thread pool. + oneOf: + - type: string + - nullable: true + type: string + max: + description: The maximum number of active threads allowed in a scaling thread pool. + oneOf: + - type: string + - nullable: true + type: string + size: + description: The number of active threads allowed in a fixed thread pool. + oneOf: + - type: string + - nullable: true + type: string + keep_alive: + description: The thread keep alive time. + oneOf: + - type: string + - nullable: true + type: string + cluster._common:ComponentTemplate: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + component_template: + $ref: '#/components/schemas/cluster._common:ComponentTemplateNode' + required: + - name + - component_template + cluster._common:ComponentTemplateNode: + type: object + properties: + template: + $ref: '#/components/schemas/cluster._common:ComponentTemplateSummary' + version: + $ref: '#/components/schemas/_common:VersionNumber' + _meta: + $ref: '#/components/schemas/_common:Metadata' + required: + - template + cluster._common:ComponentTemplateSummary: + type: object + properties: + _meta: + $ref: '#/components/schemas/_common:Metadata' + version: + $ref: '#/components/schemas/_common:VersionNumber' + settings: + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:IndexSettings' + mappings: + $ref: '#/components/schemas/_common.mapping:TypeMapping' + aliases: + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:AliasDefinition' + lifecycle: + $ref: '#/components/schemas/indices._common:DataStreamLifecycleWithRollover' + cluster.allocation_explain:AllocationDecision: + type: object + properties: + decider: + type: string + decision: + $ref: '#/components/schemas/cluster.allocation_explain:AllocationExplainDecision' + explanation: + type: string + required: + - decider + - decision + - explanation + cluster.allocation_explain:AllocationExplainDecision: + type: string + enum: + - NO + - YES + - THROTTLE + - ALWAYS + cluster.allocation_explain:AllocationStore: + type: object + properties: + allocation_id: + type: string + found: + type: boolean + in_sync: + type: boolean + matching_size_in_bytes: + type: number + matching_sync_id: + type: boolean + store_exception: + type: string + required: + - allocation_id + - found + - in_sync + - matching_size_in_bytes + - matching_sync_id + - store_exception + cluster.allocation_explain:ClusterInfo: + type: object + properties: + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/cluster.allocation_explain:NodeDiskUsage' + shard_sizes: + type: object + additionalProperties: + type: number + shard_data_set_sizes: + type: object + additionalProperties: + type: string + shard_paths: + type: object + additionalProperties: + type: string + reserved_sizes: + type: array + items: + $ref: '#/components/schemas/cluster.allocation_explain:ReservedSize' + required: + - nodes + - shard_sizes + - shard_paths + - reserved_sizes + cluster.allocation_explain:CurrentNode: + type: object + properties: + id: + $ref: '#/components/schemas/_common:Id' + name: + $ref: '#/components/schemas/_common:Name' + attributes: + type: object + additionalProperties: + type: string + transport_address: + $ref: '#/components/schemas/_common:TransportAddress' + weight_ranking: + type: number + required: + - id + - name + - attributes + - transport_address + - weight_ranking + cluster.allocation_explain:Decision: + type: string + enum: + - yes + - no + - worse_balance + - throttled + - awaiting_info + - allocation_delayed + - no_valid_shard_copy + - no_attempt + cluster.allocation_explain:DiskUsage: + type: object + properties: + path: + type: string + total_bytes: + type: number + used_bytes: + type: number + free_bytes: + type: number + free_disk_percent: + type: number + used_disk_percent: + type: number + required: + - path + - total_bytes + - used_bytes + - free_bytes + - free_disk_percent + - used_disk_percent + cluster.allocation_explain:NodeAllocationExplanation: + type: object + properties: + deciders: + type: array + items: + $ref: '#/components/schemas/cluster.allocation_explain:AllocationDecision' + node_attributes: + type: object + additionalProperties: + type: string + node_decision: + $ref: '#/components/schemas/cluster.allocation_explain:Decision' + node_id: + $ref: '#/components/schemas/_common:Id' + node_name: + $ref: '#/components/schemas/_common:Name' + store: + $ref: '#/components/schemas/cluster.allocation_explain:AllocationStore' + transport_address: + $ref: '#/components/schemas/_common:TransportAddress' + weight_ranking: + type: number + required: + - deciders + - node_attributes + - node_decision + - node_id + - node_name + - transport_address + - weight_ranking + cluster.allocation_explain:NodeDiskUsage: + type: object + properties: + node_name: + $ref: '#/components/schemas/_common:Name' + least_available: + $ref: '#/components/schemas/cluster.allocation_explain:DiskUsage' + most_available: + $ref: '#/components/schemas/cluster.allocation_explain:DiskUsage' + required: + - node_name + - least_available + - most_available + cluster.allocation_explain:ReservedSize: + type: object + properties: + node_id: + $ref: '#/components/schemas/_common:Id' + path: + type: string + total: + type: number + shards: + type: array + items: + type: string + required: + - node_id + - path + - total + - shards + cluster.allocation_explain:UnassignedInformation: + type: object + properties: + at: + $ref: '#/components/schemas/_common:DateTime' + last_allocation_status: + type: string + reason: + $ref: '#/components/schemas/cluster.allocation_explain:UnassignedInformationReason' + details: + type: string + failed_allocation_attempts: + type: number + delayed: + type: boolean + allocation_status: + type: string + required: + - at + - reason + cluster.allocation_explain:UnassignedInformationReason: + type: string + enum: + - INDEX_CREATED + - CLUSTER_RECOVERED + - INDEX_REOPENED + - DANGLING_INDEX_IMPORTED + - NEW_INDEX_RESTORED + - EXISTING_INDEX_RESTORED + - REPLICA_ADDED + - ALLOCATION_FAILED + - NODE_LEFT + - REROUTE_CANCELLED + - REINITIALIZED + - REALLOCATED_REPLICA + - PRIMARY_FAILED + - FORCED_EMPTY_PRIMARY + - MANUAL_ALLOCATION + cluster.health:HealthResponseBody: + type: object + properties: + active_primary_shards: + description: The number of active primary shards. + type: number + active_shards: + description: The total number of active primary and replica shards. + type: number + active_shards_percent_as_number: + $ref: '#/components/schemas/_common:Percentage' + cluster_name: + $ref: '#/components/schemas/_common:Name' + delayed_unassigned_shards: + description: The number of shards whose allocation has been delayed by the timeout settings. + type: number + indices: + type: object + additionalProperties: + $ref: '#/components/schemas/cluster.health:IndexHealthStats' + initializing_shards: + description: The number of shards that are under initialization. + type: number + number_of_data_nodes: + description: The number of nodes that are dedicated data nodes. + type: number + number_of_in_flight_fetch: + description: The number of unfinished fetches. + type: number + number_of_nodes: + description: The number of nodes within the cluster. + type: number + number_of_pending_tasks: + description: The number of cluster-level changes that have not yet been executed. + type: number + relocating_shards: + description: The number of shards that are under relocation. + type: number + status: + $ref: '#/components/schemas/_common:HealthStatus' + task_max_waiting_in_queue: + $ref: '#/components/schemas/_common:Duration' + task_max_waiting_in_queue_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + timed_out: + description: If false the response returned within the period of time that is specified by the timeout parameter (30s by default) + type: boolean + unassigned_shards: + description: The number of shards that are not allocated. + type: number + required: + - active_primary_shards + - active_shards + - active_shards_percent_as_number + - cluster_name + - delayed_unassigned_shards + - initializing_shards + - number_of_data_nodes + - number_of_in_flight_fetch + - number_of_nodes + - number_of_pending_tasks + - relocating_shards + - status + - task_max_waiting_in_queue_millis + - timed_out + - unassigned_shards + cluster.health:IndexHealthStats: + type: object + properties: + active_primary_shards: + type: number + active_shards: + type: number + initializing_shards: + type: number + number_of_replicas: + type: number + number_of_shards: + type: number + relocating_shards: + type: number + shards: + type: object + additionalProperties: + $ref: '#/components/schemas/cluster.health:ShardHealthStats' + status: + $ref: '#/components/schemas/_common:HealthStatus' + unassigned_shards: + type: number + required: + - active_primary_shards + - active_shards + - initializing_shards + - number_of_replicas + - number_of_shards + - relocating_shards + - status + - unassigned_shards + cluster.health:ShardHealthStats: + type: object + properties: + active_shards: + type: number + initializing_shards: + type: number + primary_active: + type: boolean + relocating_shards: + type: number + status: + $ref: '#/components/schemas/_common:HealthStatus' + unassigned_shards: + type: number + required: + - active_shards + - initializing_shards + - primary_active + - relocating_shards + - status + - unassigned_shards + cluster.pending_tasks:PendingTask: + type: object + properties: + executing: + description: Indicates whether the pending tasks are currently executing or not. + type: boolean + insert_order: + description: The number that represents when the task has been inserted into the task queue. + type: number + priority: + description: |- + The priority of the pending task. + The valid priorities in descending priority order are: `IMMEDIATE` > `URGENT` > `HIGH` > `NORMAL` > `LOW` > `LANGUID`. + type: string + source: + description: A general description of the cluster task that may include a reason and origin. + type: string + time_in_queue: + $ref: '#/components/schemas/_common:Duration' + time_in_queue_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - executing + - insert_order + - priority + - source + - time_in_queue_millis + cluster.remote_info:ClusterRemoteInfo: + discriminator: + propertyName: mode + oneOf: + - $ref: '#/components/schemas/cluster.remote_info:ClusterRemoteSniffInfo' + - $ref: '#/components/schemas/cluster.remote_info:ClusterRemoteProxyInfo' + cluster.remote_info:ClusterRemoteProxyInfo: + type: object + properties: + mode: + type: string + enum: + - proxy + connected: + type: boolean + initial_connect_timeout: + $ref: '#/components/schemas/_common:Duration' + skip_unavailable: + type: boolean + proxy_address: + type: string + server_name: + type: string + num_proxy_sockets_connected: + type: number + max_proxy_socket_connections: + type: number + required: + - mode + - connected + - initial_connect_timeout + - skip_unavailable + - proxy_address + - server_name + - num_proxy_sockets_connected + - max_proxy_socket_connections + cluster.remote_info:ClusterRemoteSniffInfo: + type: object + properties: + mode: + type: string + enum: + - sniff + connected: + type: boolean + max_connections_per_cluster: + type: number + num_nodes_connected: + type: number + initial_connect_timeout: + $ref: '#/components/schemas/_common:Duration' + skip_unavailable: + type: boolean + seeds: + type: array + items: + type: string + required: + - mode + - connected + - max_connections_per_cluster + - num_nodes_connected + - initial_connect_timeout + - skip_unavailable + - seeds + cluster.reroute:Command: + type: object + properties: + cancel: + $ref: '#/components/schemas/cluster.reroute:CommandCancelAction' + move: + $ref: '#/components/schemas/cluster.reroute:CommandMoveAction' + allocate_replica: + $ref: '#/components/schemas/cluster.reroute:CommandAllocateReplicaAction' + allocate_stale_primary: + $ref: '#/components/schemas/cluster.reroute:CommandAllocatePrimaryAction' + allocate_empty_primary: + $ref: '#/components/schemas/cluster.reroute:CommandAllocatePrimaryAction' + cluster.reroute:CommandAllocatePrimaryAction: + type: object + properties: + index: + $ref: '#/components/schemas/_common:IndexName' + shard: + type: number + node: + type: string + accept_data_loss: + 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 + type: boolean + required: + - index + - shard + - node + - accept_data_loss + cluster.reroute:CommandAllocateReplicaAction: + type: object + properties: + index: + $ref: '#/components/schemas/_common:IndexName' + shard: + type: number + node: + type: string + required: + - index + - shard + - node + cluster.reroute:CommandCancelAction: + type: object + properties: + index: + $ref: '#/components/schemas/_common:IndexName' + shard: + type: number + node: + type: string + allow_primary: + type: boolean + required: + - index + - shard + - node + cluster.reroute:CommandMoveAction: + type: object + properties: + index: + $ref: '#/components/schemas/_common:IndexName' + shard: + type: number + from_node: + description: The node to move the shard from + type: string + to_node: + description: The node to move the shard to + type: string + required: + - index + - shard + - from_node + - to_node + cluster.reroute:RerouteDecision: + type: object + properties: + decider: + type: string + decision: + type: string + explanation: + type: string + required: + - decider + - decision + - explanation + cluster.reroute:RerouteExplanation: + type: object + properties: + command: + type: string + decisions: + type: array + items: + $ref: '#/components/schemas/cluster.reroute:RerouteDecision' + parameters: + $ref: '#/components/schemas/cluster.reroute:RerouteParameters' + required: + - command + - decisions + - parameters + cluster.reroute:RerouteParameters: + type: object + properties: + allow_primary: + type: boolean + index: + $ref: '#/components/schemas/_common:IndexName' + node: + $ref: '#/components/schemas/_common:NodeName' + shard: + type: number + from_node: + $ref: '#/components/schemas/_common:NodeName' + to_node: + $ref: '#/components/schemas/_common:NodeName' + required: + - allow_primary + - index + - node + - shard + cluster.stats:CharFilterTypes: + type: object + properties: + analyzer_types: + description: Contains statistics about analyzer types used in selected nodes. + type: array + items: + $ref: '#/components/schemas/cluster.stats:FieldTypes' + built_in_analyzers: + description: Contains statistics about built-in analyzers used in selected nodes. + type: array + items: + $ref: '#/components/schemas/cluster.stats:FieldTypes' + built_in_char_filters: + description: Contains statistics about built-in character filters used in selected nodes. + type: array + items: + $ref: '#/components/schemas/cluster.stats:FieldTypes' + built_in_filters: + description: Contains statistics about built-in token filters used in selected nodes. + type: array + items: + $ref: '#/components/schemas/cluster.stats:FieldTypes' + built_in_tokenizers: + description: Contains statistics about built-in tokenizers used in selected nodes. + type: array + items: + $ref: '#/components/schemas/cluster.stats:FieldTypes' + char_filter_types: + description: Contains statistics about character filter types used in selected nodes. + type: array + items: + $ref: '#/components/schemas/cluster.stats:FieldTypes' + filter_types: + description: Contains statistics about token filter types used in selected nodes. + type: array + items: + $ref: '#/components/schemas/cluster.stats:FieldTypes' + tokenizer_types: + description: Contains statistics about tokenizer types used in selected nodes. + type: array + items: + $ref: '#/components/schemas/cluster.stats:FieldTypes' + required: + - analyzer_types + - built_in_analyzers + - built_in_char_filters + - built_in_filters + - built_in_tokenizers + - char_filter_types + - filter_types + - tokenizer_types + cluster.stats:ClusterFileSystem: + type: object + properties: + available_in_bytes: + description: |- + Total number of bytes available to JVM in file stores across all selected nodes. + Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`. + This is the actual amount of free disk space the selected Opensearch nodes can use. + type: number + free_in_bytes: + description: Total number of unallocated bytes in file stores across all selected nodes. + type: number + total_in_bytes: + description: Total size, in bytes, of all file stores across all selected nodes. + type: number + required: + - available_in_bytes + - free_in_bytes + - total_in_bytes + cluster.stats:ClusterIndices: + type: object + properties: + analysis: + $ref: '#/components/schemas/cluster.stats:CharFilterTypes' + completion: + $ref: '#/components/schemas/_common:CompletionStats' + count: + description: Total number of indices with shards assigned to selected nodes. + type: number + docs: + $ref: '#/components/schemas/_common:DocStats' + fielddata: + $ref: '#/components/schemas/_common:FielddataStats' + query_cache: + $ref: '#/components/schemas/_common:QueryCacheStats' + segments: + $ref: '#/components/schemas/_common:SegmentsStats' + shards: + $ref: '#/components/schemas/cluster.stats:ClusterIndicesShards' + store: + $ref: '#/components/schemas/_common:StoreStats' + mappings: + $ref: '#/components/schemas/cluster.stats:FieldTypesMappings' + versions: + description: Contains statistics about analyzers and analyzer components used in selected nodes. + type: array + items: + $ref: '#/components/schemas/cluster.stats:IndicesVersions' + required: + - analysis + - completion + - count + - docs + - fielddata + - query_cache + - segments + - shards + - store + - mappings + cluster.stats:ClusterIndicesShards: + type: object + properties: + index: + $ref: '#/components/schemas/cluster.stats:ClusterIndicesShardsIndex' + primaries: + description: Number of primary shards assigned to selected nodes. + type: number + replication: + description: Ratio of replica shards to primary shards across all selected nodes. + type: number + total: + description: Total number of shards assigned to selected nodes. + type: number + cluster.stats:ClusterIndicesShardsIndex: + type: object + properties: + primaries: + $ref: '#/components/schemas/cluster.stats:ClusterShardMetrics' + replication: + $ref: '#/components/schemas/cluster.stats:ClusterShardMetrics' + shards: + $ref: '#/components/schemas/cluster.stats:ClusterShardMetrics' + required: + - primaries + - replication + - shards + cluster.stats:ClusterIngest: + type: object + properties: + number_of_pipelines: + type: number + processor_stats: + type: object + additionalProperties: + $ref: '#/components/schemas/cluster.stats:ClusterProcessor' + required: + - number_of_pipelines + - processor_stats + cluster.stats:ClusterJvm: + type: object + properties: + max_uptime_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + mem: + $ref: '#/components/schemas/cluster.stats:ClusterJvmMemory' + threads: + description: Number of active threads in use by JVM across all selected nodes. + type: number + versions: + description: Contains statistics about the JVM versions used by selected nodes. + type: array + items: + $ref: '#/components/schemas/cluster.stats:ClusterJvmVersion' + required: + - max_uptime_in_millis + - mem + - threads + - versions + cluster.stats:ClusterJvmMemory: + type: object + properties: + heap_max_in_bytes: + description: Maximum amount of memory, in bytes, available for use by the heap across all selected nodes. + type: number + heap_used_in_bytes: + description: Memory, in bytes, currently in use by the heap across all selected nodes. + type: number + required: + - heap_max_in_bytes + - heap_used_in_bytes + cluster.stats:ClusterJvmVersion: + type: object + properties: + bundled_jdk: + description: Always `true`. All distributions come with a bundled Java Development Kit (JDK). + type: boolean + count: + description: Total number of selected nodes using JVM. + type: number + using_bundled_jdk: + description: If `true`, a bundled JDK is in use by JVM. + type: boolean + version: + $ref: '#/components/schemas/_common:VersionString' + vm_name: + description: Name of the JVM. + type: string + vm_vendor: + description: Vendor of the JVM. + type: string + vm_version: + $ref: '#/components/schemas/_common:VersionString' + required: + - bundled_jdk + - count + - using_bundled_jdk + - version + - vm_name + - vm_vendor + - vm_version + cluster.stats:ClusterNetworkTypes: + type: object + properties: + http_types: + description: Contains statistics about the HTTP network types used by selected nodes. + type: object + additionalProperties: + type: number + transport_types: + description: Contains statistics about the transport network types used by selected nodes. + type: object + additionalProperties: + type: number + required: + - http_types + - transport_types + cluster.stats:ClusterNodeCount: + type: object + properties: + coordinating_only: + type: number + data: + type: number + data_cold: + type: number + data_content: + type: number + data_frozen: + type: number + data_hot: + type: number + data_warm: + type: number + ingest: + type: number + master: + type: number + ml: + type: number + remote_cluster_client: + type: number + total: + type: number + transform: + type: number + voting_only: + type: number + required: + - coordinating_only + - data + - data_cold + - data_content + - data_hot + - data_warm + - ingest + - master + - ml + - remote_cluster_client + - total + - transform + - voting_only + cluster.stats:ClusterNodes: + type: object + properties: + count: + $ref: '#/components/schemas/cluster.stats:ClusterNodeCount' + discovery_types: + description: Contains statistics about the discovery types used by selected nodes. + type: object + additionalProperties: + type: number + fs: + $ref: '#/components/schemas/cluster.stats:ClusterFileSystem' + indexing_pressure: + $ref: '#/components/schemas/cluster.stats:IndexingPressure' + ingest: + $ref: '#/components/schemas/cluster.stats:ClusterIngest' + jvm: + $ref: '#/components/schemas/cluster.stats:ClusterJvm' + network_types: + $ref: '#/components/schemas/cluster.stats:ClusterNetworkTypes' + os: + $ref: '#/components/schemas/cluster.stats:ClusterOperatingSystem' + packaging_types: + description: Contains statistics about Opensearch distributions installed on selected nodes. + type: array + items: + $ref: '#/components/schemas/cluster.stats:NodePackagingType' + plugins: + description: |- + Contains statistics about installed plugins and modules by selected nodes. + If no plugins or modules are installed, this array is empty. + type: array + items: + $ref: '#/components/schemas/_common:PluginStats' + process: + $ref: '#/components/schemas/cluster.stats:ClusterProcess' + versions: + description: Array of Opensearch versions used on selected nodes. + type: array + items: + $ref: '#/components/schemas/_common:VersionString' + required: + - count + - discovery_types + - fs + - indexing_pressure + - ingest + - jvm + - network_types + - os + - packaging_types + - plugins + - process + - versions + cluster.stats:ClusterOperatingSystem: + type: object + properties: + allocated_processors: + description: |- + Number of processors used to calculate thread pool size across all selected nodes. + This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system. + In both cases, this number will never be larger than 32. + type: number + architectures: + description: Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes. + type: array + items: + $ref: '#/components/schemas/cluster.stats:ClusterOperatingSystemArchitecture' + available_processors: + description: Number of processors available to JVM across all selected nodes. + type: number + mem: + $ref: '#/components/schemas/cluster.stats:OperatingSystemMemoryInfo' + names: + description: Contains statistics about operating systems used by selected nodes. + type: array + items: + $ref: '#/components/schemas/cluster.stats:ClusterOperatingSystemName' + pretty_names: + description: Contains statistics about operating systems used by selected nodes. + type: array + items: + $ref: '#/components/schemas/cluster.stats:ClusterOperatingSystemPrettyName' + required: + - allocated_processors + - available_processors + - mem + - names + - pretty_names + cluster.stats:ClusterOperatingSystemArchitecture: + type: object + properties: + arch: + description: Name of an architecture used by one or more selected nodes. + type: string + count: + description: Number of selected nodes using the architecture. + type: number + required: + - arch + - count + cluster.stats:ClusterOperatingSystemName: + type: object + properties: + count: + description: Number of selected nodes using the operating system. + type: number + name: + $ref: '#/components/schemas/_common:Name' + required: + - count + - name + cluster.stats:ClusterOperatingSystemPrettyName: + type: object + properties: + count: + description: Number of selected nodes using the operating system. + type: number + pretty_name: + $ref: '#/components/schemas/_common:Name' + required: + - count + - pretty_name + cluster.stats:ClusterProcess: + type: object + properties: + cpu: + $ref: '#/components/schemas/cluster.stats:ClusterProcessCpu' + open_file_descriptors: + $ref: '#/components/schemas/cluster.stats:ClusterProcessOpenFileDescriptors' + required: + - cpu + - open_file_descriptors + cluster.stats:ClusterProcessCpu: + type: object + properties: + percent: + description: |- + Percentage of CPU used across all selected nodes. + Returns `-1` if not supported. + type: number + required: + - percent + cluster.stats:ClusterProcessOpenFileDescriptors: + type: object + properties: + avg: + description: |- + Average number of concurrently open file descriptors. + Returns `-1` if not supported. + type: number + max: + description: |- + Maximum number of concurrently open file descriptors allowed across all selected nodes. + Returns `-1` if not supported. + type: number + min: + description: |- + Minimum number of concurrently open file descriptors across all selected nodes. + Returns -1 if not supported. + type: number + required: + - avg + - max + - min + cluster.stats:ClusterProcessor: + type: object + properties: + count: + type: number + current: + type: number + failed: + type: number + time: + $ref: '#/components/schemas/_common:Duration' + time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - count + - current + - failed + - time_in_millis + cluster.stats:ClusterShardMetrics: + type: object + properties: + avg: + description: Mean number of shards in an index, counting only shards assigned to selected nodes. + type: number + max: + description: Maximum number of shards in an index, counting only shards assigned to selected nodes. + type: number + min: + description: Minimum number of shards in an index, counting only shards assigned to selected nodes. + type: number + required: + - avg + - max + - min + cluster.stats:FieldTypes: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + count: + description: The number of occurrences of the field type in selected nodes. + type: number + index_count: + description: The number of indices containing the field type in selected nodes. + type: number + indexed_vector_count: + description: For dense_vector field types, number of indexed vector types in selected nodes. + type: number + indexed_vector_dim_max: + description: For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes. + type: number + indexed_vector_dim_min: + description: For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes. + type: number + script_count: + description: The number of fields that declare a script. + type: number + required: + - name + - count + - index_count + cluster.stats:FieldTypesMappings: + type: object + properties: + field_types: + description: Contains statistics about field data types used in selected nodes. + type: array + items: + $ref: '#/components/schemas/cluster.stats:FieldTypes' + runtime_field_types: + description: Contains statistics about runtime field data types used in selected nodes. + type: array + items: + $ref: '#/components/schemas/cluster.stats:RuntimeFieldTypes' + total_field_count: + description: Total number of fields in all non-system indices. + type: number + total_deduplicated_field_count: + description: Total number of fields in all non-system indices, accounting for mapping deduplication. + type: number + total_deduplicated_mapping_size: + $ref: '#/components/schemas/_common:ByteSize' + total_deduplicated_mapping_size_in_bytes: + description: Total size of all mappings, in bytes, after deduplication and compression. + type: number + required: + - field_types + cluster.stats:IndexingPressure: + type: object + properties: + memory: + $ref: '#/components/schemas/cluster.stats:IndexingPressureMemory' + required: + - memory + cluster.stats:IndexingPressureMemory: + type: object + properties: + current: + $ref: '#/components/schemas/cluster.stats:IndexingPressureMemorySummary' + limit_in_bytes: + type: number + total: + $ref: '#/components/schemas/cluster.stats:IndexingPressureMemorySummary' + required: + - current + - limit_in_bytes + - total + cluster.stats:IndexingPressureMemorySummary: + type: object + properties: + all_in_bytes: + type: number + combined_coordinating_and_primary_in_bytes: + type: number + coordinating_in_bytes: + type: number + coordinating_rejections: + type: number + primary_in_bytes: + type: number + primary_rejections: + type: number + replica_in_bytes: + type: number + replica_rejections: + type: number + required: + - all_in_bytes + - combined_coordinating_and_primary_in_bytes + - coordinating_in_bytes + - primary_in_bytes + - replica_in_bytes + cluster.stats:IndicesVersions: + type: object + properties: + index_count: + type: number + primary_shard_count: + type: number + total_primary_bytes: + type: number + version: + $ref: '#/components/schemas/_common:VersionString' + required: + - index_count + - primary_shard_count + - total_primary_bytes + - version + cluster.stats:NodePackagingType: + type: object + properties: + count: + description: Number of selected nodes using the distribution flavor and file type. + type: number + flavor: + description: Type of Opensearch distribution. This is always `default`. + type: string + type: + description: File type (such as `tar` or `zip`) used for the distribution package. + type: string + required: + - count + - flavor + - type + cluster.stats:OperatingSystemMemoryInfo: + type: object + properties: + adjusted_total_in_bytes: + description: Total amount, in bytes, of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set. + type: number + free_in_bytes: + description: Amount, in bytes, of free physical memory across all selected nodes. + type: number + free_percent: + description: Percentage of free physical memory across all selected nodes. + type: number + total_in_bytes: + description: Total amount, in bytes, of physical memory across all selected nodes. + type: number + used_in_bytes: + description: Amount, in bytes, of physical memory in use across all selected nodes. + type: number + used_percent: + description: Percentage of physical memory in use across all selected nodes. + type: number + required: + - free_in_bytes + - free_percent + - total_in_bytes + - used_in_bytes + - used_percent + cluster.stats:RuntimeFieldTypes: + type: object + properties: + chars_max: + description: Maximum number of characters for a single runtime field script. + type: number + chars_total: + description: Total number of characters for the scripts that define the current runtime field data type. + type: number + count: + description: Number of runtime fields mapped to the field data type in selected nodes. + type: number + doc_max: + description: Maximum number of accesses to doc_values for a single runtime field script + type: number + doc_total: + description: Total number of accesses to doc_values for the scripts that define the current runtime field data type. + type: number + index_count: + description: Number of indices containing a mapping of the runtime field data type in selected nodes. + type: number + lang: + description: Script languages used for the runtime fields scripts. + type: array + items: + type: string + lines_max: + description: Maximum number of lines for a single runtime field script. + type: number + lines_total: + description: Total number of lines for the scripts that define the current runtime field data type. + type: number + name: + $ref: '#/components/schemas/_common:Name' + scriptless_count: + description: Number of runtime fields that don’t declare a script. + type: number + shadowed_count: + description: Number of runtime fields that shadow an indexed field. + type: number + source_max: + description: Maximum number of accesses to _source for a single runtime field script. + type: number + source_total: + description: Total number of accesses to _source for the scripts that define the current runtime field data type. + type: number + required: + - chars_max + - chars_total + - count + - doc_max + - doc_total + - index_count + - lang + - lines_max + - lines_total + - name + - scriptless_count + - shadowed_count + - source_max + - source_total + cluster.stats:StatsResponseBase: + allOf: + - $ref: '#/components/schemas/nodes._common:NodesResponseBase' + - type: object + properties: + cluster_name: + $ref: '#/components/schemas/_common:Name' + cluster_uuid: + $ref: '#/components/schemas/_common:Uuid' + indices: + $ref: '#/components/schemas/cluster.stats:ClusterIndices' + nodes: + $ref: '#/components/schemas/cluster.stats:ClusterNodes' + status: + $ref: '#/components/schemas/_common:HealthStatus' + timestamp: + description: Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed. + type: number + required: + - cluster_name + - cluster_uuid + - indices + - nodes + - status + - timestamp + dangling_indices.list_dangling_indices:DanglingIndex: + type: object + properties: + index_name: + type: string + index_uuid: + type: string + creation_date_millis: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + node_ids: + $ref: '#/components/schemas/_common:Ids' + required: + - index_name + - index_uuid + - creation_date_millis + - node_ids + indices._common:Alias: + type: object + properties: + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + index_routing: + $ref: '#/components/schemas/_common:Routing' + is_hidden: + description: |- + If `true`, the alias is hidden. + All indices for the alias must have the same `is_hidden` value. + type: boolean + is_write_index: + description: If `true`, the index is the write index for the alias. + type: boolean + routing: + $ref: '#/components/schemas/_common:Routing' + search_routing: + $ref: '#/components/schemas/_common:Routing' + indices._common:AliasDefinition: + type: object + properties: + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + index_routing: + description: |- + Value used to route indexing operations to a specific shard. + If specified, this overwrites the `routing` value for indexing operations. + type: string + is_write_index: + description: If `true`, the index is the write index for the alias. + type: boolean + routing: + description: Value used to route indexing and search operations to a specific shard. + type: string + search_routing: + description: |- + Value used to route search operations to a specific shard. + If specified, this overwrites the `routing` value for search operations. + type: string + is_hidden: + description: |- + If `true`, the alias is hidden. + All indices for the alias must have the same `is_hidden` value. + type: boolean + indices._common:CacheQueries: + type: object + properties: + enabled: + type: boolean + required: + - enabled + indices._common:DataStream: + type: object + properties: + _meta: + $ref: '#/components/schemas/_common:Metadata' + allow_custom_routing: + description: If `true`, the data stream allows custom routing on write request. + type: boolean + generation: + description: Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1. + type: number + hidden: + description: If `true`, the data stream is hidden. + type: boolean + ilm_policy: + $ref: '#/components/schemas/_common:Name' + next_generation_managed_by: + $ref: '#/components/schemas/indices._common:ManagedBy' + prefer_ilm: + description: Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream. + type: boolean + indices: + description: |- + Array of objects containing information about the data stream’s backing indices. + The last item in this array contains information about the stream’s current write index. + type: array + items: + $ref: '#/components/schemas/indices._common:DataStreamIndex' + lifecycle: + $ref: '#/components/schemas/indices._common:DataStreamLifecycleWithRollover' + name: + $ref: '#/components/schemas/_common:DataStreamName' + replicated: + description: If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings. + type: boolean + status: + $ref: '#/components/schemas/_common:HealthStatus' + system: + description: If `true`, the data stream is created and managed by an Opensearch stack component and cannot be modified through normal user interaction. + type: boolean + template: + $ref: '#/components/schemas/_common:Name' + timestamp_field: + $ref: '#/components/schemas/indices._common:DataStreamTimestampField' + required: + - generation + - hidden + - next_generation_managed_by + - prefer_ilm + - indices + - name + - status + - template + - timestamp_field + indices._common:DataStreamIndex: + type: object + properties: + index_name: + $ref: '#/components/schemas/_common:IndexName' + index_uuid: + $ref: '#/components/schemas/_common:Uuid' + ilm_policy: + $ref: '#/components/schemas/_common:Name' + managed_by: + $ref: '#/components/schemas/indices._common:ManagedBy' + prefer_ilm: + description: Indicates if ILM should take precedence over DSL in case both are configured to manage this index. + type: boolean + required: + - index_name + - index_uuid + - managed_by + - prefer_ilm + indices._common:DataStreamLifecycle: + type: object + properties: + data_retention: + $ref: '#/components/schemas/_common:Duration' + downsampling: + $ref: '#/components/schemas/indices._common:DataStreamLifecycleDownsampling' + indices._common:DataStreamLifecycleDownsampling: + type: object + properties: + rounds: + description: The list of downsampling rounds to execute as part of this downsampling configuration + type: array + items: + $ref: '#/components/schemas/indices._common:DownsamplingRound' + required: + - rounds + indices._common:DataStreamLifecycleRolloverConditions: + type: object + properties: + min_age: + $ref: '#/components/schemas/_common:Duration' + max_age: + type: string + min_docs: + type: number + max_docs: + type: number + min_size: + $ref: '#/components/schemas/_common:ByteSize' + max_size: + $ref: '#/components/schemas/_common:ByteSize' + min_primary_shard_size: + $ref: '#/components/schemas/_common:ByteSize' + max_primary_shard_size: + $ref: '#/components/schemas/_common:ByteSize' + min_primary_shard_docs: + type: number + max_primary_shard_docs: + type: number + indices._common:DataStreamLifecycleWithRollover: + type: object + properties: + data_retention: + $ref: '#/components/schemas/_common:Duration' + downsampling: + $ref: '#/components/schemas/indices._common:DataStreamLifecycleDownsampling' + rollover: + $ref: '#/components/schemas/indices._common:DataStreamLifecycleRolloverConditions' + indices._common:DataStreamTimestampField: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Field' + required: + - name + indices._common:DataStreamVisibility: + type: object + properties: + hidden: + type: boolean + indices._common:DownsampleConfig: + type: object + properties: + fixed_interval: + $ref: '#/components/schemas/_common:DurationLarge' + required: + - fixed_interval + indices._common:DownsamplingRound: + type: object + properties: + after: + $ref: '#/components/schemas/_common:Duration' + config: + $ref: '#/components/schemas/indices._common:DownsampleConfig' + required: + - after + - config + indices._common:FielddataFrequencyFilter: + type: object + properties: + max: + type: number + min: + type: number + min_segment_size: + type: number + required: + - max + - min + - min_segment_size + indices._common:IndexCheckOnStartup: + type: string + enum: + - 'true' + - 'false' + - checksum + indices._common:IndexRouting: + type: object + properties: + allocation: + $ref: '#/components/schemas/indices._common:IndexRoutingAllocation' + rebalance: + $ref: '#/components/schemas/indices._common:IndexRoutingRebalance' + indices._common:IndexRoutingAllocation: + type: object + properties: + enable: + $ref: '#/components/schemas/indices._common:IndexRoutingAllocationOptions' + include: + $ref: '#/components/schemas/indices._common:IndexRoutingAllocationInclude' + initial_recovery: + $ref: '#/components/schemas/indices._common:IndexRoutingAllocationInitialRecovery' + disk: + $ref: '#/components/schemas/indices._common:IndexRoutingAllocationDisk' + indices._common:IndexRoutingAllocationDisk: + type: object + properties: + threshold_enabled: + oneOf: + - type: boolean + - type: string + indices._common:IndexRoutingAllocationInclude: + type: object + properties: + _tier_preference: + type: string + _id: + $ref: '#/components/schemas/_common:Id' + indices._common:IndexRoutingAllocationInitialRecovery: + type: object + properties: + _id: + $ref: '#/components/schemas/_common:Id' + indices._common:IndexRoutingAllocationOptions: + type: string + enum: + - all + - primaries + - new_primaries + - none + indices._common:IndexRoutingRebalance: + type: object + properties: + enable: + $ref: '#/components/schemas/indices._common:IndexRoutingRebalanceOptions' + required: + - enable + indices._common:IndexRoutingRebalanceOptions: + type: string + enum: + - all + - primaries + - replicas + - none + indices._common:IndexSegmentSort: + type: object + properties: + field: + $ref: '#/components/schemas/_common:Fields' + order: + oneOf: + - $ref: '#/components/schemas/indices._common:SegmentSortOrder' + - type: array + items: + $ref: '#/components/schemas/indices._common:SegmentSortOrder' + mode: + oneOf: + - $ref: '#/components/schemas/indices._common:SegmentSortMode' + - type: array + items: + $ref: '#/components/schemas/indices._common:SegmentSortMode' + missing: + oneOf: + - $ref: '#/components/schemas/indices._common:SegmentSortMissing' + - type: array + items: + $ref: '#/components/schemas/indices._common:SegmentSortMissing' + indices._common:IndexSettingBlocks: + type: object + properties: + read_only: + $ref: '#/components/schemas/_common:Stringifiedboolean' + read_only_allow_delete: + $ref: '#/components/schemas/_common:Stringifiedboolean' + read: + $ref: '#/components/schemas/_common:Stringifiedboolean' + write: + $ref: '#/components/schemas/_common:Stringifiedboolean' + metadata: + $ref: '#/components/schemas/_common:Stringifiedboolean' + indices._common:IndexSettings: + type: object + properties: + index: + $ref: '#/components/schemas/indices._common:IndexSettings' + mode: + type: string + routing_path: + oneOf: + - type: string + - type: array + items: + type: string + soft_deletes: + $ref: '#/components/schemas/indices._common:SoftDeletes' + sort: + $ref: '#/components/schemas/indices._common:IndexSegmentSort' + number_of_shards: + oneOf: + - type: number + - type: string + number_of_replicas: + oneOf: + - type: number + - type: string + number_of_routing_shards: + type: number + check_on_startup: + $ref: '#/components/schemas/indices._common:IndexCheckOnStartup' + codec: + type: string + routing_partition_size: + $ref: '#/components/schemas/_common:Stringifiedinteger' + load_fixed_bitset_filters_eagerly: + type: boolean + hidden: + oneOf: + - type: boolean + - type: string + auto_expand_replicas: + type: string + merge: + $ref: '#/components/schemas/indices._common:Merge' + search: + $ref: '#/components/schemas/indices._common:SettingsSearch' + refresh_interval: + $ref: '#/components/schemas/_common:Duration' + max_result_window: + type: number + max_inner_result_window: + type: number + max_rescore_window: + type: number + max_docvalue_fields_search: + type: number + max_script_fields: + type: number + max_ngram_diff: + type: number + max_shingle_diff: + type: number + blocks: + $ref: '#/components/schemas/indices._common:IndexSettingBlocks' + max_refresh_listeners: + type: number + analyze: + $ref: '#/components/schemas/indices._common:SettingsAnalyze' + highlight: + $ref: '#/components/schemas/indices._common:SettingsHighlight' + max_terms_count: + type: number + max_regex_length: + type: number + routing: + $ref: '#/components/schemas/indices._common:IndexRouting' + gc_deletes: + $ref: '#/components/schemas/_common:Duration' + default_pipeline: + $ref: '#/components/schemas/_common:PipelineName' + final_pipeline: + $ref: '#/components/schemas/_common:PipelineName' + lifecycle: + $ref: '#/components/schemas/indices._common:IndexSettingsLifecycle' + provided_name: + $ref: '#/components/schemas/_common:Name' + creation_date: + $ref: '#/components/schemas/_common:StringifiedEpochTimeUnitMillis' + creation_date_string: + $ref: '#/components/schemas/_common:DateTime' + uuid: + $ref: '#/components/schemas/_common:Uuid' + version: + $ref: '#/components/schemas/indices._common:IndexVersioning' + verified_before_close: + oneOf: + - type: boolean + - type: string + format: + oneOf: + - type: string + - type: number + max_slices_per_scroll: + type: number + translog: + $ref: '#/components/schemas/indices._common:Translog' + query_string: + $ref: '#/components/schemas/indices._common:SettingsQueryString' + priority: + oneOf: + - type: number + - type: string + top_metrics_max_size: + type: number + analysis: + $ref: '#/components/schemas/indices._common:IndexSettingsAnalysis' + settings: + $ref: '#/components/schemas/indices._common:IndexSettings' + time_series: + $ref: '#/components/schemas/indices._common:IndexSettingsTimeSeries' + queries: + $ref: '#/components/schemas/indices._common:Queries' + similarity: + $ref: '#/components/schemas/indices._common:SettingsSimilarity' + mapping: + $ref: '#/components/schemas/indices._common:MappingLimitSettings' + indexing.slowlog: + $ref: '#/components/schemas/indices._common:IndexingSlowlogSettings' + indexing_pressure: + $ref: '#/components/schemas/indices._common:IndexingPressure' + store: + $ref: '#/components/schemas/indices._common:Storage' + description: The index settings to be updated + indices._common:IndexSettingsAnalysis: + type: object + properties: + analyzer: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.analysis:Analyzer' + char_filter: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.analysis:CharFilter' + filter: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.analysis:TokenFilter' + normalizer: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.analysis:Normalizer' + tokenizer: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.analysis:Tokenizer' + indices._common:IndexSettingsLifecycle: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + indexing_complete: + $ref: '#/components/schemas/_common:Stringifiedboolean' + origination_date: + description: |- + 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. + type: number + parse_origination_date: + description: |- + 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. + type: boolean + step: + $ref: '#/components/schemas/indices._common:IndexSettingsLifecycleStep' + rollover_alias: + description: |- + 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. + type: string + required: + - name + indices._common:IndexSettingsLifecycleStep: + type: object + properties: + wait_time_threshold: + $ref: '#/components/schemas/_common:Duration' + indices._common:IndexSettingsTimeSeries: + type: object + properties: + end_time: + $ref: '#/components/schemas/_common:DateTime' + start_time: + $ref: '#/components/schemas/_common:DateTime' + indices._common:IndexState: + type: object + properties: + aliases: + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:Alias' + mappings: + $ref: '#/components/schemas/_common.mapping:TypeMapping' + settings: + $ref: '#/components/schemas/indices._common:IndexSettings' + defaults: + $ref: '#/components/schemas/indices._common:IndexSettings' + data_stream: + $ref: '#/components/schemas/_common:DataStreamName' + lifecycle: + $ref: '#/components/schemas/indices._common:DataStreamLifecycle' + indices._common:IndexTemplate: + type: object + properties: + index_patterns: + $ref: '#/components/schemas/_common:Names' + composed_of: + description: |- + An ordered list of component template names. + Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + type: array + items: + $ref: '#/components/schemas/_common:Name' + template: + $ref: '#/components/schemas/indices._common:IndexTemplateSummary' + version: + $ref: '#/components/schemas/_common:VersionNumber' + priority: + description: |- + Priority to determine index template precedence when a new data stream or index is created. + The index template with the highest priority is chosen. + If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + This number is not automatically generated by Opensearch. + type: number + _meta: + $ref: '#/components/schemas/_common:Metadata' + allow_auto_create: + type: boolean + data_stream: + $ref: '#/components/schemas/indices._common:IndexTemplateDataStreamConfiguration' + required: + - index_patterns + - composed_of + description: New index template definition to be simulated, if no index template name is specified + indices._common:IndexTemplateDataStreamConfiguration: + type: object + properties: + hidden: + description: If true, the data stream is hidden. + type: boolean + allow_custom_routing: + description: If true, the data stream supports custom routing. + type: boolean + indices._common:IndexTemplateSummary: + type: object + properties: + aliases: + description: |- + Aliases to add. + If the index template includes a `data_stream` object, these are data stream aliases. + Otherwise, these are index aliases. + Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:Alias' + mappings: + $ref: '#/components/schemas/_common.mapping:TypeMapping' + settings: + $ref: '#/components/schemas/indices._common:IndexSettings' + lifecycle: + $ref: '#/components/schemas/indices._common:DataStreamLifecycleWithRollover' + indices._common:IndexVersioning: + type: object + properties: + created: + $ref: '#/components/schemas/_common:VersionString' + created_string: + type: string + indices._common:IndexingPressure: + type: object + properties: + memory: + $ref: '#/components/schemas/indices._common:IndexingPressureMemory' + required: + - memory + indices._common:IndexingPressureMemory: + type: object + properties: + limit: + description: |- + 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. + type: number + indices._common:IndexingSlowlogSettings: + type: object + properties: + level: + type: string + source: + type: number + reformat: + type: boolean + threshold: + $ref: '#/components/schemas/indices._common:IndexingSlowlogTresholds' + indices._common:IndexingSlowlogTresholds: + type: object + properties: + index: + $ref: '#/components/schemas/indices._common:SlowlogTresholdLevels' + indices._common:ManagedBy: + type: string + enum: + - Index Lifecycle Management + - Data stream lifecycle + - Unmanaged + indices._common:MappingLimitSettings: + type: object + properties: + coerce: + type: boolean + total_fields: + $ref: '#/components/schemas/indices._common:MappingLimitSettingsTotalFields' + depth: + $ref: '#/components/schemas/indices._common:MappingLimitSettingsDepth' + nested_fields: + $ref: '#/components/schemas/indices._common:MappingLimitSettingsNestedFields' + nested_objects: + $ref: '#/components/schemas/indices._common:MappingLimitSettingsNestedObjects' + field_name_length: + $ref: '#/components/schemas/indices._common:MappingLimitSettingsFieldNameLength' + dimension_fields: + $ref: '#/components/schemas/indices._common:MappingLimitSettingsDimensionFields' + ignore_malformed: + type: boolean + indices._common:MappingLimitSettingsDepth: + type: object + properties: + limit: + description: |- + 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. + type: number + indices._common:MappingLimitSettingsDimensionFields: + type: object + properties: + limit: + description: |- + [preview] This functionality is in technical preview and may be changed or removed in a future release. + Opensearch will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. + type: number + indices._common:MappingLimitSettingsFieldNameLength: + type: object + properties: + limit: + description: |- + 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). + type: number + indices._common:MappingLimitSettingsNestedFields: + type: object + properties: + limit: + description: |- + 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. + type: number + indices._common:MappingLimitSettingsNestedObjects: + type: object + properties: + limit: + description: |- + 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. + type: number + indices._common:MappingLimitSettingsTotalFields: + type: object + properties: + limit: + description: |- + 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. + type: number + indices._common:Merge: + type: object + properties: + scheduler: + $ref: '#/components/schemas/indices._common:MergeScheduler' + indices._common:MergeScheduler: + type: object + properties: + max_thread_count: + $ref: '#/components/schemas/_common:Stringifiedinteger' + max_merge_count: + $ref: '#/components/schemas/_common:Stringifiedinteger' + indices._common:NumericFielddata: + type: object + properties: + format: + $ref: '#/components/schemas/indices._common:NumericFielddataFormat' + required: + - format + indices._common:NumericFielddataFormat: + type: string + enum: + - array + - disabled + indices._common:Queries: + type: object + properties: + cache: + $ref: '#/components/schemas/indices._common:CacheQueries' + indices._common:RetentionLease: + type: object + properties: + period: + $ref: '#/components/schemas/_common:Duration' + required: + - period + indices._common:SearchIdle: + type: object + properties: + after: + $ref: '#/components/schemas/_common:Duration' + indices._common:SegmentSortMissing: + type: string + enum: + - _last + - _first + indices._common:SegmentSortMode: + type: string + enum: + - min + - max + indices._common:SegmentSortOrder: + type: string + enum: + - asc + - desc + indices._common:SettingsAnalyze: + type: object + properties: + max_token_count: + $ref: '#/components/schemas/_common:Stringifiedinteger' + indices._common:SettingsHighlight: + type: object + properties: + max_analyzed_offset: + type: number + indices._common:SettingsQueryString: + type: object + properties: + lenient: + $ref: '#/components/schemas/_common:Stringifiedboolean' + required: + - lenient + indices._common:SettingsSearch: + type: object + properties: + idle: + $ref: '#/components/schemas/indices._common:SearchIdle' + slowlog: + $ref: '#/components/schemas/indices._common:SlowlogSettings' + indices._common:SettingsSimilarity: + type: object + properties: + bm25: + $ref: '#/components/schemas/indices._common:SettingsSimilarityBm25' + dfi: + $ref: '#/components/schemas/indices._common:SettingsSimilarityDfi' + dfr: + $ref: '#/components/schemas/indices._common:SettingsSimilarityDfr' + ib: + $ref: '#/components/schemas/indices._common:SettingsSimilarityIb' + lmd: + $ref: '#/components/schemas/indices._common:SettingsSimilarityLmd' + lmj: + $ref: '#/components/schemas/indices._common:SettingsSimilarityLmj' + scripted_tfidf: + $ref: '#/components/schemas/indices._common:SettingsSimilarityScriptedTfidf' + indices._common:SettingsSimilarityBm25: + type: object + properties: + b: + type: number + discount_overlaps: + type: boolean + k1: + type: number + type: + type: string + enum: + - BM25 + required: + - b + - discount_overlaps + - k1 + - type + indices._common:SettingsSimilarityDfi: + type: object + properties: + independence_measure: + $ref: '#/components/schemas/_common:DFIIndependenceMeasure' + type: + type: string + enum: + - DFI + required: + - independence_measure + - type + indices._common:SettingsSimilarityDfr: + type: object + properties: + after_effect: + $ref: '#/components/schemas/_common:DFRAfterEffect' + basic_model: + $ref: '#/components/schemas/_common:DFRBasicModel' + normalization: + $ref: '#/components/schemas/_common:Normalization' + type: + type: string + enum: + - DFR + required: + - after_effect + - basic_model + - normalization + - type + indices._common:SettingsSimilarityIb: + type: object + properties: + distribution: + $ref: '#/components/schemas/_common:IBDistribution' + lambda: + $ref: '#/components/schemas/_common:IBLambda' + normalization: + $ref: '#/components/schemas/_common:Normalization' + type: + type: string + enum: + - IB + required: + - distribution + - lambda + - normalization + - type + indices._common:SettingsSimilarityLmd: + type: object + properties: + mu: + type: number + type: + type: string + enum: + - LMDirichlet + required: + - mu + - type + indices._common:SettingsSimilarityLmj: + type: object + properties: + lambda: + type: number + type: + type: string + enum: + - LMJelinekMercer + required: + - lambda + - type + indices._common:SettingsSimilarityScriptedTfidf: + type: object + properties: + script: + $ref: '#/components/schemas/_common:Script' + type: + type: string + enum: + - scripted + required: + - script + - type + indices._common:SlowlogSettings: + type: object + properties: + level: + type: string + source: + type: number + reformat: + type: boolean + threshold: + $ref: '#/components/schemas/indices._common:SlowlogTresholds' + indices._common:SlowlogTresholdLevels: + type: object + properties: + warn: + $ref: '#/components/schemas/_common:Duration' + info: + $ref: '#/components/schemas/_common:Duration' + debug: + $ref: '#/components/schemas/_common:Duration' + trace: + $ref: '#/components/schemas/_common:Duration' + indices._common:SlowlogTresholds: + type: object + properties: + query: + $ref: '#/components/schemas/indices._common:SlowlogTresholdLevels' + fetch: + $ref: '#/components/schemas/indices._common:SlowlogTresholdLevels' + indices._common:SoftDeletes: + type: object + properties: + enabled: + description: Indicates whether soft deletes are enabled on the index. + type: boolean + retention_lease: + $ref: '#/components/schemas/indices._common:RetentionLease' + indices._common:Storage: + type: object + properties: + type: + $ref: '#/components/schemas/indices._common:StorageType' + allow_mmap: + description: |- + 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. + type: boolean + required: + - type + indices._common:StorageType: + type: string + enum: + - fs + - niofs + - mmapfs + - hybridfs + indices._common:TemplateMapping: + type: object + properties: + aliases: + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:Alias' + index_patterns: + type: array + items: + $ref: '#/components/schemas/_common:Name' + mappings: + $ref: '#/components/schemas/_common.mapping:TypeMapping' + order: + type: number + settings: + type: object + additionalProperties: + type: object + version: + $ref: '#/components/schemas/_common:VersionNumber' + required: + - aliases + - index_patterns + - mappings + - order + - settings + indices._common:Translog: + type: object + properties: + sync_interval: + $ref: '#/components/schemas/_common:Duration' + durability: + $ref: '#/components/schemas/indices._common:TranslogDurability' + flush_threshold_size: + $ref: '#/components/schemas/_common:ByteSize' + retention: + $ref: '#/components/schemas/indices._common:TranslogRetention' + indices._common:TranslogDurability: + type: string + enum: + - request + - async + indices._common:TranslogRetention: + type: object + properties: + size: + $ref: '#/components/schemas/_common:ByteSize' + age: + $ref: '#/components/schemas/_common:Duration' + indices.add_block:IndicesBlockOptions: + type: string + enum: + - metadata + - read + - read_only + - write + indices.add_block:IndicesBlockStatus: + type: object + properties: + name: + $ref: '#/components/schemas/_common:IndexName' + blocked: + type: boolean + required: + - name + - blocked + indices.analyze:AnalyzeDetail: + type: object + properties: + analyzer: + $ref: '#/components/schemas/indices.analyze:AnalyzerDetail' + charfilters: + type: array + items: + $ref: '#/components/schemas/indices.analyze:CharFilterDetail' + custom_analyzer: + type: boolean + tokenfilters: + type: array + items: + $ref: '#/components/schemas/indices.analyze:TokenDetail' + tokenizer: + $ref: '#/components/schemas/indices.analyze:TokenDetail' + required: + - custom_analyzer + indices.analyze:AnalyzeToken: + type: object + properties: + end_offset: + type: number + position: + type: number + positionLength: + type: number + start_offset: + type: number + token: + type: string + type: + type: string + required: + - end_offset + - position + - start_offset + - token + - type + indices.analyze:AnalyzerDetail: + type: object + properties: + name: + type: string + tokens: + type: array + items: + $ref: '#/components/schemas/indices.analyze:ExplainAnalyzeToken' + required: + - name + - tokens + indices.analyze:CharFilterDetail: + type: object + properties: + filtered_text: + type: array + items: + type: string + name: + type: string + required: + - filtered_text + - name + indices.analyze:ExplainAnalyzeToken: + type: object + properties: + bytes: + type: string + end_offset: + type: number + keyword: + type: boolean + position: + type: number + positionLength: + type: number + start_offset: + type: number + termFrequency: + type: number + token: + type: string + type: + type: string + required: + - bytes + - end_offset + - position + - positionLength + - start_offset + - termFrequency + - token + - type + indices.analyze:TextToAnalyze: + oneOf: + - type: string + - type: array + items: + type: string + indices.analyze:TokenDetail: + type: object + properties: + name: + type: string + tokens: + type: array + items: + $ref: '#/components/schemas/indices.analyze:ExplainAnalyzeToken' + required: + - name + - tokens + indices.close:CloseIndexResult: + type: object + properties: + closed: + type: boolean + shards: + type: object + additionalProperties: + $ref: '#/components/schemas/indices.close:CloseShardResult' + required: + - closed + indices.close:CloseShardResult: + type: object + properties: + failures: + type: array + items: + $ref: '#/components/schemas/_common:ShardFailure' + required: + - failures + indices.data_streams_stats:DataStreamsStatsItem: + type: object + properties: + backing_indices: + description: Current number of backing indices for the data stream. + type: number + data_stream: + $ref: '#/components/schemas/_common:Name' + maximum_timestamp: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + store_size: + $ref: '#/components/schemas/_common:ByteSize' + store_size_bytes: + description: Total size, in bytes, of all shards for the data stream’s backing indices. + type: number + required: + - backing_indices + - data_stream + - maximum_timestamp + - store_size_bytes + indices.forcemerge._types:ForceMergeResponseBody: + allOf: + - $ref: '#/components/schemas/_common:ShardsOperationResponseBase' + - type: object + properties: + task: + description: |- + task contains a task id returned when wait_for_completion=false, + you can use the task_id to get the status of the task at _tasks/ + type: string + indices.get_alias:IndexAliases: + type: object + properties: + aliases: + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:AliasDefinition' + required: + - aliases + indices.get_field_mapping:TypeFieldMappings: + type: object + properties: + mappings: + type: object + additionalProperties: + $ref: '#/components/schemas/_common.mapping:FieldMapping' + required: + - mappings + indices.get_index_template:IndexTemplateItem: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + index_template: + $ref: '#/components/schemas/indices._common:IndexTemplate' + required: + - name + - index_template + indices.get_mapping:IndexMappingRecord: + type: object + properties: + item: + $ref: '#/components/schemas/_common.mapping:TypeMapping' + mappings: + $ref: '#/components/schemas/_common.mapping:TypeMapping' + required: + - mappings + indices.put_index_template:IndexTemplateMapping: + type: object + properties: + aliases: + description: |- + Aliases to add. + If the index template includes a `data_stream` object, these are data stream aliases. + Otherwise, these are index aliases. + Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:Alias' + mappings: + $ref: '#/components/schemas/_common.mapping:TypeMapping' + settings: + $ref: '#/components/schemas/indices._common:IndexSettings' + lifecycle: + $ref: '#/components/schemas/indices._common:DataStreamLifecycle' + indices.recovery:FileDetails: + type: object + properties: + length: + type: number + name: + type: string + recovered: + type: number + required: + - length + - name + - recovered + indices.recovery:RecoveryBytes: + type: object + properties: + percent: + $ref: '#/components/schemas/_common:Percentage' + recovered: + $ref: '#/components/schemas/_common:ByteSize' + recovered_in_bytes: + $ref: '#/components/schemas/_common:ByteSize' + recovered_from_snapshot: + $ref: '#/components/schemas/_common:ByteSize' + recovered_from_snapshot_in_bytes: + $ref: '#/components/schemas/_common:ByteSize' + reused: + $ref: '#/components/schemas/_common:ByteSize' + reused_in_bytes: + $ref: '#/components/schemas/_common:ByteSize' + total: + $ref: '#/components/schemas/_common:ByteSize' + total_in_bytes: + $ref: '#/components/schemas/_common:ByteSize' + required: + - percent + - recovered_in_bytes + - reused_in_bytes + - total_in_bytes + indices.recovery:RecoveryFiles: + type: object + properties: + details: + type: array + items: + $ref: '#/components/schemas/indices.recovery:FileDetails' + percent: + $ref: '#/components/schemas/_common:Percentage' + recovered: + type: number + reused: + type: number + total: + type: number + required: + - percent + - recovered + - reused + - total + indices.recovery:RecoveryIndexStatus: + type: object + properties: + bytes: + $ref: '#/components/schemas/indices.recovery:RecoveryBytes' + files: + $ref: '#/components/schemas/indices.recovery:RecoveryFiles' + size: + $ref: '#/components/schemas/indices.recovery:RecoveryBytes' + source_throttle_time: + $ref: '#/components/schemas/_common:Duration' + source_throttle_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + target_throttle_time: + $ref: '#/components/schemas/_common:Duration' + target_throttle_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total_time: + $ref: '#/components/schemas/_common:Duration' + total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - files + - size + - source_throttle_time_in_millis + - target_throttle_time_in_millis + - total_time_in_millis + indices.recovery:RecoveryOrigin: + type: object + properties: + hostname: + type: string + host: + $ref: '#/components/schemas/_common:Host' + transport_address: + $ref: '#/components/schemas/_common:TransportAddress' + id: + $ref: '#/components/schemas/_common:Id' + ip: + $ref: '#/components/schemas/_common:Ip' + name: + $ref: '#/components/schemas/_common:Name' + bootstrap_new_history_uuid: + type: boolean + repository: + $ref: '#/components/schemas/_common:Name' + snapshot: + $ref: '#/components/schemas/_common:Name' + version: + $ref: '#/components/schemas/_common:VersionString' + restoreUUID: + $ref: '#/components/schemas/_common:Uuid' + index: + $ref: '#/components/schemas/_common:IndexName' + indices.recovery:RecoveryStartStatus: + type: object + properties: + check_index_time: + $ref: '#/components/schemas/_common:Duration' + check_index_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total_time: + $ref: '#/components/schemas/_common:Duration' + total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - check_index_time_in_millis + - total_time_in_millis + indices.recovery:RecoveryStatus: + type: object + properties: + shards: + type: array + items: + $ref: '#/components/schemas/indices.recovery:ShardRecovery' + required: + - shards + indices.recovery:ShardRecovery: + type: object + properties: + id: + type: number + index: + $ref: '#/components/schemas/indices.recovery:RecoveryIndexStatus' + primary: + type: boolean + source: + $ref: '#/components/schemas/indices.recovery:RecoveryOrigin' + stage: + type: string + start: + $ref: '#/components/schemas/indices.recovery:RecoveryStartStatus' + start_time: + $ref: '#/components/schemas/_common:DateTime' + start_time_in_millis: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + stop_time: + $ref: '#/components/schemas/_common:DateTime' + stop_time_in_millis: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + target: + $ref: '#/components/schemas/indices.recovery:RecoveryOrigin' + total_time: + $ref: '#/components/schemas/_common:Duration' + total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + translog: + $ref: '#/components/schemas/indices.recovery:TranslogStatus' + type: + type: string + verify_index: + $ref: '#/components/schemas/indices.recovery:VerifyIndex' + required: + - id + - index + - primary + - source + - stage + - start_time_in_millis + - target + - total_time_in_millis + - translog + - type + - verify_index + indices.recovery:TranslogStatus: + type: object + properties: + percent: + $ref: '#/components/schemas/_common:Percentage' + recovered: + type: number + total: + type: number + total_on_start: + type: number + total_time: + $ref: '#/components/schemas/_common:Duration' + total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - percent + - recovered + - total + - total_on_start + - total_time_in_millis + indices.recovery:VerifyIndex: + type: object + properties: + check_index_time: + $ref: '#/components/schemas/_common:Duration' + check_index_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total_time: + $ref: '#/components/schemas/_common:Duration' + total_time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - check_index_time_in_millis + - total_time_in_millis + indices.resolve_index:ResolveIndexAliasItem: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + indices: + $ref: '#/components/schemas/_common:Indices' + required: + - name + - indices + indices.resolve_index:ResolveIndexDataStreamsItem: + type: object + properties: + name: + $ref: '#/components/schemas/_common:DataStreamName' + timestamp_field: + $ref: '#/components/schemas/_common:Field' + backing_indices: + $ref: '#/components/schemas/_common:Indices' + required: + - name + - timestamp_field + - backing_indices + indices.resolve_index:ResolveIndexItem: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + aliases: + type: array + items: + type: string + attributes: + type: array + items: + type: string + data_stream: + $ref: '#/components/schemas/_common:DataStreamName' + required: + - name + - attributes + indices.rollover:RolloverConditions: + type: object + properties: + min_age: + $ref: '#/components/schemas/_common:Duration' + max_age: + $ref: '#/components/schemas/_common:Duration' + max_age_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + min_docs: + type: number + max_docs: + type: number + max_size: + $ref: '#/components/schemas/_common:ByteSize' + max_size_bytes: + type: number + min_size: + $ref: '#/components/schemas/_common:ByteSize' + min_size_bytes: + type: number + max_primary_shard_size: + $ref: '#/components/schemas/_common:ByteSize' + max_primary_shard_size_bytes: + type: number + min_primary_shard_size: + $ref: '#/components/schemas/_common:ByteSize' + min_primary_shard_size_bytes: + type: number + max_primary_shard_docs: + type: number + min_primary_shard_docs: + type: number + indices.segments:IndexSegment: + type: object + properties: + shards: + type: object + additionalProperties: + oneOf: + - $ref: '#/components/schemas/indices.segments:ShardsSegment' + - type: array + items: + $ref: '#/components/schemas/indices.segments:ShardsSegment' + required: + - shards + indices.segments:Segment: + type: object + properties: + attributes: + type: object + additionalProperties: + type: string + committed: + type: boolean + compound: + type: boolean + deleted_docs: + type: number + generation: + type: number + search: + type: boolean + size_in_bytes: + type: number + num_docs: + type: number + version: + $ref: '#/components/schemas/_common:VersionString' + required: + - attributes + - committed + - compound + - deleted_docs + - generation + - search + - size_in_bytes + - num_docs + - version + indices.segments:ShardSegmentRouting: + type: object + properties: + node: + type: string + primary: + type: boolean + state: + type: string + required: + - node + - primary + - state + indices.segments:ShardsSegment: + type: object + properties: + num_committed_segments: + type: number + routing: + $ref: '#/components/schemas/indices.segments:ShardSegmentRouting' + num_search_segments: + type: number + segments: + type: object + additionalProperties: + $ref: '#/components/schemas/indices.segments:Segment' + required: + - num_committed_segments + - routing + - num_search_segments + - segments + indices.shard_stores:IndicesShardStores: + type: object + properties: + shards: + type: object + additionalProperties: + $ref: '#/components/schemas/indices.shard_stores:ShardStoreWrapper' + required: + - shards + indices.shard_stores:ShardStore: + type: object + properties: + allocation: + $ref: '#/components/schemas/indices.shard_stores:ShardStoreAllocation' + allocation_id: + $ref: '#/components/schemas/_common:Id' + store_exception: + $ref: '#/components/schemas/indices.shard_stores:ShardStoreException' + required: + - allocation + indices.shard_stores:ShardStoreAllocation: + type: string + enum: + - primary + - replica + - unused + indices.shard_stores:ShardStoreException: + type: object + properties: + reason: + type: string + type: + type: string + required: + - reason + - type + indices.shard_stores:ShardStoreStatus: + type: string + enum: + - green + - yellow + - red + - all + indices.shard_stores:ShardStoreWrapper: + type: object + properties: + stores: + type: array + items: + $ref: '#/components/schemas/indices.shard_stores:ShardStore' + required: + - stores + indices.simulate_template:Overlapping: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + index_patterns: + type: array + items: + type: string + required: + - name + - index_patterns + indices.simulate_template:Template: + type: object + properties: + aliases: + type: object + additionalProperties: + $ref: '#/components/schemas/indices._common:Alias' + mappings: + $ref: '#/components/schemas/_common.mapping:TypeMapping' + settings: + $ref: '#/components/schemas/indices._common:IndexSettings' + required: + - aliases + - mappings + - settings + indices.stats:IndexMetadataState: + type: string + enum: + - open + - close + indices.stats:IndexStats: + type: object + properties: + completion: + $ref: '#/components/schemas/_common:CompletionStats' + docs: + $ref: '#/components/schemas/_common:DocStats' + fielddata: + $ref: '#/components/schemas/_common:FielddataStats' + flush: + $ref: '#/components/schemas/_common:FlushStats' + get: + $ref: '#/components/schemas/_common:GetStats' + indexing: + $ref: '#/components/schemas/_common:IndexingStats' + indices: + $ref: '#/components/schemas/indices.stats:IndicesStats' + merges: + $ref: '#/components/schemas/_common:MergesStats' + query_cache: + $ref: '#/components/schemas/_common:QueryCacheStats' + recovery: + $ref: '#/components/schemas/_common:RecoveryStats' + refresh: + $ref: '#/components/schemas/_common:RefreshStats' + request_cache: + $ref: '#/components/schemas/_common:RequestCacheStats' + search: + $ref: '#/components/schemas/_common:SearchStats' + segments: + $ref: '#/components/schemas/_common:SegmentsStats' + store: + $ref: '#/components/schemas/_common:StoreStats' + translog: + $ref: '#/components/schemas/_common:TranslogStats' + warmer: + $ref: '#/components/schemas/_common:WarmerStats' + bulk: + $ref: '#/components/schemas/_common:BulkStats' + shard_stats: + $ref: '#/components/schemas/indices.stats:ShardsTotalStats' + indices.stats:IndicesStats: + type: object + properties: + primaries: + $ref: '#/components/schemas/indices.stats:IndexStats' + shards: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/indices.stats:ShardStats' + total: + $ref: '#/components/schemas/indices.stats:IndexStats' + uuid: + $ref: '#/components/schemas/_common:Uuid' + health: + $ref: '#/components/schemas/_common:HealthStatus' + status: + $ref: '#/components/schemas/indices.stats:IndexMetadataState' + indices.stats:MappingStats: + type: object + properties: + total_count: + type: number + total_estimated_overhead: + $ref: '#/components/schemas/_common:ByteSize' + total_estimated_overhead_in_bytes: + type: number + required: + - total_count + - total_estimated_overhead_in_bytes + indices.stats:ShardCommit: + type: object + properties: + generation: + type: number + id: + $ref: '#/components/schemas/_common:Id' + num_docs: + type: number + user_data: + type: object + additionalProperties: + type: string + required: + - generation + - id + - num_docs + - user_data + indices.stats:ShardFileSizeInfo: + type: object + properties: + description: + type: string + size_in_bytes: + type: number + min_size_in_bytes: + type: number + max_size_in_bytes: + type: number + average_size_in_bytes: + type: number + count: + type: number + required: + - description + - size_in_bytes + indices.stats:ShardLease: + type: object + properties: + id: + $ref: '#/components/schemas/_common:Id' + retaining_seq_no: + $ref: '#/components/schemas/_common:SequenceNumber' + timestamp: + type: number + source: + type: string + required: + - id + - retaining_seq_no + - timestamp + - source + indices.stats:ShardPath: + type: object + properties: + data_path: + type: string + is_custom_data_path: + type: boolean + state_path: + type: string + required: + - data_path + - is_custom_data_path + - state_path + indices.stats:ShardQueryCache: + type: object + properties: + cache_count: + type: number + cache_size: + type: number + evictions: + type: number + hit_count: + type: number + memory_size_in_bytes: + type: number + miss_count: + type: number + total_count: + type: number + required: + - cache_count + - cache_size + - evictions + - hit_count + - memory_size_in_bytes + - miss_count + - total_count + indices.stats:ShardRetentionLeases: + type: object + properties: + primary_term: + type: number + version: + $ref: '#/components/schemas/_common:VersionNumber' + leases: + type: array + items: + $ref: '#/components/schemas/indices.stats:ShardLease' + required: + - primary_term + - version + - leases + indices.stats:ShardRouting: + type: object + properties: + node: + type: string + primary: + type: boolean + relocating_node: + oneOf: + - type: string + - nullable: true + type: string + state: + $ref: '#/components/schemas/indices.stats:ShardRoutingState' + required: + - node + - primary + - state + indices.stats:ShardRoutingState: + type: string + enum: + - UNASSIGNED + - INITIALIZING + - STARTED + - RELOCATING + indices.stats:ShardSequenceNumber: + type: object + properties: + global_checkpoint: + type: number + local_checkpoint: + type: number + max_seq_no: + $ref: '#/components/schemas/_common:SequenceNumber' + required: + - global_checkpoint + - local_checkpoint + - max_seq_no + indices.stats:ShardStats: + type: object + properties: + commit: + $ref: '#/components/schemas/indices.stats:ShardCommit' + completion: + $ref: '#/components/schemas/_common:CompletionStats' + docs: + $ref: '#/components/schemas/_common:DocStats' + fielddata: + $ref: '#/components/schemas/_common:FielddataStats' + flush: + $ref: '#/components/schemas/_common:FlushStats' + get: + $ref: '#/components/schemas/_common:GetStats' + indexing: + $ref: '#/components/schemas/_common:IndexingStats' + mappings: + $ref: '#/components/schemas/indices.stats:MappingStats' + merges: + $ref: '#/components/schemas/_common:MergesStats' + shard_path: + $ref: '#/components/schemas/indices.stats:ShardPath' + query_cache: + $ref: '#/components/schemas/indices.stats:ShardQueryCache' + recovery: + $ref: '#/components/schemas/_common:RecoveryStats' + refresh: + $ref: '#/components/schemas/_common:RefreshStats' + request_cache: + $ref: '#/components/schemas/_common:RequestCacheStats' + retention_leases: + $ref: '#/components/schemas/indices.stats:ShardRetentionLeases' + routing: + $ref: '#/components/schemas/indices.stats:ShardRouting' + search: + $ref: '#/components/schemas/_common:SearchStats' + segments: + $ref: '#/components/schemas/_common:SegmentsStats' + seq_no: + $ref: '#/components/schemas/indices.stats:ShardSequenceNumber' + store: + $ref: '#/components/schemas/_common:StoreStats' + translog: + $ref: '#/components/schemas/_common:TranslogStats' + warmer: + $ref: '#/components/schemas/_common:WarmerStats' + bulk: + $ref: '#/components/schemas/_common:BulkStats' + shards: + type: object + additionalProperties: + type: object + shard_stats: + $ref: '#/components/schemas/indices.stats:ShardsTotalStats' + indices: + $ref: '#/components/schemas/indices.stats:IndicesStats' + indices.stats:ShardsTotalStats: + type: object + properties: + total_count: + type: number + required: + - total_count + indices.update_aliases:Action: + type: object + properties: + add: + $ref: '#/components/schemas/indices.update_aliases:AddAction' + remove: + $ref: '#/components/schemas/indices.update_aliases:RemoveAction' + remove_index: + $ref: '#/components/schemas/indices.update_aliases:RemoveIndexAction' + minProperties: 1 + maxProperties: 1 + indices.update_aliases:AddAction: + type: object + properties: + alias: + $ref: '#/components/schemas/_common:IndexAlias' + aliases: + description: |- + Aliases for the action. + Index alias names support date math. + oneOf: + - $ref: '#/components/schemas/_common:IndexAlias' + - type: array + items: + $ref: '#/components/schemas/_common:IndexAlias' + filter: + $ref: '#/components/schemas/_common.query_dsl:QueryContainer' + index: + $ref: '#/components/schemas/_common:IndexName' + indices: + $ref: '#/components/schemas/_common:Indices' + index_routing: + $ref: '#/components/schemas/_common:Routing' + is_hidden: + description: If `true`, the alias is hidden. + type: boolean + is_write_index: + description: If `true`, sets the write index or data stream for the alias. + type: boolean + routing: + $ref: '#/components/schemas/_common:Routing' + search_routing: + $ref: '#/components/schemas/_common:Routing' + must_exist: + description: If `true`, the alias must exist to perform the action. + type: boolean + indices.update_aliases:RemoveAction: + type: object + properties: + alias: + $ref: '#/components/schemas/_common:IndexAlias' + aliases: + description: |- + Aliases for the action. + Index alias names support date math. + oneOf: + - $ref: '#/components/schemas/_common:IndexAlias' + - type: array + items: + $ref: '#/components/schemas/_common:IndexAlias' + index: + $ref: '#/components/schemas/_common:IndexName' + indices: + $ref: '#/components/schemas/_common:Indices' + must_exist: + description: If `true`, the alias must exist to perform the action. + type: boolean + indices.update_aliases:RemoveIndexAction: + type: object + properties: + index: + $ref: '#/components/schemas/_common:IndexName' + indices: + $ref: '#/components/schemas/_common:Indices' + must_exist: + description: If `true`, the alias must exist to perform the action. + type: boolean + indices.validate_query:IndicesValidationExplanation: + type: object + properties: + error: + type: string + explanation: + type: string + index: + $ref: '#/components/schemas/_common:IndexName' + valid: + type: boolean + required: + - index + - valid + ingest._common:AppendProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + value: + description: The value to be appended. Supports template snippets. + type: array + items: + type: object + allow_duplicates: + description: If `false`, the processor does not append values already present in the field. + type: boolean + required: + - field + - value + ingest._common:AttachmentProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true` and field does not exist, the processor quietly exits without modifying the document. + type: boolean + indexed_chars: + description: |- + The number of chars being used for extraction to prevent huge fields. + Use `-1` for no limit. + type: number + indexed_chars_field: + $ref: '#/components/schemas/_common:Field' + properties: + description: |- + Array of properties to select to be stored. + Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`. + type: array + items: + type: string + target_field: + $ref: '#/components/schemas/_common:Field' + resource_name: + description: |- + Field containing the name of the resource to decode. + If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + type: string + required: + - field + ingest._common:BytesProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + type: boolean + target_field: + $ref: '#/components/schemas/_common:Field' + required: + - field + ingest._common:CircleProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + error_distance: + description: The difference between the resulting inscribed distance from center to side and the circle’s radius (measured in meters for `geo_shape`, unit-less for `shape`). + type: number + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + type: boolean + shape_type: + $ref: '#/components/schemas/ingest._common:ShapeType' + target_field: + $ref: '#/components/schemas/_common:Field' + required: + - error_distance + - field + - shape_type + ingest._common:ConvertProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + type: boolean + target_field: + $ref: '#/components/schemas/_common:Field' + type: + $ref: '#/components/schemas/ingest._common:ConvertType' + required: + - field + - type + ingest._common:ConvertType: + type: string + enum: + - integer + - long + - float + - double + - string + - boolean + - auto + ingest._common:CsvProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + empty_value: + description: |- + Value used to fill empty fields. + Empty fields are skipped if this is not provided. + An empty field is one with no value (2 consecutive separators) or empty quotes (`""`). + type: object + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + type: boolean + quote: + description: Quote used in CSV, has to be single character string. + type: string + separator: + description: Separator used in CSV, has to be single character string. + type: string + target_fields: + $ref: '#/components/schemas/_common:Fields' + trim: + description: Trim whitespaces in unquoted fields. + type: boolean + required: + - field + - target_fields + ingest._common:DateIndexNameProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + date_formats: + description: |- + An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. + Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + type: array + items: + type: string + date_rounding: + description: |- + 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. + type: string + field: + $ref: '#/components/schemas/_common:Field' + index_name_format: + description: |- + The format to be used when printing the parsed date into the index name. + A valid java time pattern is expected here. + Supports template snippets. + type: string + index_name_prefix: + description: |- + A prefix of the index name to be prepended before the printed date. + Supports template snippets. + type: string + locale: + description: The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days. + type: string + timezone: + description: The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names. + type: string + required: + - date_formats + - date_rounding + - field + ingest._common:DateProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + formats: + description: |- + An array of the expected date formats. + Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + type: array + items: + type: string + locale: + description: |- + The locale to use when parsing the date, relevant when parsing month names or week days. + Supports template snippets. + type: string + target_field: + $ref: '#/components/schemas/_common:Field' + timezone: + description: |- + The timezone to use when parsing the date. + Supports template snippets. + type: string + required: + - field + - formats + ingest._common:DissectProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + append_separator: + description: The character(s) that separate the appended fields. + type: string + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + type: boolean + pattern: + description: The pattern to apply to the field. + type: string + required: + - field + - pattern + ingest._common:DotExpanderProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + path: + description: |- + The field that contains the field to expand. + Only required if the field to expand is part another object field, because the `field` option can only understand leaf fields. + type: string + required: + - field + ingest._common:DropProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + ingest._common:EnrichProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + type: boolean + max_matches: + description: |- + The maximum number of matched documents to include under the configured target field. + The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object. + In order to avoid documents getting too large, the maximum allowed value is 128. + type: number + override: + description: |- + If processor will update fields with pre-existing non-null-valued field. + When set to `false`, such fields will not be touched. + type: boolean + policy_name: + description: The name of the enrich policy to use. + type: string + shape_relation: + $ref: '#/components/schemas/_common:GeoShapeRelation' + target_field: + $ref: '#/components/schemas/_common:Field' + required: + - field + - policy_name + - target_field + ingest._common:FailProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + message: + description: |- + The error message thrown by the processor. + Supports template snippets. + type: string + required: + - message + ingest._common:ForeachProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. + type: boolean + processor: + $ref: '#/components/schemas/ingest._common:ProcessorContainer' + required: + - field + - processor + ingest._common:GeoIpProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + database_file: + description: The database filename referring to a database the module ships with (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + type: string + field: + $ref: '#/components/schemas/_common:Field' + first_only: + description: If `true`, only the first found geoip data will be returned, even if the field contains an array. + type: boolean + ignore_missing: + description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + type: boolean + properties: + description: Controls what properties are added to the `target_field` based on the geoip lookup. + type: array + items: + type: string + target_field: + $ref: '#/components/schemas/_common:Field' + required: + - field + ingest._common:GrokProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + type: boolean + pattern_definitions: + description: |- + A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. + Patterns matching existing names will override the pre-existing definition. + type: object + additionalProperties: + type: string + patterns: + description: |- + An ordered list of grok expression to match and extract named captures with. + Returns on the first expression in the list that matches. + type: array + items: + type: string + trace_match: + description: When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the index into the pattern found in `patterns` that matched. + type: boolean + required: + - field + - patterns + ingest._common:GsubProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + type: boolean + pattern: + description: The pattern to be replaced. + type: string + replacement: + description: The string to replace the matching patterns with. + type: string + target_field: + $ref: '#/components/schemas/_common:Field' + required: + - field + - pattern + - replacement + ingest._common:InferenceConfig: + type: object + properties: + regression: + $ref: '#/components/schemas/ingest._common:InferenceConfigRegression' + classification: + $ref: '#/components/schemas/ingest._common:InferenceConfigClassification' + minProperties: 1 + maxProperties: 1 + ingest._common:InferenceConfigClassification: + type: object + properties: + num_top_classes: + description: Specifies the number of top class predictions to return. + type: number + num_top_feature_importance_values: + description: Specifies the maximum number of feature importance values per document. + type: number + results_field: + $ref: '#/components/schemas/_common:Field' + top_classes_results_field: + $ref: '#/components/schemas/_common:Field' + prediction_field_type: + description: |- + Specifies the type of the predicted field to write. + Valid values are: `string`, `number`, `boolean`. + type: string + ingest._common:InferenceConfigRegression: + type: object + properties: + results_field: + $ref: '#/components/schemas/_common:Field' + num_top_feature_importance_values: + description: Specifies the maximum number of feature importance values per document. + type: number + ingest._common:InferenceProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + model_id: + $ref: '#/components/schemas/_common:Id' + target_field: + $ref: '#/components/schemas/_common:Field' + field_map: + description: |- + Maps the document field names to the known field names of the model. + This mapping takes precedence over any default mappings provided in the model configuration. + type: object + additionalProperties: + type: object + inference_config: + $ref: '#/components/schemas/ingest._common:InferenceConfig' + required: + - model_id + ingest._common:JoinProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + separator: + description: The separator character. + type: string + target_field: + $ref: '#/components/schemas/_common:Field' + required: + - field + - separator + ingest._common:JsonProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + add_to_root: + description: |- + Flag that forces the parsed JSON to be added at the top level of the document. + `target_field` must not be set when this option is chosen. + type: boolean + add_to_root_conflict_strategy: + $ref: '#/components/schemas/ingest._common:JsonProcessorConflictStrategy' + allow_duplicate_keys: + description: |- + When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys. + Instead, the last encountered value for any duplicate key wins. + type: boolean + field: + $ref: '#/components/schemas/_common:Field' + target_field: + $ref: '#/components/schemas/_common:Field' + required: + - field + ingest._common:JsonProcessorConflictStrategy: + type: string + enum: + - replace + - merge + ingest._common:KeyValueProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + exclude_keys: + description: List of keys to exclude from document. + type: array + items: + type: string + field: + $ref: '#/components/schemas/_common:Field' + field_split: + description: Regex pattern to use for splitting key-value pairs. + type: string + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + type: boolean + include_keys: + description: |- + List of keys to filter and insert into document. + Defaults to including all keys. + type: array + items: + type: string + prefix: + description: Prefix to be added to extracted keys. + type: string + strip_brackets: + description: If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. + type: boolean + target_field: + $ref: '#/components/schemas/_common:Field' + trim_key: + description: String of characters to trim from extracted keys. + type: string + trim_value: + description: String of characters to trim from extracted values. + type: string + value_split: + description: Regex pattern to use for splitting the key from the value within a key-value pair. + type: string + required: + - field + - field_split + - value_split + ingest._common:LowercaseProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + type: boolean + target_field: + $ref: '#/components/schemas/_common:Field' + required: + - field + ingest._common:Pipeline: + type: object + properties: + description: + description: Description of the ingest pipeline. + type: string + on_failure: + description: Processors to run immediately after a processor failure. + type: array + items: + $ref: '#/components/schemas/ingest._common:ProcessorContainer' + processors: + description: |- + Processors used to perform transformations on documents before indexing. + Processors run sequentially in the order specified. + type: array + items: + $ref: '#/components/schemas/ingest._common:ProcessorContainer' + version: + $ref: '#/components/schemas/_common:VersionNumber' + _meta: + $ref: '#/components/schemas/_common:Metadata' + required: + - _meta + ingest._common:PipelineProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + ignore_missing_pipeline: + description: Whether to ignore missing pipelines instead of failing. + type: boolean + required: + - name + ingest._common:ProcessorBase: + type: object + properties: + description: + description: |- + Description of the processor. + Useful for describing the purpose of the processor or its configuration. + type: string + if: + description: Conditionally execute the processor. + type: string + ignore_failure: + description: Ignore failures for the processor. + type: boolean + on_failure: + description: Handle failures for the processor. + type: array + items: + $ref: '#/components/schemas/ingest._common:ProcessorContainer' + tag: + description: |- + Identifier for the processor. + Useful for debugging and metrics. + type: string + ingest._common:ProcessorContainer: + type: object + properties: + attachment: + $ref: '#/components/schemas/ingest._common:AttachmentProcessor' + append: + $ref: '#/components/schemas/ingest._common:AppendProcessor' + csv: + $ref: '#/components/schemas/ingest._common:CsvProcessor' + convert: + $ref: '#/components/schemas/ingest._common:ConvertProcessor' + date: + $ref: '#/components/schemas/ingest._common:DateProcessor' + date_index_name: + $ref: '#/components/schemas/ingest._common:DateIndexNameProcessor' + dot_expander: + $ref: '#/components/schemas/ingest._common:DotExpanderProcessor' + enrich: + $ref: '#/components/schemas/ingest._common:EnrichProcessor' + fail: + $ref: '#/components/schemas/ingest._common:FailProcessor' + foreach: + $ref: '#/components/schemas/ingest._common:ForeachProcessor' + json: + $ref: '#/components/schemas/ingest._common:JsonProcessor' + user_agent: + $ref: '#/components/schemas/ingest._common:UserAgentProcessor' + kv: + $ref: '#/components/schemas/ingest._common:KeyValueProcessor' + geoip: + $ref: '#/components/schemas/ingest._common:GeoIpProcessor' + grok: + $ref: '#/components/schemas/ingest._common:GrokProcessor' + gsub: + $ref: '#/components/schemas/ingest._common:GsubProcessor' + join: + $ref: '#/components/schemas/ingest._common:JoinProcessor' + lowercase: + $ref: '#/components/schemas/ingest._common:LowercaseProcessor' + remove: + $ref: '#/components/schemas/ingest._common:RemoveProcessor' + rename: + $ref: '#/components/schemas/ingest._common:RenameProcessor' + script: + $ref: '#/components/schemas/_common:Script' + set: + $ref: '#/components/schemas/ingest._common:SetProcessor' + sort: + $ref: '#/components/schemas/ingest._common:SortProcessor' + split: + $ref: '#/components/schemas/ingest._common:SplitProcessor' + trim: + $ref: '#/components/schemas/ingest._common:TrimProcessor' + uppercase: + $ref: '#/components/schemas/ingest._common:UppercaseProcessor' + urldecode: + $ref: '#/components/schemas/ingest._common:UrlDecodeProcessor' + bytes: + $ref: '#/components/schemas/ingest._common:BytesProcessor' + dissect: + $ref: '#/components/schemas/ingest._common:DissectProcessor' + set_security_user: + $ref: '#/components/schemas/ingest._common:SetSecurityUserProcessor' + pipeline: + $ref: '#/components/schemas/ingest._common:PipelineProcessor' + drop: + $ref: '#/components/schemas/ingest._common:DropProcessor' + circle: + $ref: '#/components/schemas/ingest._common:CircleProcessor' + inference: + $ref: '#/components/schemas/ingest._common:InferenceProcessor' + minProperties: 1 + maxProperties: 1 + ingest._common:RemoveProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Fields' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + type: boolean + required: + - field + ingest._common:RenameProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + type: boolean + target_field: + $ref: '#/components/schemas/_common:Field' + required: + - field + - target_field + ingest._common:SetProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + copy_from: + $ref: '#/components/schemas/_common:Field' + field: + $ref: '#/components/schemas/_common:Field' + ignore_empty_value: + description: If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor quietly exits without modifying the document. + type: boolean + media_type: + description: |- + The media type for encoding `value`. + Applies only when value is a template snippet. + Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`. + type: string + override: + description: |- + If `true` processor will update fields with pre-existing non-null-valued field. + When set to `false`, such fields will not be touched. + type: boolean + value: + description: |- + The value to be set for the field. + Supports template snippets. + May specify only one of `value` or `copy_from`. + type: object + required: + - field + ingest._common:SetSecurityUserProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + properties: + description: Controls what user related properties are added to the field. + type: array + items: + type: string + required: + - field + ingest._common:ShapeType: + type: string + enum: + - geo_shape + - shape + ingest._common:SortProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + order: + $ref: '#/components/schemas/_common:SortOrder' + target_field: + $ref: '#/components/schemas/_common:Field' + required: + - field + ingest._common:SplitProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + type: boolean + preserve_trailing: + description: Preserves empty trailing fields, if any. + type: boolean + separator: + description: A regex which matches the separator, for example, `,` or `\s+`. + type: string + target_field: + $ref: '#/components/schemas/_common:Field' + required: + - field + - separator + ingest._common:TrimProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + type: boolean + target_field: + $ref: '#/components/schemas/_common:Field' + required: + - field + ingest._common:UppercaseProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + type: boolean + target_field: + $ref: '#/components/schemas/_common:Field' + required: + - field + ingest._common:UrlDecodeProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the document. + type: boolean + target_field: + $ref: '#/components/schemas/_common:Field' + required: + - field + ingest._common:UserAgentProcessor: + allOf: + - $ref: '#/components/schemas/ingest._common:ProcessorBase' + - type: object + properties: + field: + $ref: '#/components/schemas/_common:Field' + ignore_missing: + description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + type: boolean + options: + type: array + items: + $ref: '#/components/schemas/ingest._common:UserAgentProperty' + regex_file: + description: The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for parsing the user agent string. Both the directory and the file have to be created before starting Opensearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. + type: string + target_field: + $ref: '#/components/schemas/_common:Field' + required: + - field + ingest._common:UserAgentProperty: + type: string + enum: + - NAME + - MAJOR + - MINOR + - PATCH + - OS + - OS_NAME + - OS_MAJOR + - OS_MINOR + - DEVICE + - BUILD + ingest.simulate:Document: + type: object + properties: + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' + _source: + description: JSON body for the document. + type: object + required: + - _source + ingest.simulate:DocumentSimulation: + type: object + properties: + _id: + $ref: '#/components/schemas/_common:Id' + _index: + $ref: '#/components/schemas/_common:IndexName' + _ingest: + $ref: '#/components/schemas/ingest.simulate:Ingest' + _routing: + description: Value used to send the document to a specific primary shard. + type: string + _source: + description: JSON body for the document. + type: object + additionalProperties: + type: object + _version: + $ref: '#/components/schemas/_common:StringifiedVersionNumber' + _version_type: + $ref: '#/components/schemas/_common:VersionType' + required: + - _id + - _index + - _ingest + - _source + ingest.simulate:Ingest: + type: object + properties: + timestamp: + $ref: '#/components/schemas/_common:DateTime' + pipeline: + $ref: '#/components/schemas/_common:Name' + required: + - timestamp + ingest.simulate:PipelineSimulation: + type: object + properties: + doc: + $ref: '#/components/schemas/ingest.simulate:DocumentSimulation' + processor_results: + type: array + items: + $ref: '#/components/schemas/ingest.simulate:PipelineSimulation' + tag: + type: string + processor_type: + type: string + status: + $ref: '#/components/schemas/_common:ActionStatusOptions' + knn._common:DefaultOperator: + type: string + description: The default operator for query string query (AND or OR). + enum: + - AND + - OR + knn._common:SearchType: + type: string + description: Search operation type. + enum: + - query_then_fetch + - dfs_query_then_fetch + knn._common:SuggestMode: + type: string + description: Specify suggest mode. + enum: + - missing + - popular + - always + nodes._common:AdaptiveSelection: + type: object + properties: + avg_queue_size: + description: The exponentially weighted moving average queue size of search requests on the keyed node. + type: number + avg_response_time: + $ref: '#/components/schemas/_common:Duration' + avg_response_time_ns: + description: The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node. + type: number + avg_service_time: + $ref: '#/components/schemas/_common:Duration' + avg_service_time_ns: + description: The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node. + type: number + outgoing_searches: + description: The number of outstanding search requests to the keyed node from the node these stats are for. + type: number + rank: + description: The rank of this node; used for shard selection when routing search requests. + type: string + nodes._common:Breaker: + type: object + properties: + estimated_size: + description: Estimated memory used for the operation. + type: string + estimated_size_in_bytes: + description: Estimated memory used, in bytes, for the operation. + type: number + limit_size: + description: Memory limit for the circuit breaker. + type: string + limit_size_in_bytes: + description: Memory limit, in bytes, for the circuit breaker. + type: number + overhead: + description: A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate. + type: number + tripped: + description: Total number of times the circuit breaker has been triggered and prevented an out of memory error. + type: number + nodes._common:Cgroup: + type: object + properties: + cpuacct: + $ref: '#/components/schemas/nodes._common:CpuAcct' + cpu: + $ref: '#/components/schemas/nodes._common:CgroupCpu' + memory: + $ref: '#/components/schemas/nodes._common:CgroupMemory' + nodes._common:CgroupCpu: + type: object + properties: + control_group: + description: The `cpu` control group to which the Opensearch process belongs. + type: string + cfs_period_micros: + description: The period of time, in microseconds, for how regularly all tasks in the same cgroup as the Opensearch process should have their access to CPU resources reallocated. + type: number + cfs_quota_micros: + description: The total amount of time, in microseconds, for which all tasks in the same cgroup as the Opensearch process can run during one period `cfs_period_micros`. + type: number + stat: + $ref: '#/components/schemas/nodes._common:CgroupCpuStat' + nodes._common:CgroupCpuStat: + type: object + properties: + number_of_elapsed_periods: + description: The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed. + type: number + number_of_times_throttled: + description: The number of times all tasks in the same cgroup as the Opensearch process have been throttled. + type: number + time_throttled_nanos: + $ref: '#/components/schemas/_common:DurationValueUnitNanos' + nodes._common:CgroupMemory: + type: object + properties: + control_group: + description: The `memory` control group to which the Opensearch process belongs. + type: string + limit_in_bytes: + description: |- + The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the Opensearch process. + This value can be too big to store in a `long`, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns. + Any value that is too large to parse into a `long` almost certainly means no limit has been set for the cgroup. + type: string + usage_in_bytes: + description: |- + The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the Opensearch process. + This value is stored as a string for consistency with `limit_in_bytes`. + type: string + nodes._common:Client: + type: object + properties: + id: + description: Unique ID for the HTTP client. + type: number + agent: + description: |- + Reported agent for the HTTP client. + If unavailable, this property is not included in the response. + type: string + local_address: + description: Local address for the HTTP connection. + type: string + remote_address: + description: Remote address for the HTTP connection. + type: string + last_uri: + description: The URI of the client’s most recent request. + type: string + opened_time_millis: + description: Time at which the client opened the connection. + type: number + closed_time_millis: + description: Time at which the client closed the connection if the connection is closed. + type: number + last_request_time_millis: + description: Time of the most recent request from this client. + type: number + request_count: + description: Number of requests from this client. + type: number + request_size_bytes: + description: Cumulative size in bytes of all requests from this client. + type: number + x_opaque_id: + description: |- + Value from the client’s `x-opaque-id` HTTP header. + If unavailable, this property is not included in the response. + type: string + nodes._common:ClusterAppliedStats: + type: object + properties: + recordings: + type: array + items: + $ref: '#/components/schemas/nodes._common:Recording' + nodes._common:ClusterStateQueue: + type: object + properties: + total: + description: Total number of cluster states in queue. + type: number + pending: + description: Number of pending cluster states in queue. + type: number + committed: + description: Number of committed cluster states in queue. + type: number + nodes._common:ClusterStateUpdate: + type: object + properties: + count: + description: The number of cluster state update attempts that did not change the cluster state since the node started. + type: number + computation_time: + $ref: '#/components/schemas/_common:Duration' + computation_time_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + publication_time: + $ref: '#/components/schemas/_common:Duration' + publication_time_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + context_construction_time: + $ref: '#/components/schemas/_common:Duration' + context_construction_time_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + commit_time: + $ref: '#/components/schemas/_common:Duration' + commit_time_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + completion_time: + $ref: '#/components/schemas/_common:Duration' + completion_time_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + master_apply_time: + $ref: '#/components/schemas/_common:Duration' + master_apply_time_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + notification_time: + $ref: '#/components/schemas/_common:Duration' + notification_time_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - count + nodes._common:Context: + type: object + properties: + context: + type: string + compilations: + type: number + cache_evictions: + type: number + compilation_limit_triggered: + type: number + nodes._common:Cpu: + type: object + properties: + percent: + type: number + sys: + $ref: '#/components/schemas/_common:Duration' + sys_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total: + $ref: '#/components/schemas/_common:Duration' + total_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + user: + $ref: '#/components/schemas/_common:Duration' + user_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + load_average: + type: object + additionalProperties: + type: number + nodes._common:CpuAcct: + type: object + properties: + control_group: + description: The `cpuacct` control group to which the Opensearch process belongs. + type: string + usage_nanos: + $ref: '#/components/schemas/_common:DurationValueUnitNanos' + nodes._common:DataPathStats: + type: object + properties: + available: + description: Total amount of disk space available to this Java virtual machine on this file store. + type: string + available_in_bytes: + description: Total number of bytes available to this Java virtual machine on this file store. + type: number + disk_queue: + type: string + disk_reads: + type: number + disk_read_size: + type: string + disk_read_size_in_bytes: + type: number + disk_writes: + type: number + disk_write_size: + type: string + disk_write_size_in_bytes: + type: number + free: + description: Total amount of unallocated disk space in the file store. + type: string + free_in_bytes: + description: Total number of unallocated bytes in the file store. + type: number + mount: + description: 'Mount point of the file store (for example: `/dev/sda2`).' + type: string + path: + description: Path to the file store. + type: string + total: + description: Total size of the file store. + type: string + total_in_bytes: + description: Total size of the file store in bytes. + type: number + type: + description: 'Type of the file store (ex: ext4).' + type: string + nodes._common:Discovery: + type: object + properties: + cluster_state_queue: + $ref: '#/components/schemas/nodes._common:ClusterStateQueue' + published_cluster_states: + $ref: '#/components/schemas/nodes._common:PublishedClusterStates' + cluster_state_update: + description: |- + Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master. + Omitted if the node is not master-eligible. + Every field whose name ends in `_time` within this object is also represented as a raw number of milliseconds in a field whose name ends in `_time_millis`. + The human-readable fields with a `_time` suffix are only returned if requested with the `?human=true` query parameter. + type: object + additionalProperties: + $ref: '#/components/schemas/nodes._common:ClusterStateUpdate' + serialized_cluster_states: + $ref: '#/components/schemas/nodes._common:SerializedClusterState' + cluster_applier_stats: + $ref: '#/components/schemas/nodes._common:ClusterAppliedStats' + nodes._common:ExtendedMemoryStats: + allOf: + - $ref: '#/components/schemas/nodes._common:MemoryStats' + - type: object + properties: + free_percent: + description: Percentage of free memory. + type: number + used_percent: + description: Percentage of used memory. + type: number + nodes._common:FileSystem: + type: object + properties: + data: + description: List of all file stores. + type: array + items: + $ref: '#/components/schemas/nodes._common:DataPathStats' + timestamp: + description: |- + Last time the file stores statistics were refreshed. + Recorded in milliseconds since the Unix Epoch. + type: number + total: + $ref: '#/components/schemas/nodes._common:FileSystemTotal' + io_stats: + $ref: '#/components/schemas/nodes._common:IoStats' + nodes._common:FileSystemTotal: + type: object + properties: + available: + description: |- + Total disk space available to this Java virtual machine on all file stores. + Depending on OS or process level restrictions, this might appear less than `free`. + This is the actual amount of free disk space the Opensearch node can utilise. + type: string + available_in_bytes: + description: |- + Total number of bytes available to this Java virtual machine on all file stores. + Depending on OS or process level restrictions, this might appear less than `free_in_bytes`. + This is the actual amount of free disk space the Opensearch node can utilise. + type: number + free: + description: Total unallocated disk space in all file stores. + type: string + free_in_bytes: + description: Total number of unallocated bytes in all file stores. + type: number + total: + description: Total size of all file stores. + type: string + total_in_bytes: + description: Total size of all file stores in bytes. + type: number + nodes._common:GarbageCollector: + type: object + properties: + collectors: + description: Contains statistics about JVM garbage collectors for the node. + type: object + additionalProperties: + $ref: '#/components/schemas/nodes._common:GarbageCollectorTotal' + nodes._common:GarbageCollectorTotal: + type: object + properties: + collection_count: + description: Total number of JVM garbage collectors that collect objects. + type: number + collection_time: + description: Total time spent by JVM collecting objects. + type: string + collection_time_in_millis: + description: Total time, in milliseconds, spent by JVM collecting objects. + type: number + nodes._common:Http: + type: object + properties: + current_open: + description: Current number of open HTTP connections for the node. + type: number + total_opened: + description: Total number of HTTP connections opened for the node. + type: number + clients: + description: |- + Information on current and recently-closed HTTP client connections. + Clients that have been closed longer than the `http.client_stats.closed_channels.max_age` setting will not be represented here. + type: array + items: + $ref: '#/components/schemas/nodes._common:Client' + nodes._common:IndexingPressure: + type: object + properties: + memory: + $ref: '#/components/schemas/nodes._common:IndexingPressureMemory' + nodes._common:IndexingPressureMemory: + type: object + properties: + limit: + $ref: '#/components/schemas/_common:ByteSize' + limit_in_bytes: + description: |- + Configured memory limit, in bytes, for the indexing requests. + Replica requests have an automatic limit that is 1.5x this value. + type: number + current: + $ref: '#/components/schemas/nodes._common:PressureMemory' + total: + $ref: '#/components/schemas/nodes._common:PressureMemory' + nodes._common:Ingest: + type: object + properties: + pipelines: + description: Contains statistics about ingest pipelines for the node. + type: object + additionalProperties: + $ref: '#/components/schemas/nodes._common:IngestTotal' + total: + $ref: '#/components/schemas/nodes._common:IngestTotal' + nodes._common:IngestTotal: + type: object + properties: + count: + description: Total number of documents ingested during the lifetime of this node. + type: number + current: + description: Total number of documents currently being ingested. + type: number + failed: + description: Total number of failed ingest operations during the lifetime of this node. + type: number + processors: + description: Total number of ingest processors. + type: array + items: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes._common:KeyedProcessor' + time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + nodes._common:IoStatDevice: + type: object + properties: + device_name: + description: The Linux device name. + type: string + operations: + description: The total number of read and write operations for the device completed since starting Opensearch. + type: number + read_kilobytes: + description: The total number of kilobytes read for the device since starting Opensearch. + type: number + read_operations: + description: The total number of read operations for the device completed since starting Opensearch. + type: number + write_kilobytes: + description: The total number of kilobytes written for the device since starting Opensearch. + type: number + write_operations: + description: The total number of write operations for the device completed since starting Opensearch. + type: number + nodes._common:IoStats: + type: object + properties: + devices: + description: |- + Array of disk metrics for each device that is backing an Opensearch data path. + These disk metrics are probed periodically and averages between the last probe and the current probe are computed. + type: array + items: + $ref: '#/components/schemas/nodes._common:IoStatDevice' + total: + $ref: '#/components/schemas/nodes._common:IoStatDevice' + nodes._common:Jvm: + type: object + properties: + buffer_pools: + description: Contains statistics about JVM buffer pools for the node. + type: object + additionalProperties: + $ref: '#/components/schemas/nodes._common:NodeBufferPool' + classes: + $ref: '#/components/schemas/nodes._common:JvmClasses' + gc: + $ref: '#/components/schemas/nodes._common:GarbageCollector' + mem: + $ref: '#/components/schemas/nodes._common:JvmMemoryStats' + threads: + $ref: '#/components/schemas/nodes._common:JvmThreads' + timestamp: + description: Last time JVM statistics were refreshed. + type: number + uptime: + description: |- + Human-readable JVM uptime. + Only returned if the `human` query parameter is `true`. + type: string + uptime_in_millis: + description: JVM uptime in milliseconds. + type: number + nodes._common:JvmClasses: + type: object + properties: + current_loaded_count: + description: Number of classes currently loaded by JVM. + type: number + total_loaded_count: + description: Total number of classes loaded since the JVM started. + type: number + total_unloaded_count: + description: Total number of classes unloaded since the JVM started. + type: number + nodes._common:JvmMemoryStats: + type: object + properties: + heap_used_in_bytes: + description: Memory, in bytes, currently in use by the heap. + type: number + heap_used_percent: + description: Percentage of memory currently in use by the heap. + type: number + heap_committed_in_bytes: + description: Amount of memory, in bytes, available for use by the heap. + type: number + heap_max_in_bytes: + description: Maximum amount of memory, in bytes, available for use by the heap. + type: number + non_heap_used_in_bytes: + description: Non-heap memory used, in bytes. + type: number + non_heap_committed_in_bytes: + description: Amount of non-heap memory available, in bytes. + type: number + pools: + description: Contains statistics about heap memory usage for the node. + type: object + additionalProperties: + $ref: '#/components/schemas/nodes._common:Pool' + nodes._common:JvmThreads: + type: object + properties: + count: + description: Number of active threads in use by JVM. + type: number + peak_count: + description: Highest number of threads used by JVM. + type: number + nodes._common:KeyedProcessor: + type: object + properties: + stats: + $ref: '#/components/schemas/nodes._common:Processor' + type: + type: string + nodes._common:MemoryStats: + type: object + properties: + adjusted_total_in_bytes: + description: |- + If the amount of physical memory has been overridden using the `es`.`total_memory_bytes` system property then this reports the overridden value in bytes. + Otherwise it reports the same value as `total_in_bytes`. + type: number + resident: + type: string + resident_in_bytes: + type: number + share: + type: string + share_in_bytes: + type: number + total_virtual: + type: string + total_virtual_in_bytes: + type: number + total_in_bytes: + description: Total amount of physical memory in bytes. + type: number + free_in_bytes: + description: Amount of free physical memory in bytes. + type: number + used_in_bytes: + description: Amount of used physical memory in bytes. + type: number + nodes._common:NodeBufferPool: + type: object + properties: + count: + description: Number of buffer pools. + type: number + total_capacity: + description: Total capacity of buffer pools. + type: string + total_capacity_in_bytes: + description: Total capacity of buffer pools in bytes. + type: number + used: + description: Size of buffer pools. + type: string + used_in_bytes: + description: Size of buffer pools in bytes. + type: number + nodes._common:NodeReloadError: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + reload_exception: + $ref: '#/components/schemas/_common:ErrorCause' + required: + - name + nodes._common:NodeReloadResult: + oneOf: + - $ref: '#/components/schemas/nodes._common:Stats' + - $ref: '#/components/schemas/nodes._common:NodeReloadError' + nodes._common:NodesResponseBase: + type: object + properties: + _nodes: + $ref: '#/components/schemas/_common:NodeStatistics' + nodes._common:OperatingSystem: + type: object + properties: + cpu: + $ref: '#/components/schemas/nodes._common:Cpu' + mem: + $ref: '#/components/schemas/nodes._common:ExtendedMemoryStats' + swap: + $ref: '#/components/schemas/nodes._common:MemoryStats' + cgroup: + $ref: '#/components/schemas/nodes._common:Cgroup' + timestamp: + type: number + nodes._common:Pool: + type: object + properties: + used_in_bytes: + description: Memory, in bytes, used by the heap. + type: number + max_in_bytes: + description: Maximum amount of memory, in bytes, available for use by the heap. + type: number + peak_used_in_bytes: + description: Largest amount of memory, in bytes, historically used by the heap. + type: number + peak_max_in_bytes: + description: Largest amount of memory, in bytes, historically used by the heap. + type: number + nodes._common:PressureMemory: + type: object + properties: + all: + $ref: '#/components/schemas/_common:ByteSize' + all_in_bytes: + description: Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage. + type: number + combined_coordinating_and_primary: + $ref: '#/components/schemas/_common:ByteSize' + combined_coordinating_and_primary_in_bytes: + description: |- + Memory consumed, in bytes, by indexing requests in the coordinating or primary stage. + This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. + type: number + coordinating: + $ref: '#/components/schemas/_common:ByteSize' + coordinating_in_bytes: + description: Memory consumed, in bytes, by indexing requests in the coordinating stage. + type: number + primary: + $ref: '#/components/schemas/_common:ByteSize' + primary_in_bytes: + description: Memory consumed, in bytes, by indexing requests in the primary stage. + type: number + replica: + $ref: '#/components/schemas/_common:ByteSize' + replica_in_bytes: + description: Memory consumed, in bytes, by indexing requests in the replica stage. + type: number + coordinating_rejections: + description: Number of indexing requests rejected in the coordinating stage. + type: number + primary_rejections: + description: Number of indexing requests rejected in the primary stage. + type: number + replica_rejections: + description: Number of indexing requests rejected in the replica stage. + type: number + nodes._common:Process: + type: object + properties: + cpu: + $ref: '#/components/schemas/nodes._common:Cpu' + mem: + $ref: '#/components/schemas/nodes._common:MemoryStats' + open_file_descriptors: + description: Number of opened file descriptors associated with the current or `-1` if not supported. + type: number + max_file_descriptors: + description: Maximum number of file descriptors allowed on the system, or `-1` if not supported. + type: number + timestamp: + description: |- + Last time the statistics were refreshed. + Recorded in milliseconds since the Unix Epoch. + type: number + nodes._common:Processor: + type: object + properties: + count: + description: Number of documents transformed by the processor. + type: number + current: + description: Number of documents currently being transformed by the processor. + type: number + failed: + description: Number of failed operations for the processor. + type: number + time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + nodes._common:PublishedClusterStates: + type: object + properties: + full_states: + description: Number of published cluster states. + type: number + incompatible_diffs: + description: Number of incompatible differences between published cluster states. + type: number + compatible_diffs: + description: Number of compatible differences between published cluster states. + type: number + nodes._common:Recording: + type: object + properties: + name: + type: string + cumulative_execution_count: + type: number + cumulative_execution_time: + $ref: '#/components/schemas/_common:Duration' + cumulative_execution_time_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + nodes._common:SampleType: + type: string + description: The type to sample. + enum: + - cpu + - wait + - block + nodes._common:ScriptCache: + type: object + properties: + cache_evictions: + description: Total number of times the script cache has evicted old data. + type: number + compilation_limit_triggered: + description: Total number of times the script compilation circuit breaker has limited inline script compilations. + type: number + compilations: + description: Total number of inline script compilations performed by the node. + type: number + context: + type: string + nodes._common:Scripting: + type: object + properties: + cache_evictions: + description: Total number of times the script cache has evicted old data. + type: number + compilations: + description: Total number of inline script compilations performed by the node. + type: number + compilations_history: + description: Contains this recent history of script compilations. + type: object + additionalProperties: + type: number + compilation_limit_triggered: + description: Total number of times the script compilation circuit breaker has limited inline script compilations. + type: number + contexts: + type: array + items: + $ref: '#/components/schemas/nodes._common:Context' + nodes._common:SerializedClusterState: + type: object + properties: + full_states: + $ref: '#/components/schemas/nodes._common:SerializedClusterStateDetail' + diffs: + $ref: '#/components/schemas/nodes._common:SerializedClusterStateDetail' + nodes._common:SerializedClusterStateDetail: + type: object + properties: + count: + type: number + uncompressed_size: + type: string + uncompressed_size_in_bytes: + type: number + compressed_size: + type: string + compressed_size_in_bytes: + type: number + nodes._common:Stats: + type: object + properties: + adaptive_selection: + description: Statistics about adaptive replica selection. + type: object + additionalProperties: + $ref: '#/components/schemas/nodes._common:AdaptiveSelection' + breakers: + description: Statistics about the field data circuit breaker. + type: object + additionalProperties: + $ref: '#/components/schemas/nodes._common:Breaker' + fs: + $ref: '#/components/schemas/nodes._common:FileSystem' + host: + $ref: '#/components/schemas/_common:Host' + http: + $ref: '#/components/schemas/nodes._common:Http' + ingest: + $ref: '#/components/schemas/nodes._common:Ingest' + ip: + description: IP address and port for the node. + oneOf: + - $ref: '#/components/schemas/_common:Ip' + - type: array + items: + $ref: '#/components/schemas/_common:Ip' + jvm: + $ref: '#/components/schemas/nodes._common:Jvm' + name: + $ref: '#/components/schemas/_common:Name' + os: + $ref: '#/components/schemas/nodes._common:OperatingSystem' + process: + $ref: '#/components/schemas/nodes._common:Process' + roles: + $ref: '#/components/schemas/_common:NodeRoles' + script: + $ref: '#/components/schemas/nodes._common:Scripting' + script_cache: + type: object + additionalProperties: + oneOf: + - $ref: '#/components/schemas/nodes._common:ScriptCache' + - type: array + items: + $ref: '#/components/schemas/nodes._common:ScriptCache' + thread_pool: + description: Statistics about each thread pool, including current size, queue and rejected tasks. + type: object + additionalProperties: + $ref: '#/components/schemas/nodes._common:ThreadCount' + timestamp: + type: number + transport: + $ref: '#/components/schemas/nodes._common:Transport' + transport_address: + $ref: '#/components/schemas/_common:TransportAddress' + attributes: + description: Contains a list of attributes for the node. + type: object + additionalProperties: + type: string + discovery: + $ref: '#/components/schemas/nodes._common:Discovery' + indexing_pressure: + $ref: '#/components/schemas/nodes._common:IndexingPressure' + indices: + $ref: '#/components/schemas/indices.stats:ShardStats' + nodes._common:ThreadCount: + type: object + properties: + active: + description: Number of active threads in the thread pool. + type: number + completed: + description: Number of tasks completed by the thread pool executor. + type: number + largest: + description: Highest number of active threads in the thread pool. + type: number + queue: + description: Number of tasks in queue for the thread pool. + type: number + rejected: + description: Number of tasks rejected by the thread pool executor. + type: number + threads: + description: Number of threads in the thread pool. + type: number + nodes._common:Transport: + type: object + properties: + inbound_handling_time_histogram: + description: The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram. + type: array + items: + $ref: '#/components/schemas/nodes._common:TransportHistogram' + outbound_handling_time_histogram: + description: The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram. + type: array + items: + $ref: '#/components/schemas/nodes._common:TransportHistogram' + rx_count: + description: Total number of RX (receive) packets received by the node during internal cluster communication. + type: number + rx_size: + description: Size of RX packets received by the node during internal cluster communication. + type: string + rx_size_in_bytes: + description: Size, in bytes, of RX packets received by the node during internal cluster communication. + type: number + server_open: + description: Current number of inbound TCP connections used for internal communication between nodes. + type: number + tx_count: + description: Total number of TX (transmit) packets sent by the node during internal cluster communication. + type: number + tx_size: + description: Size of TX packets sent by the node during internal cluster communication. + type: string + tx_size_in_bytes: + description: Size, in bytes, of TX packets sent by the node during internal cluster communication. + type: number + total_outbound_connections: + description: |- + The cumulative number of outbound transport connections that this node has opened since it started. + Each transport connection may comprise multiple TCP connections but is only counted once in this statistic. + Transport connections are typically long-lived so this statistic should remain constant in a stable cluster. + type: number + nodes._common:TransportHistogram: + type: object + properties: + count: + description: The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message. + type: number + lt_millis: + description: |- + The exclusive upper bound of the bucket in milliseconds. + May be omitted on the last bucket if this bucket has no upper bound. + type: number + ge_millis: + description: The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound. + type: number + nodes.info:DeprecationIndexing: + type: object + properties: + enabled: + oneOf: + - type: boolean + - type: string + required: + - enabled + nodes.info:NodeInfo: + type: object + properties: + attributes: + type: object + additionalProperties: + type: string + build_flavor: + type: string + build_hash: + description: Short hash of the last git commit in this release. + type: string + build_type: + type: string + host: + $ref: '#/components/schemas/_common:Host' + http: + $ref: '#/components/schemas/nodes.info:NodeInfoHttp' + ip: + $ref: '#/components/schemas/_common:Ip' + jvm: + $ref: '#/components/schemas/nodes.info:NodeJvmInfo' + name: + $ref: '#/components/schemas/_common:Name' + network: + $ref: '#/components/schemas/nodes.info:NodeInfoNetwork' + os: + $ref: '#/components/schemas/nodes.info:NodeOperatingSystemInfo' + plugins: + type: array + items: + $ref: '#/components/schemas/_common:PluginStats' + process: + $ref: '#/components/schemas/nodes.info:NodeProcessInfo' + roles: + $ref: '#/components/schemas/_common:NodeRoles' + settings: + $ref: '#/components/schemas/nodes.info:NodeInfoSettings' + thread_pool: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.info:NodeThreadPoolInfo' + total_indexing_buffer: + description: Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings. + type: number + total_indexing_buffer_in_bytes: + $ref: '#/components/schemas/_common:ByteSize' + transport: + $ref: '#/components/schemas/nodes.info:NodeInfoTransport' + transport_address: + $ref: '#/components/schemas/_common:TransportAddress' + version: + $ref: '#/components/schemas/_common:VersionString' + modules: + type: array + items: + $ref: '#/components/schemas/_common:PluginStats' + ingest: + $ref: '#/components/schemas/nodes.info:NodeInfoIngest' + aggregations: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.info:NodeInfoAggregation' + required: + - attributes + - build_flavor + - build_hash + - build_type + - host + - ip + - name + - roles + - transport_address + - version + nodes.info:NodeInfoAction: + type: object + properties: + destructive_requires_name: + type: string + required: + - destructive_requires_name + nodes.info:NodeInfoAggregation: + type: object + properties: + types: + type: array + items: + type: string + required: + - types + nodes.info:NodeInfoBootstrap: + type: object + properties: + memory_lock: + type: string + required: + - memory_lock + nodes.info:NodeInfoClient: + type: object + properties: + type: + type: string + required: + - type + nodes.info:NodeInfoDiscover: + type: object + properties: + seed_hosts: + type: string + required: + - seed_hosts + nodes.info:NodeInfoHttp: + type: object + properties: + bound_address: + type: array + items: + type: string + max_content_length: + $ref: '#/components/schemas/_common:ByteSize' + max_content_length_in_bytes: + type: number + publish_address: + type: string + required: + - bound_address + - max_content_length_in_bytes + - publish_address + nodes.info:NodeInfoIngest: + type: object + properties: + processors: + type: array + items: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestProcessor' + required: + - processors + nodes.info:NodeInfoIngestDownloader: + type: object + properties: + enabled: + type: string + required: + - enabled + nodes.info:NodeInfoIngestInfo: + type: object + properties: + downloader: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestDownloader' + required: + - downloader + nodes.info:NodeInfoIngestProcessor: + type: object + properties: + type: + type: string + required: + - type + nodes.info:NodeInfoJvmMemory: + type: object + properties: + direct_max: + $ref: '#/components/schemas/_common:ByteSize' + direct_max_in_bytes: + type: number + heap_init: + $ref: '#/components/schemas/_common:ByteSize' + heap_init_in_bytes: + type: number + heap_max: + $ref: '#/components/schemas/_common:ByteSize' + heap_max_in_bytes: + type: number + non_heap_init: + $ref: '#/components/schemas/_common:ByteSize' + non_heap_init_in_bytes: + type: number + non_heap_max: + $ref: '#/components/schemas/_common:ByteSize' + non_heap_max_in_bytes: + type: number + required: + - direct_max_in_bytes + - heap_init_in_bytes + - heap_max_in_bytes + - non_heap_init_in_bytes + - non_heap_max_in_bytes + nodes.info:NodeInfoMemory: + type: object + properties: + total: + type: string + total_in_bytes: + type: number + required: + - total + - total_in_bytes + nodes.info:NodeInfoNetwork: + type: object + properties: + primary_interface: + $ref: '#/components/schemas/nodes.info:NodeInfoNetworkInterface' + refresh_interval: + type: number + required: + - primary_interface + - refresh_interval + nodes.info:NodeInfoNetworkInterface: + type: object + properties: + address: + type: string + mac_address: + type: string + name: + $ref: '#/components/schemas/_common:Name' + required: + - address + - mac_address + - name + nodes.info:NodeInfoOSCPU: + type: object + properties: + cache_size: + type: string + cache_size_in_bytes: + type: number + cores_per_socket: + type: number + mhz: + type: number + model: + type: string + total_cores: + type: number + total_sockets: + type: number + vendor: + type: string + required: + - cache_size + - cache_size_in_bytes + - cores_per_socket + - mhz + - model + - total_cores + - total_sockets + - vendor + nodes.info:NodeInfoPath: + type: object + properties: + logs: + type: string + home: + type: string + repo: + type: array + items: + type: string + data: + type: array + items: + type: string + required: + - logs + - home + - repo + nodes.info:NodeInfoRepositories: + type: object + properties: + url: + $ref: '#/components/schemas/nodes.info:NodeInfoRepositoriesUrl' + required: + - url + nodes.info:NodeInfoRepositoriesUrl: + type: object + properties: + allowed_urls: + type: string + required: + - allowed_urls + nodes.info:NodeInfoScript: + type: object + properties: + allowed_types: + type: string + disable_max_compilations_rate: + type: string + required: + - allowed_types + - disable_max_compilations_rate + nodes.info:NodeInfoSearch: + type: object + properties: + remote: + $ref: '#/components/schemas/nodes.info:NodeInfoSearchRemote' + required: + - remote + nodes.info:NodeInfoSearchRemote: + type: object + properties: + connect: + type: string + required: + - connect + nodes.info:NodeInfoSettings: + type: object + properties: + cluster: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsCluster' + node: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsNode' + path: + $ref: '#/components/schemas/nodes.info:NodeInfoPath' + repositories: + $ref: '#/components/schemas/nodes.info:NodeInfoRepositories' + discovery: + $ref: '#/components/schemas/nodes.info:NodeInfoDiscover' + action: + $ref: '#/components/schemas/nodes.info:NodeInfoAction' + client: + $ref: '#/components/schemas/nodes.info:NodeInfoClient' + http: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsHttp' + bootstrap: + $ref: '#/components/schemas/nodes.info:NodeInfoBootstrap' + transport: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsTransport' + network: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsNetwork' + script: + $ref: '#/components/schemas/nodes.info:NodeInfoScript' + search: + $ref: '#/components/schemas/nodes.info:NodeInfoSearch' + ingest: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsIngest' + required: + - cluster + - node + - path + - client + - http + - transport + nodes.info:NodeInfoSettingsCluster: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + routing: + $ref: '#/components/schemas/indices._common:IndexRouting' + election: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsClusterElection' + initial_master_nodes: + type: string + deprecation_indexing: + $ref: '#/components/schemas/nodes.info:DeprecationIndexing' + required: + - name + - election + nodes.info:NodeInfoSettingsClusterElection: + type: object + properties: + strategy: + $ref: '#/components/schemas/_common:Name' + required: + - strategy + nodes.info:NodeInfoSettingsHttp: + type: object + properties: + type: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsHttpType' + type.default: + type: string + compression: + oneOf: + - type: boolean + - type: string + port: + oneOf: + - type: number + - type: string + required: + - type + nodes.info:NodeInfoSettingsHttpType: + type: object + properties: + default: + type: string + required: + - default + nodes.info:NodeInfoSettingsIngest: + type: object + properties: + attachment: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + append: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + csv: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + convert: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + date: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + date_index_name: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + dot_expander: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + enrich: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + fail: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + foreach: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + json: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + user_agent: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + kv: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + geoip: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + grok: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + gsub: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + join: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + lowercase: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + remove: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + rename: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + script: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + set: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + sort: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + split: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + trim: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + uppercase: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + urldecode: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + bytes: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + dissect: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + set_security_user: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + pipeline: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + drop: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + circle: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + inference: + $ref: '#/components/schemas/nodes.info:NodeInfoIngestInfo' + nodes.info:NodeInfoSettingsNetwork: + type: object + properties: + host: + $ref: '#/components/schemas/_common:Host' + required: + - host + nodes.info:NodeInfoSettingsNode: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + attr: + type: object + additionalProperties: + type: object + max_local_storage_nodes: + type: string + required: + - name + - attr + nodes.info:NodeInfoSettingsTransport: + type: object + properties: + type: + $ref: '#/components/schemas/nodes.info:NodeInfoSettingsTransportType' + type.default: + type: string + required: + - type + nodes.info:NodeInfoSettingsTransportType: + type: object + properties: + default: + type: string + required: + - default + nodes.info:NodeInfoTransport: + type: object + properties: + bound_address: + type: array + items: + type: string + publish_address: + type: string + profiles: + type: object + additionalProperties: + type: string + required: + - bound_address + - publish_address + - profiles + nodes.info:NodeJvmInfo: + type: object + properties: + gc_collectors: + type: array + items: + type: string + mem: + $ref: '#/components/schemas/nodes.info:NodeInfoJvmMemory' + memory_pools: + type: array + items: + type: string + pid: + type: number + start_time_in_millis: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + version: + $ref: '#/components/schemas/_common:VersionString' + vm_name: + $ref: '#/components/schemas/_common:Name' + vm_vendor: + type: string + vm_version: + $ref: '#/components/schemas/_common:VersionString' + using_bundled_jdk: + type: boolean + using_compressed_ordinary_object_pointers: + oneOf: + - type: boolean + - type: string + input_arguments: + type: array + items: + type: string + required: + - gc_collectors + - mem + - memory_pools + - pid + - start_time_in_millis + - version + - vm_name + - vm_vendor + - vm_version + - using_bundled_jdk + - input_arguments + nodes.info:NodeOperatingSystemInfo: + type: object + properties: + arch: + description: 'Name of the JVM architecture (ex: amd64, x86)' + type: string + available_processors: + description: Number of processors available to the Java virtual machine + type: number + allocated_processors: + description: The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS. + type: number + name: + $ref: '#/components/schemas/_common:Name' + pretty_name: + $ref: '#/components/schemas/_common:Name' + refresh_interval_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + version: + $ref: '#/components/schemas/_common:VersionString' + cpu: + $ref: '#/components/schemas/nodes.info:NodeInfoOSCPU' + mem: + $ref: '#/components/schemas/nodes.info:NodeInfoMemory' + swap: + $ref: '#/components/schemas/nodes.info:NodeInfoMemory' + required: + - arch + - available_processors + - name + - pretty_name + - refresh_interval_in_millis + - version + nodes.info:NodeProcessInfo: + type: object + properties: + id: + description: Process identifier (PID) + type: number + mlockall: + description: Indicates if the process address space has been successfully locked in memory + type: boolean + refresh_interval_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - id + - mlockall + - refresh_interval_in_millis + nodes.info:NodeThreadPoolInfo: + type: object + properties: + core: + type: number + keep_alive: + $ref: '#/components/schemas/_common:Duration' + max: + type: number + queue_size: + type: number + size: + type: number + type: + type: string + required: + - queue_size + - type + nodes.info:ResponseBase: + allOf: + - $ref: '#/components/schemas/nodes._common:NodesResponseBase' + - type: object + properties: + cluster_name: + $ref: '#/components/schemas/_common:Name' + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.info:NodeInfo' + required: + - cluster_name + - nodes + nodes.reload_secure_settings:ResponseBase: + allOf: + - $ref: '#/components/schemas/nodes._common:NodesResponseBase' + - type: object + properties: + cluster_name: + $ref: '#/components/schemas/_common:Name' + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes._common:NodeReloadResult' + required: + - cluster_name + - nodes + nodes.stats:ResponseBase: + allOf: + - $ref: '#/components/schemas/nodes._common:NodesResponseBase' + - type: object + properties: + cluster_name: + $ref: '#/components/schemas/_common:Name' + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes._common:Stats' + required: + - nodes + nodes.usage:NodeUsage: + type: object + properties: + rest_actions: + type: object + additionalProperties: + type: number + since: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + timestamp: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + aggregations: + type: object + additionalProperties: + type: object + required: + - rest_actions + - since + - timestamp + - aggregations + nodes.usage:ResponseBase: + allOf: + - $ref: '#/components/schemas/nodes._common:NodesResponseBase' + - type: object + properties: + cluster_name: + $ref: '#/components/schemas/_common:Name' + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/nodes.usage:NodeUsage' + required: + - cluster_name + - nodes + notifications._common:Chime: + type: object + properties: + url: + type: string + required: + - url + notifications._common:DeleteResponseList: + type: object + additionalProperties: + $ref: '#/components/schemas/notifications._common:RestStatus' + notifications._common:DeliveryStatus: + type: object + properties: + status_code: + type: string + status_text: + type: string + notifications._common:Email: + type: object + properties: + email_account_id: + type: string + recipient_list: + type: array + items: + $ref: '#/components/schemas/notifications._common:RecipientListItem' + required: + - email_account_id + notifications._common:EmailEncryptionMethod: + type: string + enum: + - ssl + - start_tls + - none + notifications._common:EmailGroup: + type: object + properties: + recipient_list: + type: array + items: + $ref: '#/components/schemas/notifications._common:RecipientListItem' + email_group_id_list: + type: array + items: + type: string + required: + - recipient_list + notifications._common:EmailRecipientStatus: + type: object + properties: + recipient: + type: string + delivery_status: + $ref: '#/components/schemas/notifications._common:DeliveryStatus' + notifications._common:EventSource: + type: object + properties: + title: + type: string + reference_id: + type: string + severity: + $ref: '#/components/schemas/notifications._common:SeverityType' + tags: + type: array + items: + type: string + notifications._common:EventStatus: + type: object + properties: + config_id: + type: string + config_name: + type: string + config_type: + $ref: '#/components/schemas/notifications._common:NotificationConfigType' + email_recipient_status: + type: array + items: + $ref: '#/components/schemas/notifications._common:EmailRecipientStatus' + delivery_status: + $ref: '#/components/schemas/notifications._common:DeliveryStatus' + notifications._common:HeaderParamsMap: + type: object + additionalProperties: + type: integer + format: int32 + notifications._common:HttpMethodType: + type: string + enum: + - POST + - PUT + - PATCH + notifications._common:MicrosoftTeamsItem: + type: object + properties: + url: + type: string + required: + - url + notifications._common:NotificationConfigType: + type: string + description: Type of notification configuration. + enum: + - slack + - chime + - microsoft_teams + - webhook + - email + - sns + - ses_account + - smtp_account + - email_group + notifications._common:NotificationsConfig: + type: object + properties: + config_id: + type: string + config: + $ref: '#/components/schemas/notifications._common:NotificationsConfigItem' + required: + - config + notifications._common:NotificationsConfigItem: + type: object + properties: + name: + type: string + description: + type: string + config_type: + $ref: '#/components/schemas/notifications._common:NotificationConfigType' + is_enabled: + type: boolean + sns: + $ref: '#/components/schemas/notifications._common:SnsItem' + slack: + $ref: '#/components/schemas/notifications._common:SlackItem' + chime: + $ref: '#/components/schemas/notifications._common:Chime' + webhook: + $ref: '#/components/schemas/notifications._common:Webhook' + smtp_account: + $ref: '#/components/schemas/notifications._common:SmtpAccount' + ses_account: + $ref: '#/components/schemas/notifications._common:SesAccount' + email_group: + $ref: '#/components/schemas/notifications._common:EmailGroup' + email: + $ref: '#/components/schemas/notifications._common:Email' + microsoft_teams: + $ref: '#/components/schemas/notifications._common:MicrosoftTeamsItem' + required: + - config_type + - name + notifications._common:NotificationsConfigsOutputItem: + type: object + properties: + config_id: + type: string + last_updated_time_ms: + type: integer + format: int64 + created_time_ms: + type: integer + format: int64 + config: + $ref: '#/components/schemas/notifications._common:NotificationsConfigItem' + notifications._common:NotificationsConfigs_GetRequestContent: + type: object + properties: + config_id_list: + type: array + items: + type: string + sort_field: + type: string + sort_order: + type: string + from_index: + type: integer + format: int32 + max_items: + type: integer + format: int32 + notifications._common:NotificationsPluginFeaturesMap: + type: object + additionalProperties: + type: string + notifications._common:RecipientListItem: + type: object + properties: + recipient: + type: string + notifications._common:RestStatus: + type: string + enum: + - continue + - switching_protocols + - ok + - created + - accepted + - non_authoritative_information + - no_content + - reset_content + - partial_content + - multi_status + - multiple_choices + - moved_permanently + - found + - see_other + - not_modified + - use_proxy + - temporary_redirect + notifications._common:SesAccount: + type: object + properties: + region: + type: string + role_arn: + type: string + from_addess: + type: string + required: + - from_addess + - region + notifications._common:SeverityType: + type: string + enum: + - high + - info + - critical + notifications._common:SlackItem: + type: object + properties: + url: + type: string + required: + - url + notifications._common:SmtpAccount: + type: object + properties: + host: + type: string + port: + type: integer + format: int32 + method: + $ref: '#/components/schemas/notifications._common:EmailEncryptionMethod' + from_addess: + type: string + required: + - from_addess + - host + - method + - port + notifications._common:SnsItem: + type: object + properties: + topic_arn: + type: string + role_arn: + type: string + required: + - topic_arn + notifications._common:TotalHitRelation: + type: string + enum: + - eq + - gte + notifications._common:Webhook: + type: object + properties: + url: + type: string + method: + $ref: '#/components/schemas/notifications._common:HttpMethodType' + header_params: + $ref: '#/components/schemas/notifications._common:HeaderParamsMap' + required: + - url + remote_store._common:RemoteStoreRestoreInfo: + type: object + properties: + snapshot: + type: string + indices: + type: array + items: + type: string + shards: + $ref: '#/components/schemas/remote_store._common:RemoteStoreRestoreShardsInfo' + remote_store._common:RemoteStoreRestoreShardsInfo: + type: object + properties: + total: + type: integer + format: int32 + failed: + type: integer + format: int32 + successful: + type: integer + format: int32 + search_pipeline._common:FilterQueryRequestProcessor: + type: object + properties: + tag: + type: string + description: + type: string + ignore_failure: + type: boolean + query: + $ref: '#/components/schemas/search_pipeline._common:UserDefinedObjectStructure' + search_pipeline._common:NeuralFieldMap: + type: object + additionalProperties: + type: string + search_pipeline._common:NeuralQueryEnricherRequestProcessor: + type: object + properties: + tag: + type: string + description: + type: string + default_model_id: + type: string + neural_field_default_id: + $ref: '#/components/schemas/search_pipeline._common:NeuralFieldMap' + search_pipeline._common:NormalizationPhaseResultsProcessor: + type: object + properties: + tag: + type: string + description: + type: string + ignore_failure: + type: boolean + normalization: + $ref: '#/components/schemas/search_pipeline._common:ScoreNormalization' + combination: + $ref: '#/components/schemas/search_pipeline._common:ScoreCombination' + search_pipeline._common:OversampleRequestProcessor: + type: object + properties: + tag: + type: string + description: + type: string + ignore_failure: + type: boolean + sample_factor: + type: number + format: float + content_prefix: + type: string + required: + - sample_factor + search_pipeline._common:PhaseResultsProcessor: + oneOf: + - type: object + title: normalization-processor + properties: + normalization-processor: + $ref: '#/components/schemas/search_pipeline._common:NormalizationPhaseResultsProcessor' + required: + - normalization-processor + search_pipeline._common:RequestProcessor: + oneOf: + - type: object + title: filter_query + properties: + filter_query: + $ref: '#/components/schemas/search_pipeline._common:FilterQueryRequestProcessor' + required: + - filter_query + - type: object + title: neural_query_enricher + properties: + neural_query_enricher: + $ref: '#/components/schemas/search_pipeline._common:NeuralQueryEnricherRequestProcessor' + required: + - neural_query_enricher + - type: object + title: script + properties: + script: + $ref: '#/components/schemas/search_pipeline._common:SearchScriptRequestProcessor' + required: + - script + - type: object + title: oversample + properties: + oversample: + $ref: '#/components/schemas/search_pipeline._common:OversampleRequestProcessor' + required: + - oversample + search_pipeline._common:ScoreCombination: + type: object + properties: + technique: + $ref: '#/components/schemas/search_pipeline._common:ScoreCombinationTechnique' + parameters: + type: array + items: + type: number + format: float + search_pipeline._common:ScoreCombinationTechnique: + type: string + enum: + - arithmetic_mean + - geometric_mean + - harmonic_mean + search_pipeline._common:ScoreNormalization: + type: object + properties: + technique: + $ref: '#/components/schemas/search_pipeline._common:ScoreNormalizationTechnique' + search_pipeline._common:ScoreNormalizationTechnique: + type: string + enum: + - min_max + - l2 + search_pipeline._common:SearchPipelineMap: + type: object + additionalProperties: + $ref: '#/components/schemas/search_pipeline._common:SearchPipelineStructure' + search_pipeline._common:SearchPipelineStructure: + type: object + properties: + version: + type: integer + format: int32 + request_processors: + type: array + items: + $ref: '#/components/schemas/search_pipeline._common:RequestProcessor' + response_processors: + type: array + items: + $ref: '#/components/schemas/search_pipeline._common:RequestProcessor' + phase_results_processors: + type: array + items: + $ref: '#/components/schemas/search_pipeline._common:PhaseResultsProcessor' + search_pipeline._common:SearchScriptRequestProcessor: + type: object + properties: + tag: + type: string + description: + type: string + ignore_failure: + type: boolean + source: + type: string + lang: + type: string + required: + - source + search_pipeline._common:UserDefinedObjectStructure: + type: object + properties: + bool: {} + boosting: {} + combined_fields: {} + constant_score: {} + dis_max: {} + distance_feature: {} + exists: {} + function_score: {} + fuzzy: + $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + geo_bounding_box: {} + geo_distance: {} + geo_polygon: {} + geo_shape: {} + has_child: {} + has_parent: {} + ids: {} + intervals: + $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + knn: {} + match: + $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + match_all: {} + match_bool_prefix: + $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + match_none: {} + match_phrase: + $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + match_phrase_prefix: + $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + more_like_this: {} + multi_match: {} + nested: {} + parent_id: {} + percolate: {} + pinned: {} + prefix: + $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + query_string: {} + range: + $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + rank_feature: {} + regexp: + $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + script: {} + script_score: {} + shape: {} + simple_query_string: {} + span_containing: {} + field_masking_span: {} + span_first: {} + span_multi: {} + span_near: {} + span_not: {} + span_or: {} + span_term: + $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + span_within: {} + term: + $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + terms: {} + terms_set: + $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + wildcard: + $ref: '#/components/schemas/search_pipeline._common:UserDefinedValueMap' + wrapper: {} + search_pipeline._common:UserDefinedValueMap: + type: object + additionalProperties: {} + security._common:AccountDetails: + type: object + properties: + user_name: + type: string + is_reserved: + type: boolean + is_hidden: + type: boolean + is_internal_user: + type: boolean + user_requested_tenant: + type: string + backend_roles: + type: array + items: + type: string + custom_attribute_names: + type: array + items: + type: string + tenants: + $ref: '#/components/schemas/security._common:UserTenants' + roles: + type: array + items: + type: string + security._common:ActionGroupsMap: + type: object + additionalProperties: + $ref: '#/components/schemas/security._common:Action_Group' + security._common:Action_Group: + type: object + properties: + reserved: + type: boolean + hidden: + type: boolean + allowed_actions: + type: array + items: + type: string + type: + type: string + description: + type: string + static: + type: boolean + security._common:AuditConfig: + type: object + properties: + compliance: + $ref: '#/components/schemas/security._common:ComplianceConfig' + enabled: + type: boolean + audit: + $ref: '#/components/schemas/security._common:AuditLogsConfig' + security._common:AuditConfigWithReadOnly: + type: object + properties: + _readonly: + type: array + items: + type: string + config: + $ref: '#/components/schemas/security._common:AuditConfig' + security._common:AuditLogsConfig: + type: object + properties: + ignore_users: + type: array + items: + type: string + ignore_requests: + type: array + items: + type: string + disabled_rest_categories: + type: array + items: + type: string + disabled_transport_categories: + type: array + items: + type: string + log_request_body: + type: boolean + resolve_indices: + type: boolean + resolve_bulk_requests: + type: boolean + exclude_sensitive_headers: + type: boolean + enable_transport: + type: boolean + enable_rest: + type: boolean + security._common:CertificatesDetail: + type: object + properties: + issuer_dn: + type: string + subject_dn: + type: string + san: + type: string + not_before: + type: string + not_after: + type: string + security._common:ChangePasswordRequestContent: + type: object + properties: + current_password: + type: string + description: The current password + password: + type: string + description: The new password to set + required: + - current_password + - password + security._common:ComplianceConfig: + type: object + properties: + enabled: + type: boolean + write_log_diffs: + type: boolean + read_watched_fields: {} + read_ignore_users: + type: array + items: + type: string + write_watched_indices: + type: array + items: + type: string + write_ignore_users: + type: array + items: + type: string + read_metadata_only: + type: boolean + write_metadata_only: + type: boolean + external_config: + type: boolean + internal_config: + type: boolean + security._common:CreateTenantParams: + type: object + properties: + description: + type: string + security._common:DistinguishedNames: + type: object + properties: + nodes_dn: + type: array + items: + type: string + security._common:DistinguishedNamesMap: + type: object + additionalProperties: + $ref: '#/components/schemas/security._common:DistinguishedNames' + security._common:DynamicConfig: + type: object + properties: + dynamic: + $ref: '#/components/schemas/security._common:DynamicOptions' + security._common:DynamicOptions: + type: object + properties: + filteredAliasMode: + type: string + disableRestAuth: + type: boolean + disableIntertransportAuth: + type: boolean + respectRequestIndicesOptions: + type: boolean + kibana: {} + http: {} + authc: {} + authz: {} + authFailureListeners: {} + doNotFailOnForbidden: + type: boolean + multiRolespanEnabled: + type: boolean + hostsResolverMode: + type: string + doNotFailOnForbiddenEmpty: + type: boolean + security._common:IndexPermission: + type: object + properties: + index_patterns: + type: array + items: + type: string + dls: + type: string + fls: + type: array + items: + type: string + masked_fields: + type: array + items: + type: string + allowed_actions: + type: array + items: + type: string + security._common:PatchOperation: + type: object + properties: + op: + type: string + description: 'The operation to perform. Possible values: remove,add, replace, move, copy, test.' + path: + type: string + description: The path to the resource. + value: + description: The new values used for the update. + required: + - op + - path + security._common:Role: + type: object + properties: + reserved: + type: boolean + hidden: + type: boolean + description: + type: string + cluster_permissions: + type: array + items: + type: string + index_permissions: + type: array + items: + $ref: '#/components/schemas/security._common:IndexPermission' + tenant_permissions: + type: array + items: + $ref: '#/components/schemas/security._common:TenantPermission' + static: + type: boolean + security._common:RoleMapping: + type: object + properties: + hosts: + type: array + items: + type: string + users: + type: array + items: + type: string + reserved: + type: boolean + hidden: + type: boolean + backend_roles: + type: array + items: + type: string + and_backend_roles: + type: array + items: + type: string + description: + type: string + security._common:RoleMappings: + type: object + additionalProperties: + $ref: '#/components/schemas/security._common:RoleMapping' + security._common:RolesMap: + type: object + additionalProperties: + $ref: '#/components/schemas/security._common:Role' + security._common:Tenant: + type: object + properties: + reserved: + type: boolean + hidden: + type: boolean + description: + type: string + static: + type: boolean + security._common:TenantPermission: + type: object + properties: + tenant_patterns: + type: array + items: + type: string + allowed_actions: + type: array + items: + type: string + security._common:TenantsMap: + type: object + additionalProperties: + $ref: '#/components/schemas/security._common:Tenant' + security._common:User: + type: object + properties: + hash: + type: string + reserved: + type: boolean + hidden: + type: boolean + backend_roles: + type: array + items: + type: string + attributes: + $ref: '#/components/schemas/security._common:UserAttributes' + description: + type: string + opendistro_security_roles: + type: array + items: + type: string + static: + type: boolean + security._common:UserAttributes: + type: object + additionalProperties: + type: string + security._common:UserTenants: + type: object + properties: + global_tenant: + type: boolean + admin_tenant: + type: boolean + admin: + type: boolean + security._common:UsersMap: + type: object + additionalProperties: + $ref: '#/components/schemas/security._common:User' + snapshot._common:FileCountSnapshotStats: + type: object + properties: + file_count: + type: number + size_in_bytes: + type: number + required: + - file_count + - size_in_bytes + snapshot._common:IndexDetails: + type: object + properties: + shard_count: + type: number + size: + $ref: '#/components/schemas/_common:ByteSize' + size_in_bytes: + type: number + max_segments_per_shard: + type: number + required: + - shard_count + - size_in_bytes + - max_segments_per_shard + snapshot._common:InfoFeatureState: + type: object + properties: + feature_name: + type: string + indices: + $ref: '#/components/schemas/_common:Indices' + required: + - feature_name + - indices + snapshot._common:Repository: + type: object + properties: + type: + type: string + uuid: + $ref: '#/components/schemas/_common:Uuid' + settings: + $ref: '#/components/schemas/snapshot._common:RepositorySettings' + required: + - type + - settings + snapshot._common:RepositorySettings: + type: object + properties: + chunk_size: + type: string + compress: + oneOf: + - type: string + - type: boolean + concurrent_streams: + oneOf: + - type: string + - type: number + location: + type: string + read_only: + oneOf: + - type: string + - type: boolean + required: + - location + snapshot._common:ShardsStats: + type: object + properties: + done: + type: number + failed: + type: number + finalizing: + type: number + initializing: + type: number + started: + type: number + total: + type: number + required: + - done + - failed + - finalizing + - initializing + - started + - total + snapshot._common:ShardsStatsStage: + type: string + enum: + - DONE + - FAILURE + - FINALIZE + - INIT + - STARTED + snapshot._common:ShardsStatsSummary: + type: object + properties: + incremental: + $ref: '#/components/schemas/snapshot._common:ShardsStatsSummaryItem' + total: + $ref: '#/components/schemas/snapshot._common:ShardsStatsSummaryItem' + start_time_in_millis: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + time: + $ref: '#/components/schemas/_common:Duration' + time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + required: + - incremental + - total + - start_time_in_millis + - time_in_millis + snapshot._common:ShardsStatsSummaryItem: + type: object + properties: + file_count: + type: number + size_in_bytes: + type: number + required: + - file_count + - size_in_bytes + snapshot._common:SnapshotIndexStats: + type: object + properties: + shards: + type: object + additionalProperties: + $ref: '#/components/schemas/snapshot._common:SnapshotShardsStatus' + shards_stats: + $ref: '#/components/schemas/snapshot._common:ShardsStats' + stats: + $ref: '#/components/schemas/snapshot._common:SnapshotStats' + required: + - shards + - shards_stats + - stats + snapshot._common:SnapshotInfo: + type: object + properties: + data_streams: + type: array + items: + type: string + duration: + $ref: '#/components/schemas/_common:Duration' + duration_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + end_time: + $ref: '#/components/schemas/_common:DateTime' + end_time_in_millis: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + failures: + type: array + items: + $ref: '#/components/schemas/snapshot._common:SnapshotShardFailure' + include_global_state: + type: boolean + indices: + type: array + items: + $ref: '#/components/schemas/_common:IndexName' + index_details: + type: object + additionalProperties: + $ref: '#/components/schemas/snapshot._common:IndexDetails' + metadata: + $ref: '#/components/schemas/_common:Metadata' + reason: + type: string + repository: + $ref: '#/components/schemas/_common:Name' + snapshot: + $ref: '#/components/schemas/_common:Name' + shards: + $ref: '#/components/schemas/_common:ShardStatistics' + start_time: + $ref: '#/components/schemas/_common:DateTime' + start_time_in_millis: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + state: + type: string + uuid: + $ref: '#/components/schemas/_common:Uuid' + version: + $ref: '#/components/schemas/_common:VersionString' + version_id: + $ref: '#/components/schemas/_common:VersionNumber' + feature_states: + type: array + items: + $ref: '#/components/schemas/snapshot._common:InfoFeatureState' + required: + - data_streams + - snapshot + - uuid + snapshot._common:SnapshotShardFailure: + type: object + properties: + index: + $ref: '#/components/schemas/_common:IndexName' + node_id: + $ref: '#/components/schemas/_common:Id' + reason: + type: string + shard_id: + $ref: '#/components/schemas/_common:Id' + status: + type: string + required: + - index + - reason + - shard_id + - status + snapshot._common:SnapshotShardsStatus: + type: object + properties: + stage: + $ref: '#/components/schemas/snapshot._common:ShardsStatsStage' + stats: + $ref: '#/components/schemas/snapshot._common:ShardsStatsSummary' + required: + - stage + - stats + snapshot._common:SnapshotStats: + type: object + properties: + incremental: + $ref: '#/components/schemas/snapshot._common:FileCountSnapshotStats' + start_time_in_millis: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + time: + $ref: '#/components/schemas/_common:Duration' + time_in_millis: + $ref: '#/components/schemas/_common:DurationValueUnitMillis' + total: + $ref: '#/components/schemas/snapshot._common:FileCountSnapshotStats' + required: + - incremental + - start_time_in_millis + - time_in_millis + - total + snapshot._common:Status: + type: object + properties: + include_global_state: + type: boolean + indices: + type: object + additionalProperties: + $ref: '#/components/schemas/snapshot._common:SnapshotIndexStats' + repository: + type: string + shards_stats: + $ref: '#/components/schemas/snapshot._common:ShardsStats' + snapshot: + type: string + state: + type: string + stats: + $ref: '#/components/schemas/snapshot._common:SnapshotStats' + uuid: + $ref: '#/components/schemas/_common:Uuid' + required: + - include_global_state + - indices + - repository + - shards_stats + - snapshot + - state + - stats + - uuid + snapshot.cleanup_repository:CleanupRepositoryResults: + type: object + properties: + deleted_blobs: + description: Number of binary large objects (blobs) removed during cleanup. + type: number + deleted_bytes: + description: Number of bytes freed by cleanup operations. + type: number + required: + - deleted_blobs + - deleted_bytes + snapshot.get:SnapshotResponseItem: + type: object + properties: + repository: + $ref: '#/components/schemas/_common:Name' + snapshots: + type: array + items: + $ref: '#/components/schemas/snapshot._common:SnapshotInfo' + error: + $ref: '#/components/schemas/_common:ErrorCause' + required: + - repository + snapshot.restore:SnapshotRestore: + type: object + properties: + indices: + type: array + items: + $ref: '#/components/schemas/_common:IndexName' + snapshot: + type: string + shards: + $ref: '#/components/schemas/_common:ShardStatistics' + required: + - indices + - snapshot + - shards + snapshot.verify_repository:CompactNodeInfo: + type: object + properties: + name: + $ref: '#/components/schemas/_common:Name' + required: + - name + tasks._common:GroupBy: + type: string + enum: + - nodes + - parents + - none + tasks._common:NodeTasks: + type: object + properties: + name: + $ref: '#/components/schemas/_common:NodeId' + transport_address: + $ref: '#/components/schemas/_common:TransportAddress' + host: + $ref: '#/components/schemas/_common:Host' + ip: + $ref: '#/components/schemas/_common:Ip' + roles: + type: array + items: + type: string + attributes: + type: object + additionalProperties: + type: string + tasks: + type: object + additionalProperties: + $ref: '#/components/schemas/tasks._common:TaskInfo' + required: + - tasks + tasks._common:ParentTaskInfo: + allOf: + - $ref: '#/components/schemas/tasks._common:TaskInfo' + - type: object + properties: + children: + type: array + items: + $ref: '#/components/schemas/tasks._common:TaskInfo' + tasks._common:TaskInfo: + type: object + properties: + action: + type: string + cancelled: + type: boolean + cancellable: + type: boolean + description: + type: string + headers: + type: object + additionalProperties: + type: string + id: + type: number + node: + $ref: '#/components/schemas/_common:NodeId' + running_time: + $ref: '#/components/schemas/_common:Duration' + running_time_in_nanos: + $ref: '#/components/schemas/_common:DurationValueUnitNanos' + start_time_in_millis: + $ref: '#/components/schemas/_common:EpochTimeUnitMillis' + status: + description: Task status information can vary wildly from task to task. + type: object + type: + type: string + parent_task_id: + $ref: '#/components/schemas/_common:TaskId' + required: + - action + - cancellable + - headers + - id + - node + - running_time_in_nanos + - start_time_in_millis + - type + tasks._common:TaskInfos: + oneOf: + - type: array + items: + $ref: '#/components/schemas/tasks._common:TaskInfo' + - type: object + additionalProperties: + $ref: '#/components/schemas/tasks._common:ParentTaskInfo' + tasks._common:TaskListResponseBase: + type: object + properties: + node_failures: + type: array + items: + $ref: '#/components/schemas/_common:ErrorCause' + task_failures: + type: array + items: + $ref: '#/components/schemas/_common:TaskFailure' + nodes: + description: Task information grouped by node, if `group_by` was set to `node` (the default). + type: object + additionalProperties: + $ref: '#/components/schemas/tasks._common:NodeTasks' + tasks: + $ref: '#/components/schemas/tasks._common:TaskInfos' diff --git a/coverage/README.md b/coverage/README.md index f88aca97..29db4a77 100644 --- a/coverage/README.md +++ b/coverage/README.md @@ -1,6 +1,6 @@ ### API Coverage -Uses the [opensearch-api plugin](https://github.com/dblock/opensearch-api), and [openapi-diff](https://github.com/OpenAPITools/openapi-diff) to show the difference between OpenSearch APIs, and the [OpenAPI spec checked into this repo](../OpenSearch.openapi.json). +Uses the [opensearch-api plugin](https://github.com/dblock/opensearch-api), and [openapi-diff](https://github.com/OpenAPITools/openapi-diff) to show the difference between OpenSearch APIs, and the [OpenAPI spec checked into this repo](../builds/OpenSearch.latest.yaml). API coverage is run on all pull requests via the [coverage workflow](../.github/workflows/coverage.yml). diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar deleted file mode 100644 index d9b7505b..00000000 Binary files a/gradle/wrapper/gradle-wrapper.jar and /dev/null differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties deleted file mode 100644 index 06713005..00000000 --- a/gradle/wrapper/gradle-wrapper.properties +++ /dev/null @@ -1,5 +0,0 @@ -distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip -distributionBase=GRADLE_USER_HOME -distributionPath=wrapper/dists -zipStorePath=wrapper/dists -zipStoreBase=GRADLE_USER_HOME diff --git a/gradlew b/gradlew deleted file mode 100755 index cccdd3d5..00000000 --- a/gradlew +++ /dev/null @@ -1,172 +0,0 @@ -#!/usr/bin/env sh - -############################################################################## -## -## Gradle start up script for UN*X -## -############################################################################## - -# Attempt to set APP_HOME -# Resolve links: $0 may be a link -PRG="$0" -# Need this for relative symlinks. -while [ -h "$PRG" ] ; do - ls=`ls -ld "$PRG"` - link=`expr "$ls" : '.*-> \(.*\)$'` - if expr "$link" : '/.*' > /dev/null; then - PRG="$link" - else - PRG=`dirname "$PRG"`"/$link" - fi -done -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >/dev/null -APP_HOME="`pwd -P`" -cd "$SAVED" >/dev/null - -APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` - -# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS="" - -# Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD="maximum" - -warn () { - echo "$*" -} - -die () { - echo - echo "$*" - echo - exit 1 -} - -# OS specific support (must be 'true' or 'false'). -cygwin=false -msys=false -darwin=false -nonstop=false -case "`uname`" in - CYGWIN* ) - cygwin=true - ;; - Darwin* ) - darwin=true - ;; - MINGW* ) - msys=true - ;; - NONSTOP* ) - nonstop=true - ;; -esac - -CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar - -# Determine the Java command to use to start the JVM. -if [ -n "$JAVA_HOME" ] ; then - if [ -x "$JAVA_HOME/jre/sh/java" ] ; then - # IBM's JDK on AIX uses strange locations for the executables - JAVACMD="$JAVA_HOME/jre/sh/java" - else - JAVACMD="$JAVA_HOME/bin/java" - fi - if [ ! -x "$JAVACMD" ] ; then - die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME - -Please set the JAVA_HOME variable in your environment to match the -location of your Java installation." - fi -else - JAVACMD="java" - which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. - -Please set the JAVA_HOME variable in your environment to match the -location of your Java installation." -fi - -# Increase the maximum file descriptors if we can. -if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then - MAX_FD_LIMIT=`ulimit -H -n` - if [ $? -eq 0 ] ; then - if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then - MAX_FD="$MAX_FD_LIMIT" - fi - ulimit -n $MAX_FD - if [ $? -ne 0 ] ; then - warn "Could not set maximum file descriptor limit: $MAX_FD" - fi - else - warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" - fi -fi - -# For Darwin, add options to specify how the application appears in the dock -if $darwin; then - GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" -fi - -# For Cygwin, switch paths to Windows format before running java -if $cygwin ; then - APP_HOME=`cygpath --path --mixed "$APP_HOME"` - CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` - JAVACMD=`cygpath --unix "$JAVACMD"` - - # We build the pattern for arguments to be converted via cygpath - ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` - SEP="" - for dir in $ROOTDIRSRAW ; do - ROOTDIRS="$ROOTDIRS$SEP$dir" - SEP="|" - done - OURCYGPATTERN="(^($ROOTDIRS))" - # Add a user-defined pattern to the cygpath arguments - if [ "$GRADLE_CYGPATTERN" != "" ] ; then - OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" - fi - # Now convert the arguments - kludge to limit ourselves to /bin/sh - i=0 - for arg in "$@" ; do - CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` - CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option - - if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition - eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` - else - eval `echo args$i`="\"$arg\"" - fi - i=$((i+1)) - done - case $i in - (0) set -- ;; - (1) set -- "$args0" ;; - (2) set -- "$args0" "$args1" ;; - (3) set -- "$args0" "$args1" "$args2" ;; - (4) set -- "$args0" "$args1" "$args2" "$args3" ;; - (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; - esac -fi - -# Escape application args -save () { - for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done - echo " " -} -APP_ARGS=$(save "$@") - -# Collect all arguments for the java command, following the shell quoting and substitution rules -eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" - -# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong -if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then - cd "$(dirname "$0")" -fi - -exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat deleted file mode 100644 index e95643d6..00000000 --- a/gradlew.bat +++ /dev/null @@ -1,84 +0,0 @@ -@if "%DEBUG%" == "" @echo off -@rem ########################################################################## -@rem -@rem Gradle startup script for Windows -@rem -@rem ########################################################################## - -@rem Set local scope for the variables with windows NT shell -if "%OS%"=="Windows_NT" setlocal - -set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. -set APP_BASE_NAME=%~n0 -set APP_HOME=%DIRNAME% - -@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS= - -@rem Find java.exe -if defined JAVA_HOME goto findJavaFromJavaHome - -set JAVA_EXE=java.exe -%JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto init - -echo. -echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:findJavaFromJavaHome -set JAVA_HOME=%JAVA_HOME:"=% -set JAVA_EXE=%JAVA_HOME%/bin/java.exe - -if exist "%JAVA_EXE%" goto init - -echo. -echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:init -@rem Get command-line arguments, handling Windows variants - -if not "%OS%" == "Windows_NT" goto win9xME_args - -:win9xME_args -@rem Slurp the command line arguments. -set CMD_LINE_ARGS= -set _SKIP=2 - -:win9xME_args_slurp -if "x%~1" == "x" goto execute - -set CMD_LINE_ARGS=%* - -:execute -@rem Setup the command line - -set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar - -@rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% - -:end -@rem End local scope for the variables with windows NT shell -if "%ERRORLEVEL%"=="0" goto mainEnd - -:fail -rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of -rem the _cmd.exe /c_ return code! -if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 -exit /b 1 - -:mainEnd -if "%OS%"=="Windows_NT" endlocal - -:omega diff --git a/index.html b/index.html index 9888364a..7436fcb9 100644 --- a/index.html +++ b/index.html @@ -11,7 +11,7 @@ window.onload = function () { // Begin Swagger UI call region const ui = SwaggerUIBundle({ - url: "OpenSearch.openapi.json", //Location of Open API spec in the repo + url: "./builds/OpenSearch.latest.yaml", //Location of Open API spec in the repo dom_id: '#swagger-ui', deepLinking: true, presets: [ diff --git a/model/_global/bulk/operations.smithy b/model/_global/bulk/operations.smithy deleted file mode 100644 index 6cf285e8..00000000 --- a/model/_global/bulk/operations.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/bulk/" -) - -@xOperationGroup("bulk") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_bulk") -@documentation("Allows to perform multiple index/update/delete operations in a single request.") -operation Bulk_Post { - input: Bulk_Post_Input, - output: Bulk_Output -} - -@xOperationGroup("bulk") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_bulk") -@documentation("Allows to perform multiple index/update/delete operations in a single request.") -operation Bulk_Put { - input: Bulk_Put_Input, - output: Bulk_Output -} - -@xOperationGroup("bulk") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_bulk") -@documentation("Allows to perform multiple index/update/delete operations in a single request.") -operation Bulk_Post_WithIndex { - input: Bulk_Post_WithIndex_Input, - output: Bulk_Output -} - -@xOperationGroup("bulk") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/{index}/_bulk") -@documentation("Allows to perform multiple index/update/delete operations in a single request.") -operation Bulk_Put_WithIndex { - input: Bulk_Put_WithIndex_Input, - output: Bulk_Output -} diff --git a/model/_global/bulk/structures.smithy b/model/_global/bulk/structures.smithy deleted file mode 100644 index 3472a1f4..00000000 --- a/model/_global/bulk/structures.smithy +++ /dev/null @@ -1,93 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Bulk_QueryParams { - @httpQuery("wait_for_active_shards") - @documentation("Sets the number of shard copies that must be active before proceeding with the 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).") - @default("1") - wait_for_active_shards: WaitForActiveShards, - - @httpQuery("refresh") - @default("false") - refresh: RefreshEnum, - - @httpQuery("routing") - routing: Routing, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("type") - type: DocumentType, - - @httpQuery("_source") - @documentation("True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request.") - _source: Source, - - @httpQuery("_source_excludes") - @documentation("Default list of fields to exclude from the returned _source field, can be overridden on each sub-request.") - _source_excludes: SourceExcludes, - - @httpQuery("_source_includes") - @documentation("Default list of fields to extract and return from the _source field, can be overridden on each sub-request.") - _source_includes: SourceIncludes, - - @httpQuery("pipeline") - pipeline: Pipeline, - - @httpQuery("require_alias") - @documentation("Sets require_alias for all incoming documents.") - @default(false) - require_alias: RequireAlias, -} - -// TODO: Fill in Body Parameters -@xSerialize("bulk") -@documentation("The operation definition and data (action-data pairs), separated by newlines") -structure Bulk_BodyParams {} - -@input -structure Bulk_Post_Input with [Bulk_QueryParams] { - @required - @httpPayload - content: Bulk_BodyParams, -} - -@input -structure Bulk_Put_Input with [Bulk_QueryParams] { - @required - @httpPayload - content: Bulk_BodyParams, -} - -@input -structure Bulk_Post_WithIndex_Input with [Bulk_QueryParams] { - @required - @httpLabel - @documentation("Default index for items which don't provide one.") - index: PathIndex, - @required - @httpPayload - content: Bulk_BodyParams, -} - -@input -structure Bulk_Put_WithIndex_Input with [Bulk_QueryParams] { - @required - @httpLabel - @documentation("Default index for items which don't provide one.") - index: PathIndex, - @required - @httpPayload - content: Bulk_BodyParams, -} - -// TODO: Fill in Output Structure -structure Bulk_Output {} diff --git a/model/_global/clear_scroll/operations.smithy b/model/_global/clear_scroll/operations.smithy deleted file mode 100644 index 03f56b84..00000000 --- a/model/_global/clear_scroll/operations.smithy +++ /dev/null @@ -1,37 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/scroll/" -) - -@xOperationGroup("clear_scroll") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict", "HttpMethodSemantics.UnexpectedPayload"]) -@http(method: "DELETE", uri: "/_search/scroll") -@documentation("Explicitly clears the search context for a scroll.") -operation ClearScroll { - input: ClearScroll_Input, - output: ClearScroll_Output -} - -@deprecated -@xOperationGroup("clear_scroll") -@xVersionAdded("1.0") -@xDeprecationMessage("A scroll id can be quite large and should be specified as part of the body") -@xVersionDeprecated("1.0") -@idempotent -@suppress(["HttpUriConflict", "HttpMethodSemantics.UnexpectedPayload"]) -@http(method: "DELETE", uri: "/_search/scroll/{scroll_id}") -@documentation("Explicitly clears the search context for a scroll.") -operation ClearScroll_WithScrollId { - input: ClearScroll_WithScrollId_Input, - output: ClearScroll_Output -} diff --git a/model/_global/clear_scroll/structures.smithy b/model/_global/clear_scroll/structures.smithy deleted file mode 100644 index ba4c1b3d..00000000 --- a/model/_global/clear_scroll/structures.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClearScroll_QueryParams { -} - -// TODO: Fill in Body Parameters -@documentation("Comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter") -structure ClearScroll_BodyParams {} - -@input -structure ClearScroll_Input with [ClearScroll_QueryParams] { - @httpPayload - content: ClearScroll_BodyParams, -} - -@input -structure ClearScroll_WithScrollId_Input with [ClearScroll_QueryParams] { - @required - @httpLabel - scroll_id: PathScrollIds, - @httpPayload - content: ClearScroll_BodyParams, -} - -// TODO: Fill in Output Structure -structure ClearScroll_Output {} diff --git a/model/_global/count/operations.smithy b/model/_global/count/operations.smithy deleted file mode 100644 index 75e12f61..00000000 --- a/model/_global/count/operations.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/count/" -) - -@xOperationGroup("count") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_count") -@documentation("Returns number of documents matching a query.") -operation Count_Post { - input: Count_Post_Input, - output: Count_Output -} - -@xOperationGroup("count") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_count") -@documentation("Returns number of documents matching a query.") -operation Count_Get { - input: Count_Get_Input, - output: Count_Output -} - -@xOperationGroup("count") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_count") -@documentation("Returns number of documents matching a query.") -operation Count_Post_WithIndex { - input: Count_Post_WithIndex_Input, - output: Count_Output -} - -@xOperationGroup("count") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_count") -@documentation("Returns number of documents matching a query.") -operation Count_Get_WithIndex { - input: Count_Get_WithIndex_Input, - output: Count_Output -} diff --git a/model/_global/count/structures.smithy b/model/_global/count/structures.smithy deleted file mode 100644 index 7993daea..00000000 --- a/model/_global/count/structures.smithy +++ /dev/null @@ -1,92 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Count_QueryParams { - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("ignore_throttled") - ignore_throttled: IgnoreThrottled, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("min_score") - min_score: MinScore, - - @httpQuery("preference") - @default("random") - preference: Preference, - - @httpQuery("routing") - routing: Routings, - - @httpQuery("q") - q: Q, - - @httpQuery("analyzer") - analyzer: Analyzer, - - @httpQuery("analyze_wildcard") - @default(false) - analyze_wildcard: AnalyzeWildcard, - - @httpQuery("default_operator") - @default("OR") - default_operator: DefaultOperator, - - @httpQuery("df") - df: Df, - - @httpQuery("lenient") - lenient: Lenient, - - @httpQuery("terminate_after") - terminate_after: TerminateAfter, -} - -// TODO: Fill in Body Parameters -@documentation("Query to restrict the results specified with the Query DSL (optional)") -structure Count_BodyParams {} - -@input -structure Count_Post_Input with [Count_QueryParams] { - @httpPayload - content: Count_BodyParams, -} - -@input -structure Count_Get_Input with [Count_QueryParams] { -} - -@input -structure Count_Post_WithIndex_Input with [Count_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to restrict the results.") - index: PathIndices, - @httpPayload - content: Count_BodyParams, -} - -@input -structure Count_Get_WithIndex_Input with [Count_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to restrict the results.") - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure Count_Output {} diff --git a/model/_global/create/operations.smithy b/model/_global/create/operations.smithy deleted file mode 100644 index 8c2af77e..00000000 --- a/model/_global/create/operations.smithy +++ /dev/null @@ -1,37 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/index-document/" -) - -@xOperationGroup("create") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/{index}/_create/{id}") -@documentation("Creates a new document in the index. - -Returns a 409 response when a document with a same ID already exists in the index.") -operation Create_Put { - input: Create_Put_Input, - output: Create_Output -} - -@xOperationGroup("create") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_create/{id}") -@documentation("Creates a new document in the index. - -Returns a 409 response when a document with a same ID already exists in the index.") -operation Create_Post { - input: Create_Post_Input, - output: Create_Output -} diff --git a/model/_global/create/structures.smithy b/model/_global/create/structures.smithy deleted file mode 100644 index 28d4ae01..00000000 --- a/model/_global/create/structures.smithy +++ /dev/null @@ -1,70 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Create_QueryParams { - @httpQuery("wait_for_active_shards") - @documentation("Sets the number of shard copies that must be active before proceeding with the 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).") - @default("1") - wait_for_active_shards: WaitForActiveShards, - - @httpQuery("refresh") - @default("false") - refresh: RefreshEnum, - - @httpQuery("routing") - routing: Routing, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("version") - version: Version, - - @httpQuery("version_type") - version_type: VersionType, - - @httpQuery("pipeline") - pipeline: Pipeline, -} - -// TODO: Fill in Body Parameters -@documentation("The document") -structure Create_BodyParams {} - -@input -structure Create_Put_Input with [Create_QueryParams] { - @required - @httpLabel - id: PathDocumentId, - - @required - @httpLabel - index: PathIndex, - @required - @httpPayload - content: Create_BodyParams, -} - -@input -structure Create_Post_Input with [Create_QueryParams] { - @required - @httpLabel - id: PathDocumentId, - - @required - @httpLabel - index: PathIndex, - @required - @httpPayload - content: Create_BodyParams, -} - -// TODO: Fill in Output Structure -structure Create_Output {} diff --git a/model/_global/create_pit/operations.smithy b/model/_global/create_pit/operations.smithy deleted file mode 100644 index 047af251..00000000 --- a/model/_global/create_pit/operations.smithy +++ /dev/null @@ -1,22 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#create-a-pit" -) - -@xOperationGroup("create_pit") -@xVersionAdded("2.4") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_search/point_in_time") -@documentation("Creates point in time context.") -operation CreatePit { - input: CreatePit_Input, - output: CreatePit_Output -} diff --git a/model/_global/create_pit/structures.smithy b/model/_global/create_pit/structures.smithy deleted file mode 100644 index 5516a6fd..00000000 --- a/model/_global/create_pit/structures.smithy +++ /dev/null @@ -1,42 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CreatePit_QueryParams { - @httpQuery("allow_partial_pit_creation") - allow_partial_pit_creation: AllowPartialPitCreation, - - @httpQuery("keep_alive") - keep_alive: KeepAlive, - - @httpQuery("preference") - @default("random") - preference: Preference, - - @httpQuery("routing") - routing: Routings, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards -} - -@input -structure CreatePit_Input with [CreatePit_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -@output -structure CreatePit_Output { - pit_id: String, - _shards: ShardStatistics, - creation_time: Long -} diff --git a/model/_global/delete/operations.smithy b/model/_global/delete/operations.smithy deleted file mode 100644 index 3221bd88..00000000 --- a/model/_global/delete/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/delete-document/" -) - -@xOperationGroup("delete") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/{index}/_doc/{id}") -@documentation("Removes a document from the index.") -operation Delete { - input: Delete_Input, - output: Delete_Output -} diff --git a/model/_global/delete/structures.smithy b/model/_global/delete/structures.smithy deleted file mode 100644 index e2b48af4..00000000 --- a/model/_global/delete/structures.smithy +++ /dev/null @@ -1,53 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Delete_QueryParams { - @httpQuery("wait_for_active_shards") - @documentation("Sets the number of shard copies that must be active before proceeding with the 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).") - @default("1") - wait_for_active_shards: WaitForActiveShards, - - @httpQuery("refresh") - @default("false") - refresh: RefreshEnum, - - @httpQuery("routing") - routing: Routing, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("if_seq_no") - if_seq_no: IfSeqNo, - - @httpQuery("if_primary_term") - if_primary_term: IfPrimaryTerm, - - @httpQuery("version") - version: Version, - - @httpQuery("version_type") - version_type: VersionType, -} - - -@input -structure Delete_Input with [Delete_QueryParams] { - @required - @httpLabel - id: PathDocumentId, - - @required - @httpLabel - index: PathIndex, -} - -// TODO: Fill in Output Structure -structure Delete_Output {} diff --git a/model/_global/delete_all_pits/operations.smithy b/model/_global/delete_all_pits/operations.smithy deleted file mode 100644 index 38e1bb07..00000000 --- a/model/_global/delete_all_pits/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits" -) - -@xOperationGroup("delete_all_pits") -@xVersionAdded("2.4") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_search/point_in_time/_all") -@documentation("Deletes all active point in time searches.") -operation DeleteAllPits { - input: DeleteAllPits_Input, - output: DeleteAllPits_Output -} diff --git a/model/_global/delete_all_pits/structures.smithy b/model/_global/delete_all_pits/structures.smithy deleted file mode 100644 index 03997c42..00000000 --- a/model/_global/delete_all_pits/structures.smithy +++ /dev/null @@ -1,29 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure DeleteAllPits_QueryParams {} - -@input -structure DeleteAllPits_Input with [DeleteAllPits_QueryParams] { -} - -@output -structure DeleteAllPits_Output { - pits: PitsDeleteAll -} - -list PitsDeleteAll{ - member: PitsDetailsDeleteAll -} - -structure PitsDetailsDeleteAll{ - successful: Boolean, - pit_id: String -} diff --git a/model/_global/delete_by_query/operations.smithy b/model/_global/delete_by_query/operations.smithy deleted file mode 100644 index c86e0e7b..00000000 --- a/model/_global/delete_by_query/operations.smithy +++ /dev/null @@ -1,22 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/" -) - -@xOperationGroup("delete_by_query") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_delete_by_query") -@documentation("Deletes documents matching the provided query.") -operation DeleteByQuery { - input: DeleteByQuery_Input, - output: DeleteByQuery_Output -} diff --git a/model/_global/delete_by_query/structures.smithy b/model/_global/delete_by_query/structures.smithy deleted file mode 100644 index 8c95888e..00000000 --- a/model/_global/delete_by_query/structures.smithy +++ /dev/null @@ -1,142 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure DeleteByQuery_QueryParams { - @httpQuery("analyzer") - analyzer: Analyzer, - - @httpQuery("analyze_wildcard") - @default(false) - analyze_wildcard: AnalyzeWildcard, - - @httpQuery("default_operator") - @default("OR") - default_operator: DefaultOperator, - - @httpQuery("df") - df: Df, - - @httpQuery("from") - @default(0) - from: From, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("conflicts") - @default("abort") - conflicts: Conflicts, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("lenient") - lenient: Lenient, - - @httpQuery("preference") - @default("random") - preference: Preference, - - @httpQuery("q") - q: Q, - - @httpQuery("routing") - routing: Routings, - - @httpQuery("scroll") - scroll: Scroll, - - @httpQuery("search_type") - search_type: SearchType, - - @httpQuery("search_timeout") - search_timeout: SearchTimeout, - - @httpQuery("size") - @documentation("Deprecated, please use `max_docs` instead.") - size: Size, - - @httpQuery("max_docs") - max_docs: MaxDocs, - - @httpQuery("sort") - sort: Sort, - - @httpQuery("_source") - _source: Source, - - @httpQuery("_source_excludes") - _source_excludes: SourceExcludes, - - @httpQuery("_source_includes") - _source_includes: SourceIncludes, - - @httpQuery("terminate_after") - terminate_after: TerminateAfter, - - @httpQuery("stats") - stats: Stats, - - @httpQuery("version") - version: WithVersion, - - @httpQuery("request_cache") - request_cache: RequestCache, - - @httpQuery("refresh") - @documentation("Refresh the shard containing the document before performing the operation.") - refresh: RefreshBoolean, - - @httpQuery("timeout") - @default("1m") - timeout: BulkTimeout, - - @httpQuery("wait_for_active_shards") - @documentation("Sets the number of shard copies that must be active before proceeding with the 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).") - @default("1") - wait_for_active_shards: WaitForActiveShards, - - @httpQuery("scroll_size") - @default(100) - scroll_size: ScrollSize, - - @httpQuery("wait_for_completion") - @default(true) - wait_for_completion: WaitForCompletionTrue, - - @httpQuery("requests_per_second") - @default(0) - requests_per_second: RequestsPerSecond, - - @httpQuery("slices") - @default("1") - slices: Slices, -} - -// TODO: Fill in Body Parameters -@documentation("The search definition using the Query DSL") -structure DeleteByQuery_BodyParams {} - -@input -structure DeleteByQuery_Input with [DeleteByQuery_QueryParams] { - @required - @httpLabel - index: PathIndices, - @required - @httpPayload - content: DeleteByQuery_BodyParams, -} - -// TODO: Fill in Output Structure -structure DeleteByQuery_Output {} diff --git a/model/_global/delete_by_query_rethrottle/operations.smithy b/model/_global/delete_by_query_rethrottle/operations.smithy deleted file mode 100644 index 3e37d633..00000000 --- a/model/_global/delete_by_query_rethrottle/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("delete_by_query_rethrottle") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_delete_by_query/{task_id}/_rethrottle") -@documentation("Changes the number of requests per second for a particular Delete By Query operation.") -operation DeleteByQueryRethrottle { - input: DeleteByQueryRethrottle_Input, - output: DeleteByQueryRethrottle_Output -} diff --git a/model/_global/delete_by_query_rethrottle/structures.smithy b/model/_global/delete_by_query_rethrottle/structures.smithy deleted file mode 100644 index 22fb100c..00000000 --- a/model/_global/delete_by_query_rethrottle/structures.smithy +++ /dev/null @@ -1,27 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure DeleteByQueryRethrottle_QueryParams { - @httpQuery("requests_per_second") - @required - requests_per_second: RequestsPerSecond, -} - - -@input -structure DeleteByQueryRethrottle_Input with [DeleteByQueryRethrottle_QueryParams] { - @required - @httpLabel - @documentation("The task id to rethrottle.") - task_id: PathTaskId, -} - -// TODO: Fill in Output Structure -structure DeleteByQueryRethrottle_Output {} diff --git a/model/_global/delete_pit/operations.smithy b/model/_global/delete_pit/operations.smithy deleted file mode 100644 index fcb0394c..00000000 --- a/model/_global/delete_pit/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits" -) - -@xOperationGroup("delete_pit") -@xVersionAdded("2.4") -@idempotent -@suppress(["HttpUriConflict", "HttpMethodSemantics.UnexpectedPayload"]) -@http(method: "DELETE", uri: "/_search/point_in_time") -@documentation("Deletes one or more point in time searches based on the IDs passed.") -operation DeletePit { - input: DeletePit_Input, - output: DeletePit_Output -} diff --git a/model/_global/delete_pit/structures.smithy b/model/_global/delete_pit/structures.smithy deleted file mode 100644 index c25b2cfa..00000000 --- a/model/_global/delete_pit/structures.smithy +++ /dev/null @@ -1,39 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -list DeletedPitList { - member: DeletedPit -} - -structure DeletedPit { - successful: Boolean, - pit_id: String -} - -list PitIds{ - member: String -} - - -@documentation("The point-in-time ids to be deleted") -structure DeletePit_BodyParams { - @required - pit_id: PitIds -} - -@input -structure DeletePit_Input { - @httpPayload - content: DeletePit_BodyParams -} - -@output -structure DeletePit_Output { - pits: DeletedPitList -} diff --git a/model/_global/delete_script/operations.smithy b/model/_global/delete_script/operations.smithy deleted file mode 100644 index 9ad15ded..00000000 --- a/model/_global/delete_script/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/script-apis/delete-script/" -) - -@xOperationGroup("delete_script") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_scripts/{id}") -@documentation("Deletes a script.") -operation DeleteScript { - input: DeleteScript_Input, - output: DeleteScript_Output -} diff --git a/model/_global/delete_script/structures.smithy b/model/_global/delete_script/structures.smithy deleted file mode 100644 index 69776e8d..00000000 --- a/model/_global/delete_script/structures.smithy +++ /dev/null @@ -1,31 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure DeleteScript_QueryParams { - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - - -@input -structure DeleteScript_Input with [DeleteScript_QueryParams] { - @required - @httpLabel - id: PathScriptId, -} - -// TODO: Fill in Output Structure -structure DeleteScript_Output {} diff --git a/model/_global/exists/operations.smithy b/model/_global/exists/operations.smithy deleted file mode 100644 index 810e9776..00000000 --- a/model/_global/exists/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/" -) - -@xOperationGroup("exists") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@readonly -@http(method: "HEAD", uri: "/{index}/_doc/{id}") -@documentation("Returns information about whether a document exists in an index.") -operation Exists { - input: Exists_Input, - output: Exists_Output -} diff --git a/model/_global/exists/structures.smithy b/model/_global/exists/structures.smithy deleted file mode 100644 index afe23e52..00000000 --- a/model/_global/exists/structures.smithy +++ /dev/null @@ -1,58 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Exists_QueryParams { - @httpQuery("stored_fields") - stored_fields: StoredFields, - - @httpQuery("preference") - @default("random") - preference: Preference, - - @httpQuery("realtime") - realtime: Realtime, - - @httpQuery("refresh") - @documentation("Refresh the shard containing the document before performing the operation.") - refresh: RefreshBoolean, - - @httpQuery("routing") - routing: Routing, - - @httpQuery("_source") - _source: Source, - - @httpQuery("_source_excludes") - _source_excludes: SourceExcludes, - - @httpQuery("_source_includes") - _source_includes: SourceIncludes, - - @httpQuery("version") - version: Version, - - @httpQuery("version_type") - version_type: VersionType, -} - - -@input -structure Exists_Input with [Exists_QueryParams] { - @required - @httpLabel - id: PathDocumentId, - - @required - @httpLabel - index: PathIndex, -} - -// TODO: Fill in Output Structure -structure Exists_Output {} diff --git a/model/_global/exists_source/operations.smithy b/model/_global/exists_source/operations.smithy deleted file mode 100644 index 0bccf4cd..00000000 --- a/model/_global/exists_source/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/" -) - -@xOperationGroup("exists_source") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@readonly -@http(method: "HEAD", uri: "/{index}/_source/{id}") -@documentation("Returns information about whether a document source exists in an index.") -operation ExistsSource { - input: ExistsSource_Input, - output: ExistsSource_Output -} diff --git a/model/_global/exists_source/structures.smithy b/model/_global/exists_source/structures.smithy deleted file mode 100644 index b62d0f01..00000000 --- a/model/_global/exists_source/structures.smithy +++ /dev/null @@ -1,55 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ExistsSource_QueryParams { - @httpQuery("preference") - @default("random") - preference: Preference, - - @httpQuery("realtime") - realtime: Realtime, - - @httpQuery("refresh") - @documentation("Refresh the shard containing the document before performing the operation.") - refresh: RefreshBoolean, - - @httpQuery("routing") - routing: Routing, - - @httpQuery("_source") - _source: Source, - - @httpQuery("_source_excludes") - _source_excludes: SourceExcludes, - - @httpQuery("_source_includes") - _source_includes: SourceIncludes, - - @httpQuery("version") - version: Version, - - @httpQuery("version_type") - version_type: VersionType, -} - - -@input -structure ExistsSource_Input with [ExistsSource_QueryParams] { - @required - @httpLabel - id: PathDocumentId, - - @required - @httpLabel - index: PathIndex, -} - -// TODO: Fill in Output Structure -structure ExistsSource_Output {} diff --git a/model/_global/explain/operations.smithy b/model/_global/explain/operations.smithy deleted file mode 100644 index e0dd705b..00000000 --- a/model/_global/explain/operations.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/explain/" -) - -@xOperationGroup("explain") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_explain/{id}") -@documentation("Returns information about why a specific matches (or doesn't match) a query.") -operation Explain_Get { - input: Explain_Get_Input, - output: Explain_Output -} - -@xOperationGroup("explain") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_explain/{id}") -@documentation("Returns information about why a specific matches (or doesn't match) a query.") -operation Explain_Post { - input: Explain_Post_Input, - output: Explain_Output -} diff --git a/model/_global/explain/structures.smithy b/model/_global/explain/structures.smithy deleted file mode 100644 index 70ed3a9f..00000000 --- a/model/_global/explain/structures.smithy +++ /dev/null @@ -1,83 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Explain_QueryParams { - @httpQuery("analyze_wildcard") - @documentation("Specify whether wildcards and prefix queries in the query string query should be analyzed.") - @default(false) - analyze_wildcard: AnalyzeWildcard, - - @httpQuery("analyzer") - analyzer: Analyzer, - - @httpQuery("default_operator") - @default("OR") - default_operator: DefaultOperator, - - @httpQuery("df") - @default("_all") - df: DfExplain, - - @httpQuery("stored_fields") - stored_fields: StoredFields, - - @httpQuery("lenient") - lenient: Lenient, - - @httpQuery("preference") - @default("random") - preference: Preference, - - @httpQuery("q") - q: Q, - - @httpQuery("routing") - routing: Routing, - - @httpQuery("_source") - _source: Source, - - @httpQuery("_source_excludes") - _source_excludes: SourceExcludes, - - @httpQuery("_source_includes") - _source_includes: SourceIncludes, -} - -// TODO: Fill in Body Parameters -@documentation("The query definition using the Query DSL") -structure Explain_BodyParams {} - -@input -structure Explain_Get_Input with [Explain_QueryParams] { - @required - @httpLabel - id: PathDocumentId, - - @required - @httpLabel - index: PathIndex, -} - -@input -structure Explain_Post_Input with [Explain_QueryParams] { - @required - @httpLabel - id: PathDocumentId, - - @required - @httpLabel - index: PathIndex, - @httpPayload - content: Explain_BodyParams, -} - -// TODO: Fill in Output Structure -structure Explain_Output {} diff --git a/model/_global/field_caps/operations.smithy b/model/_global/field_caps/operations.smithy deleted file mode 100644 index d4679dbe..00000000 --- a/model/_global/field_caps/operations.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations" -) - -@xOperationGroup("field_caps") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_field_caps") -@documentation("Returns the information about the capabilities of fields among multiple indices.") -operation FieldCaps_Get { - input: FieldCaps_Get_Input, - output: FieldCaps_Output -} - -@xOperationGroup("field_caps") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_field_caps") -@documentation("Returns the information about the capabilities of fields among multiple indices.") -operation FieldCaps_Post { - input: FieldCaps_Post_Input, - output: FieldCaps_Output -} - -@xOperationGroup("field_caps") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_field_caps") -@documentation("Returns the information about the capabilities of fields among multiple indices.") -operation FieldCaps_Get_WithIndex { - input: FieldCaps_Get_WithIndex_Input, - output: FieldCaps_Output -} - -@xOperationGroup("field_caps") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_field_caps") -@documentation("Returns the information about the capabilities of fields among multiple indices.") -operation FieldCaps_Post_WithIndex { - input: FieldCaps_Post_WithIndex_Input, - output: FieldCaps_Output -} diff --git a/model/_global/field_caps/structures.smithy b/model/_global/field_caps/structures.smithy deleted file mode 100644 index a6f72643..00000000 --- a/model/_global/field_caps/structures.smithy +++ /dev/null @@ -1,62 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure FieldCaps_QueryParams { - @httpQuery("fields") - @documentation("Comma-separated list of field names.") - fields: Fields, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("include_unmapped") - @default(false) - include_unmapped: IncludeUnmapped, -} - -// TODO: Fill in Body Parameters -@documentation("An index filter specified with the Query DSL") -structure FieldCaps_BodyParams {} - -@input -structure FieldCaps_Get_Input with [FieldCaps_QueryParams] { -} - -@input -structure FieldCaps_Post_Input with [FieldCaps_QueryParams] { - @httpPayload - content: FieldCaps_BodyParams, -} - -@input -structure FieldCaps_Get_WithIndex_Input with [FieldCaps_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -@input -structure FieldCaps_Post_WithIndex_Input with [FieldCaps_QueryParams] { - @required - @httpLabel - index: PathIndices, - @httpPayload - content: FieldCaps_BodyParams, -} - -// TODO: Fill in Output Structure -structure FieldCaps_Output {} diff --git a/model/_global/get/operations.smithy b/model/_global/get/operations.smithy deleted file mode 100644 index 0d320ec3..00000000 --- a/model/_global/get/operations.smithy +++ /dev/null @@ -1,38 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/" -) - -@xOperationGroup("get") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_doc/{id}") -@documentation("Returns a document.") -operation Get { - input: Get_Input, - output: Get_Output -} - -apply Get @examples([ - { - title: "Examples for Get document doc Operation.", - input: { - index: "books", - id: "1" - }, - output: { - _index: "books", - _id: "1", - found: true - } - } -]) diff --git a/model/_global/get/structures.smithy b/model/_global/get/structures.smithy deleted file mode 100644 index 008ecf4b..00000000 --- a/model/_global/get/structures.smithy +++ /dev/null @@ -1,81 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Get_QueryParams { - @httpQuery("stored_fields") - stored_fields: StoredFields, - - @httpQuery("preference") - @default("random") - preference: Preference, - - @httpQuery("realtime") - realtime: Realtime, - - @httpQuery("refresh") - @documentation("Refresh the shard containing the document before performing the operation.") - refresh: RefreshBoolean, - - @httpQuery("routing") - routing: Routing, - - @httpQuery("_source") - _source: Source, - - @httpQuery("_source_excludes") - _source_excludes: SourceExcludes, - - @httpQuery("_source_includes") - _source_includes: SourceIncludes, - - @httpQuery("version") - version: Version, - - @httpQuery("version_type") - version_type: VersionType, -} - - -@input -structure Get_Input with [Get_QueryParams] { - @required - @httpLabel - id: PathDocumentId, - - @required - @httpLabel - index: PathIndex, -} - -structure Get_Output { - - @required - _index: Index, - - _type: String, - - @required - _id: String, - - version: Integer, - - seq_no: Long, - - primary_term: Long, - - @required - found: Boolean, - - _routing: String, - - _source: UserDefinedValueMap, - - _fields: UserDefinedValueMap -} diff --git a/model/_global/get_all_pits/operations.smithy b/model/_global/get_all_pits/operations.smithy deleted file mode 100644 index 665df1a4..00000000 --- a/model/_global/get_all_pits/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#list-all-pits" -) - -@xOperationGroup("get_all_pits") -@xVersionAdded("2.4") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_search/point_in_time/_all") -@documentation("Lists all active point in time searches.") -operation GetAllPits { - input: GetAllPits_Input, - output: GetAllPits_Output -} diff --git a/model/_global/get_all_pits/structures.smithy b/model/_global/get_all_pits/structures.smithy deleted file mode 100644 index e942a93f..00000000 --- a/model/_global/get_all_pits/structures.smithy +++ /dev/null @@ -1,27 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -structure PitDetail{ - pit_id: String, - creation_time: Long, - keep_alive: Long -} - -list PitDetailList{ - member: PitDetail -} - -@input -structure GetAllPits_Input { -} - -@output -structure GetAllPits_Output { - pits: PitDetailList -} diff --git a/model/_global/get_script/operations.smithy b/model/_global/get_script/operations.smithy deleted file mode 100644 index 5fa1751a..00000000 --- a/model/_global/get_script/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/script-apis/get-stored-script/" -) - -@xOperationGroup("get_script") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_scripts/{id}") -@documentation("Returns a script.") -operation GetScript { - input: GetScript_Input, - output: GetScript_Output -} diff --git a/model/_global/get_script/structures.smithy b/model/_global/get_script/structures.smithy deleted file mode 100644 index c1bafd9e..00000000 --- a/model/_global/get_script/structures.smithy +++ /dev/null @@ -1,28 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure GetScript_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - - -@input -structure GetScript_Input with [GetScript_QueryParams] { - @required - @httpLabel - id: PathScriptId, -} - -// TODO: Fill in Output Structure -structure GetScript_Output {} diff --git a/model/_global/get_script_context/operations.smithy b/model/_global/get_script_context/operations.smithy deleted file mode 100644 index c375b0e2..00000000 --- a/model/_global/get_script_context/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/script-apis/get-script-contexts/" -) - -@xOperationGroup("get_script_context") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_script_context") -@documentation("Returns all script contexts.") -operation GetScriptContext { - input: GetScriptContext_Input, - output: GetScriptContext_Output -} diff --git a/model/_global/get_script_context/structures.smithy b/model/_global/get_script_context/structures.smithy deleted file mode 100644 index f11aea01..00000000 --- a/model/_global/get_script_context/structures.smithy +++ /dev/null @@ -1,20 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure GetScriptContext_QueryParams { -} - - -@input -structure GetScriptContext_Input with [GetScriptContext_QueryParams] { -} - -// TODO: Fill in Output Structure -structure GetScriptContext_Output {} diff --git a/model/_global/get_script_languages/operations.smithy b/model/_global/get_script_languages/operations.smithy deleted file mode 100644 index 6ef8a274..00000000 --- a/model/_global/get_script_languages/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/script-apis/get-script-language/" -) - -@xOperationGroup("get_script_languages") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_script_language") -@documentation("Returns available script types, languages and contexts.") -operation GetScriptLanguages { - input: GetScriptLanguages_Input, - output: GetScriptLanguages_Output -} diff --git a/model/_global/get_script_languages/structures.smithy b/model/_global/get_script_languages/structures.smithy deleted file mode 100644 index 296753a7..00000000 --- a/model/_global/get_script_languages/structures.smithy +++ /dev/null @@ -1,20 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure GetScriptLanguages_QueryParams { -} - - -@input -structure GetScriptLanguages_Input with [GetScriptLanguages_QueryParams] { -} - -// TODO: Fill in Output Structure -structure GetScriptLanguages_Output {} diff --git a/model/_global/get_source/operations.smithy b/model/_global/get_source/operations.smithy deleted file mode 100644 index 081a63e3..00000000 --- a/model/_global/get_source/operations.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/" -) - -@xOperationGroup("get_source") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_source/{id}") -@documentation("Returns the source of a document.") -operation GetSource { - input: GetSource_Input, - output: GetSource_Output -} - -apply GetSource @examples([ - { - title: "Examples for Get document source Operation.", - input: { - index: "books", - id: "1" - } - } -]) diff --git a/model/_global/get_source/structures.smithy b/model/_global/get_source/structures.smithy deleted file mode 100644 index f16a5b2f..00000000 --- a/model/_global/get_source/structures.smithy +++ /dev/null @@ -1,55 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure GetSource_QueryParams { - @httpQuery("preference") - @default("random") - preference: Preference, - - @httpQuery("realtime") - realtime: Realtime, - - @httpQuery("refresh") - @documentation("Refresh the shard containing the document before performing the operation.") - refresh: RefreshBoolean, - - @httpQuery("routing") - routing: Routing, - - @httpQuery("_source") - _source: Source, - - @httpQuery("_source_excludes") - _source_excludes: SourceExcludes, - - @httpQuery("_source_includes") - _source_includes: SourceIncludes, - - @httpQuery("version") - version: Version, - - @httpQuery("version_type") - version_type: VersionType, -} - - -@input -structure GetSource_Input with [GetSource_QueryParams] { - @required - @httpLabel - id: PathDocumentId, - - @required - @httpLabel - index: PathIndex, -} - -// TODO: Fill in Output Structure -structure GetSource_Output {} diff --git a/model/_global/index/operations.smithy b/model/_global/index/operations.smithy deleted file mode 100644 index 6313e2d9..00000000 --- a/model/_global/index/operations.smithy +++ /dev/null @@ -1,43 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/index-document/" -) - -@xOperationGroup("index") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_doc") -@documentation("Creates or updates a document in an index.") -operation Index_Post { - input: Index_Post_Input, - output: Index_Output -} - -@xOperationGroup("index") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/{index}/_doc/{id}") -@documentation("Creates or updates a document in an index.") -operation Index_Put_WithId { - input: Index_Put_WithId_Input, - output: Index_Output -} - -@xOperationGroup("index") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_doc/{id}") -@documentation("Creates or updates a document in an index.") -operation Index_Post_WithId { - input: Index_Post_WithId_Input, - output: Index_Output -} diff --git a/model/_global/index/structures.smithy b/model/_global/index/structures.smithy deleted file mode 100644 index 49c30f94..00000000 --- a/model/_global/index/structures.smithy +++ /dev/null @@ -1,93 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Index_QueryParams { - @httpQuery("wait_for_active_shards") - @documentation("Sets the number of shard copies that must be active before proceeding with the 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).") - @default("1") - wait_for_active_shards: WaitForActiveShards, - - @httpQuery("op_type") - op_type: OpType, - - @httpQuery("refresh") - @default("false") - refresh: RefreshEnum, - - @httpQuery("routing") - routing: Routing, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("version") - version: Version, - - @httpQuery("version_type") - version_type: VersionType, - - @httpQuery("if_seq_no") - if_seq_no: IfSeqNo, - - @httpQuery("if_primary_term") - if_primary_term: IfPrimaryTerm, - - @httpQuery("pipeline") - pipeline: Pipeline, - - @httpQuery("require_alias") - @default(false) - require_alias: RequireAlias, -} - -// TODO: Fill in Body Parameters -@documentation("The document") -structure Index_BodyParams {} - -@input -structure Index_Post_Input with [Index_QueryParams] { - @required - @httpLabel - index: PathIndex, - @required - @httpPayload - content: Index_BodyParams, -} - -@input -structure Index_Put_WithId_Input with [Index_QueryParams] { - @required - @httpLabel - id: PathDocumentId, - - @required - @httpLabel - index: PathIndex, - @required - @httpPayload - content: Index_BodyParams, -} - -@input -structure Index_Post_WithId_Input with [Index_QueryParams] { - @required - @httpLabel - id: PathDocumentId, - - @required - @httpLabel - index: PathIndex, - @required - @httpPayload - content: Index_BodyParams, -} - -// TODO: Fill in Output Structure -structure Index_Output {} diff --git a/model/_global/info/operations.smithy b/model/_global/info/operations.smithy deleted file mode 100644 index 4f823a26..00000000 --- a/model/_global/info/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) -@xOperationGroup("info") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/") -@documentation("Returns basic information about the cluster.") -operation Info { - input: Info_Input, - output: Info_Output -} diff --git a/model/_global/info/structures.smithy b/model/_global/info/structures.smithy deleted file mode 100644 index a5bd92af..00000000 --- a/model/_global/info/structures.smithy +++ /dev/null @@ -1,38 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Info_QueryParams { -} - - -@input -structure Info_Input with [Info_QueryParams] { -} - -@output -structure Info_Output { - name: String, - cluster_name: String, - cluster_uuid: String, - version: InfoVersion, - tagline: String -} - -structure InfoVersion { - distribution: String, - number: String, - build_type: String, - build_hash: String, - build_date: String, - build_snapshot: Boolean, - lucene_version: String, - minimum_wire_compatibility_version: String, - minimum_index_compatibility_version: String -} diff --git a/model/_global/mget/operations.smithy b/model/_global/mget/operations.smithy deleted file mode 100644 index dfacc7a2..00000000 --- a/model/_global/mget/operations.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/" -) - -@xOperationGroup("mget") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_mget") -@documentation("Allows to get multiple documents in one request.") -operation Mget_Get { - input: Mget_Get_Input, - output: Mget_Output -} - -@xOperationGroup("mget") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_mget") -@documentation("Allows to get multiple documents in one request.") -operation Mget_Post { - input: Mget_Post_Input, - output: Mget_Output -} - -@xOperationGroup("mget") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_mget") -@documentation("Allows to get multiple documents in one request.") -operation Mget_Get_WithIndex { - input: Mget_Get_WithIndex_Input, - output: Mget_Output -} - -@xOperationGroup("mget") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_mget") -@documentation("Allows to get multiple documents in one request.") -operation Mget_Post_WithIndex { - input: Mget_Post_WithIndex_Input, - output: Mget_Output -} diff --git a/model/_global/mget/structures.smithy b/model/_global/mget/structures.smithy deleted file mode 100644 index 46634b99..00000000 --- a/model/_global/mget/structures.smithy +++ /dev/null @@ -1,72 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Mget_QueryParams { - @httpQuery("stored_fields") - stored_fields: StoredFields, - - @httpQuery("preference") - @default("random") - preference: Preference, - - @httpQuery("realtime") - realtime: Realtime, - - @httpQuery("refresh") - @documentation("Refresh the shard containing the document before performing the operation.") - refresh: RefreshBoolean, - - @httpQuery("routing") - routing: Routing, - - @httpQuery("_source") - _source: Source, - - @httpQuery("_source_excludes") - _source_excludes: SourceExcludes, - - @httpQuery("_source_includes") - _source_includes: SourceIncludes, -} - -// TODO: Fill in Body Parameters -@documentation("Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL.") -structure Mget_BodyParams {} - -@input -structure Mget_Get_Input with [Mget_QueryParams] { -} - -@input -structure Mget_Post_Input with [Mget_QueryParams] { - @required - @httpPayload - content: Mget_BodyParams, -} - -@input -structure Mget_Get_WithIndex_Input with [Mget_QueryParams] { - @required - @httpLabel - index: PathIndex, -} - -@input -structure Mget_Post_WithIndex_Input with [Mget_QueryParams] { - @required - @httpLabel - index: PathIndex, - @required - @httpPayload - content: Mget_BodyParams, -} - -// TODO: Fill in Output Structure -structure Mget_Output {} diff --git a/model/_global/msearch/operations.smithy b/model/_global/msearch/operations.smithy deleted file mode 100644 index 657cd27d..00000000 --- a/model/_global/msearch/operations.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/multi-search/" -) - -@xOperationGroup("msearch") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_msearch") -@documentation("Allows to execute several search operations in one request.") -operation Msearch_Get { - input: Msearch_Get_Input, - output: Msearch_Output -} - -@xOperationGroup("msearch") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_msearch") -@documentation("Allows to execute several search operations in one request.") -operation Msearch_Post { - input: Msearch_Post_Input, - output: Msearch_Output -} - -@xOperationGroup("msearch") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_msearch") -@documentation("Allows to execute several search operations in one request.") -operation Msearch_Get_WithIndex { - input: Msearch_Get_WithIndex_Input, - output: Msearch_Output -} - -@xOperationGroup("msearch") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_msearch") -@documentation("Allows to execute several search operations in one request.") -operation Msearch_Post_WithIndex { - input: Msearch_Post_WithIndex_Input, - output: Msearch_Output -} diff --git a/model/_global/msearch/structures.smithy b/model/_global/msearch/structures.smithy deleted file mode 100644 index 1d5ade0c..00000000 --- a/model/_global/msearch/structures.smithy +++ /dev/null @@ -1,74 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Msearch_QueryParams { - @httpQuery("search_type") - search_type: SearchTypeMulti, - - @httpQuery("max_concurrent_searches") - max_concurrent_searches: MaxConcurrentSearches, - - @httpQuery("typed_keys") - typed_keys: TypedKeys, - - @httpQuery("pre_filter_shard_size") - pre_filter_shard_size: PreFilterShardSize, - - @httpQuery("max_concurrent_shard_requests") - @documentation("The number of concurrent shard requests each sub search executes concurrently per node. 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.") - @default(5) - max_concurrent_shard_requests: MaxConcurrentShardRequests, - - @httpQuery("rest_total_hits_as_int") - @default(false) - rest_total_hits_as_int: RestTotalHitsAsInt, - - @httpQuery("ccs_minimize_roundtrips") - @default(true) - ccs_minimize_roundtrips: CcsMinimizeRoundtrips, -} - -// TODO: Fill in Body Parameters -@xSerialize("bulk") -@documentation("The request definitions (metadata-search request definition pairs), separated by newlines") -structure Msearch_BodyParams {} - -@input -structure Msearch_Get_Input with [Msearch_QueryParams] { -} - -@input -structure Msearch_Post_Input with [Msearch_QueryParams] { - @required - @httpPayload - content: Msearch_BodyParams, -} - -@input -structure Msearch_Get_WithIndex_Input with [Msearch_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to use as default.") - index: PathIndices, -} - -@input -structure Msearch_Post_WithIndex_Input with [Msearch_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to use as default.") - index: PathIndices, - @required - @httpPayload - content: Msearch_BodyParams, -} - -// TODO: Fill in Output Structure -structure Msearch_Output {} diff --git a/model/_global/msearch_template/operations.smithy b/model/_global/msearch_template/operations.smithy deleted file mode 100644 index 6ced3872..00000000 --- a/model/_global/msearch_template/operations.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/search-template/" -) - -@xOperationGroup("msearch_template") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_msearch/template") -@documentation("Allows to execute several search template operations in one request.") -operation MsearchTemplate_Get { - input: MsearchTemplate_Get_Input, - output: MsearchTemplate_Output -} - -@xOperationGroup("msearch_template") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_msearch/template") -@documentation("Allows to execute several search template operations in one request.") -operation MsearchTemplate_Post { - input: MsearchTemplate_Post_Input, - output: MsearchTemplate_Output -} - -@xOperationGroup("msearch_template") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_msearch/template") -@documentation("Allows to execute several search template operations in one request.") -operation MsearchTemplate_Get_WithIndex { - input: MsearchTemplate_Get_WithIndex_Input, - output: MsearchTemplate_Output -} - -@xOperationGroup("msearch_template") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_msearch/template") -@documentation("Allows to execute several search template operations in one request.") -operation MsearchTemplate_Post_WithIndex { - input: MsearchTemplate_Post_WithIndex_Input, - output: MsearchTemplate_Output -} diff --git a/model/_global/msearch_template/structures.smithy b/model/_global/msearch_template/structures.smithy deleted file mode 100644 index de2e2aa5..00000000 --- a/model/_global/msearch_template/structures.smithy +++ /dev/null @@ -1,66 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure MsearchTemplate_QueryParams { - @httpQuery("search_type") - search_type: SearchTypeMulti, - - @httpQuery("typed_keys") - typed_keys: TypedKeys, - - @httpQuery("max_concurrent_searches") - max_concurrent_searches: MaxConcurrentSearches, - - @httpQuery("rest_total_hits_as_int") - @default(false) - rest_total_hits_as_int: RestTotalHitsAsInt, - - @httpQuery("ccs_minimize_roundtrips") - @default(true) - ccs_minimize_roundtrips: CcsMinimizeRoundtrips, -} - -// TODO: Fill in Body Parameters -@xSerialize("bulk") -@documentation("The request definitions (metadata-search request definition pairs), separated by newlines") -structure MsearchTemplate_BodyParams {} - -@input -structure MsearchTemplate_Get_Input with [MsearchTemplate_QueryParams] { -} - -@input -structure MsearchTemplate_Post_Input with [MsearchTemplate_QueryParams] { - @required - @httpPayload - content: MsearchTemplate_BodyParams, -} - -@input -structure MsearchTemplate_Get_WithIndex_Input with [MsearchTemplate_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to use as default.") - index: PathIndices, -} - -@input -structure MsearchTemplate_Post_WithIndex_Input with [MsearchTemplate_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to use as default.") - index: PathIndices, - @required - @httpPayload - content: MsearchTemplate_BodyParams, -} - -// TODO: Fill in Output Structure -structure MsearchTemplate_Output {} diff --git a/model/_global/mtermvectors/operations.smithy b/model/_global/mtermvectors/operations.smithy deleted file mode 100644 index 4e3f244c..00000000 --- a/model/_global/mtermvectors/operations.smithy +++ /dev/null @@ -1,55 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("mtermvectors") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_mtermvectors") -@documentation("Returns multiple termvectors in one request.") -operation Mtermvectors_Get { - input: Mtermvectors_Get_Input, - output: Mtermvectors_Output -} - -@xOperationGroup("mtermvectors") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_mtermvectors") -@documentation("Returns multiple termvectors in one request.") -operation Mtermvectors_Post { - input: Mtermvectors_Post_Input, - output: Mtermvectors_Output -} - -@xOperationGroup("mtermvectors") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_mtermvectors") -@documentation("Returns multiple termvectors in one request.") -operation Mtermvectors_Get_WithIndex { - input: Mtermvectors_Get_WithIndex_Input, - output: Mtermvectors_Output -} - -@xOperationGroup("mtermvectors") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_mtermvectors") -@documentation("Returns multiple termvectors in one request.") -operation Mtermvectors_Post_WithIndex { - input: Mtermvectors_Post_WithIndex_Input, - output: Mtermvectors_Output -} diff --git a/model/_global/mtermvectors/structures.smithy b/model/_global/mtermvectors/structures.smithy deleted file mode 100644 index c70cbcae..00000000 --- a/model/_global/mtermvectors/structures.smithy +++ /dev/null @@ -1,98 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Mtermvectors_QueryParams { - @httpQuery("ids") - ids: Ids, - - @httpQuery("term_statistics") - @documentation("Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.") - @default(false) - term_statistics: TermStatistics, - - @httpQuery("field_statistics") - @documentation("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'.") - @default(true) - field_statistics: FieldStatistics, - - @httpQuery("fields") - @documentation("Comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.") - fields: Fields, - - @httpQuery("offsets") - @documentation("Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.") - @default(true) - offsets: Offsets, - - @httpQuery("positions") - @documentation("Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.") - @default(true) - positions: Positions, - - @httpQuery("payloads") - @documentation("Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.") - @default(true) - payloads: Payloads, - - @httpQuery("preference") - @documentation("Specify the node or shard the operation should be performed on. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.") - @default("random") - preference: Preference, - - @httpQuery("routing") - @documentation("Routing value. Applies to all returned documents unless otherwise specified in body 'params' or 'docs'.") - routing: Routing, - - @httpQuery("realtime") - @documentation("Specifies if requests are real-time as opposed to near-real-time.") - @default(true) - realtime: Realtime, - - @httpQuery("version") - version: Version, - - @httpQuery("version_type") - version_type: VersionType, -} - -// TODO: Fill in Body Parameters -@documentation("Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.") -structure Mtermvectors_BodyParams {} - -@input -structure Mtermvectors_Get_Input with [Mtermvectors_QueryParams] { -} - -@input -structure Mtermvectors_Post_Input with [Mtermvectors_QueryParams] { - @httpPayload - content: Mtermvectors_BodyParams, -} - -@input -structure Mtermvectors_Get_WithIndex_Input with [Mtermvectors_QueryParams] { - @required - @httpLabel - @documentation("The index in which the document resides.") - index: PathIndex, -} - -@input -structure Mtermvectors_Post_WithIndex_Input with [Mtermvectors_QueryParams] { - @required - @httpLabel - @documentation("The index in which the document resides.") - index: PathIndex, - @httpPayload - content: Mtermvectors_BodyParams, -} - -// TODO: Fill in Output Structure -structure Mtermvectors_Output {} diff --git a/model/_global/ping/operations.smithy b/model/_global/ping/operations.smithy deleted file mode 100644 index 28223374..00000000 --- a/model/_global/ping/operations.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("ping") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@readonly -@http(method: "HEAD", uri: "/") -@documentation("Returns whether the cluster is running.") -operation Ping { - input: Ping_Input, - output: Ping_Output -} diff --git a/model/_global/ping/structures.smithy b/model/_global/ping/structures.smithy deleted file mode 100644 index 6ac3b280..00000000 --- a/model/_global/ping/structures.smithy +++ /dev/null @@ -1,20 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Ping_QueryParams { -} - - -@input -structure Ping_Input with [Ping_QueryParams] { -} - -// TODO: Fill in Output Structure -structure Ping_Output {} diff --git a/model/_global/put_script/operations.smithy b/model/_global/put_script/operations.smithy deleted file mode 100644 index 5c8f82b5..00000000 --- a/model/_global/put_script/operations.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/" -) - -@xOperationGroup("put_script") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_scripts/{id}") -@documentation("Creates or updates a script.") -operation PutScript_Put { - input: PutScript_Put_Input, - output: PutScript_Output -} - -@xOperationGroup("put_script") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_scripts/{id}") -@documentation("Creates or updates a script.") -operation PutScript_Post { - input: PutScript_Post_Input, - output: PutScript_Output -} - -@xOperationGroup("put_script") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_scripts/{id}/{context}") -@documentation("Creates or updates a script.") -operation PutScript_Put_WithContext { - input: PutScript_Put_WithContext_Input, - output: PutScript_Output -} - -@xOperationGroup("put_script") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_scripts/{id}/{context}") -@documentation("Creates or updates a script.") -operation PutScript_Post_WithContext { - input: PutScript_Post_WithContext_Input, - output: PutScript_Output -} diff --git a/model/_global/put_script/structures.smithy b/model/_global/put_script/structures.smithy deleted file mode 100644 index bf99b9f3..00000000 --- a/model/_global/put_script/structures.smithy +++ /dev/null @@ -1,75 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure PutScript_QueryParams { - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - -// TODO: Fill in Body Parameters -@documentation("The document") -structure PutScript_BodyParams {} - -@input -structure PutScript_Put_Input with [PutScript_QueryParams] { - @required - @httpLabel - id: PathScriptId, - @required - @httpPayload - content: PutScript_BodyParams, -} - -@input -structure PutScript_Post_Input with [PutScript_QueryParams] { - @required - @httpLabel - id: PathScriptId, - @required - @httpPayload - content: PutScript_BodyParams, -} - -@input -structure PutScript_Put_WithContext_Input with [PutScript_QueryParams] { - @required - @httpLabel - id: PathScriptId, - - @required - @httpLabel - context: PathContext, - @required - @httpPayload - content: PutScript_BodyParams, -} - -@input -structure PutScript_Post_WithContext_Input with [PutScript_QueryParams] { - @required - @httpLabel - id: PathScriptId, - - @required - @httpLabel - context: PathContext, - @required - @httpPayload - content: PutScript_BodyParams, -} - -// TODO: Fill in Output Structure -structure PutScript_Output {} diff --git a/model/_global/rank_eval/operations.smithy b/model/_global/rank_eval/operations.smithy deleted file mode 100644 index f65f4bbc..00000000 --- a/model/_global/rank_eval/operations.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/rank-eval/" -) - -@xOperationGroup("rank_eval") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_rank_eval") -@documentation("Allows to evaluate the quality of ranked search results over a set of typical search queries.") -operation RankEval_Get { - input: RankEval_Get_Input, - output: RankEval_Output -} - -@xOperationGroup("rank_eval") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_rank_eval") -@documentation("Allows to evaluate the quality of ranked search results over a set of typical search queries.") -operation RankEval_Post { - input: RankEval_Post_Input, - output: RankEval_Output -} - -@xOperationGroup("rank_eval") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_rank_eval") -@documentation("Allows to evaluate the quality of ranked search results over a set of typical search queries.") -operation RankEval_Get_WithIndex { - input: RankEval_Get_WithIndex_Input, - output: RankEval_Output -} - -@xOperationGroup("rank_eval") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_rank_eval") -@documentation("Allows to evaluate the quality of ranked search results over a set of typical search queries.") -operation RankEval_Post_WithIndex { - input: RankEval_Post_WithIndex_Input, - output: RankEval_Output -} diff --git a/model/_global/rank_eval/structures.smithy b/model/_global/rank_eval/structures.smithy deleted file mode 100644 index e5b621ba..00000000 --- a/model/_global/rank_eval/structures.smithy +++ /dev/null @@ -1,59 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure RankEval_QueryParams { - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("search_type") - search_type: SearchType, -} - -// TODO: Fill in Body Parameters -@documentation("The ranking evaluation search definition, including search requests, document ratings and ranking metric definition.") -structure RankEval_BodyParams {} - -@input -structure RankEval_Get_Input with [RankEval_QueryParams] { -} - -@input -structure RankEval_Post_Input with [RankEval_QueryParams] { - @required - @httpPayload - content: RankEval_BodyParams, -} - -@input -structure RankEval_Get_WithIndex_Input with [RankEval_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -@input -structure RankEval_Post_WithIndex_Input with [RankEval_QueryParams] { - @required - @httpLabel - index: PathIndices, - @required - @httpPayload - content: RankEval_BodyParams, -} - -// TODO: Fill in Output Structure -structure RankEval_Output {} diff --git a/model/_global/reindex/operations.smithy b/model/_global/reindex/operations.smithy deleted file mode 100644 index c1bbcff2..00000000 --- a/model/_global/reindex/operations.smithy +++ /dev/null @@ -1,25 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/im-plugin/reindex-data/" -) - -@xOperationGroup("reindex") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_reindex") -@documentation("Allows to copy documents from one index to another, optionally filtering the source -documents by a query, changing the destination index settings, or fetching the -documents from a remote cluster.") -operation Reindex { - input: Reindex_Input, - output: Reindex_Output -} diff --git a/model/_global/reindex/structures.smithy b/model/_global/reindex/structures.smithy deleted file mode 100644 index 877a4e7c..00000000 --- a/model/_global/reindex/structures.smithy +++ /dev/null @@ -1,56 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Reindex_QueryParams { - @httpQuery("refresh") - @documentation("Should the affected indexes be refreshed?.") - refresh: RefreshBoolean, - - @httpQuery("timeout") - @default("1m") - timeout: BulkTimeout, - - @httpQuery("wait_for_active_shards") - @documentation("Sets the number of shard copies that must be active before proceeding with the 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).") - @default("1") - wait_for_active_shards: WaitForActiveShards, - - @httpQuery("wait_for_completion") - @default(true) - wait_for_completion: WaitForCompletionTrue, - - @httpQuery("requests_per_second") - @default(0) - requests_per_second: RequestsPerSecond, - - @httpQuery("scroll") - scroll: Scroll, - - @httpQuery("slices") - @default("1") - slices: Slices, - - @httpQuery("max_docs") - max_docs: MaxDocs, -} - -// TODO: Fill in Body Parameters -@documentation("The search definition using the Query DSL and the prototype for the index request.") -structure Reindex_BodyParams {} - -@input -structure Reindex_Input with [Reindex_QueryParams] { - @required - @httpPayload - content: Reindex_BodyParams, -} - -// TODO: Fill in Output Structure -structure Reindex_Output {} diff --git a/model/_global/reindex_rethrottle/operations.smithy b/model/_global/reindex_rethrottle/operations.smithy deleted file mode 100644 index 5c992758..00000000 --- a/model/_global/reindex_rethrottle/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("reindex_rethrottle") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_reindex/{task_id}/_rethrottle") -@documentation("Changes the number of requests per second for a particular Reindex operation.") -operation ReindexRethrottle { - input: ReindexRethrottle_Input, - output: ReindexRethrottle_Output -} diff --git a/model/_global/reindex_rethrottle/structures.smithy b/model/_global/reindex_rethrottle/structures.smithy deleted file mode 100644 index 48743962..00000000 --- a/model/_global/reindex_rethrottle/structures.smithy +++ /dev/null @@ -1,27 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ReindexRethrottle_QueryParams { - @httpQuery("requests_per_second") - @required - requests_per_second: RequestsPerSecond, -} - - -@input -structure ReindexRethrottle_Input with [ReindexRethrottle_QueryParams] { - @required - @httpLabel - @documentation("The task id to rethrottle.") - task_id: PathTaskId, -} - -// TODO: Fill in Output Structure -structure ReindexRethrottle_Output {} diff --git a/model/_global/render_search_template/operations.smithy b/model/_global/render_search_template/operations.smithy deleted file mode 100644 index af6f5f4f..00000000 --- a/model/_global/render_search_template/operations.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/search-template/" -) - -@xOperationGroup("render_search_template") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_render/template") -@documentation("Allows to use the Mustache language to pre-render a search definition.") -operation RenderSearchTemplate_Get { - input: RenderSearchTemplate_Get_Input, - output: RenderSearchTemplate_Output -} - -@xOperationGroup("render_search_template") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_render/template") -@documentation("Allows to use the Mustache language to pre-render a search definition.") -operation RenderSearchTemplate_Post { - input: RenderSearchTemplate_Post_Input, - output: RenderSearchTemplate_Output -} - -@xOperationGroup("render_search_template") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_render/template/{id}") -@documentation("Allows to use the Mustache language to pre-render a search definition.") -operation RenderSearchTemplate_Get_WithId { - input: RenderSearchTemplate_Get_WithId_Input, - output: RenderSearchTemplate_Output -} - -@xOperationGroup("render_search_template") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_render/template/{id}") -@documentation("Allows to use the Mustache language to pre-render a search definition.") -operation RenderSearchTemplate_Post_WithId { - input: RenderSearchTemplate_Post_WithId_Input, - output: RenderSearchTemplate_Output -} diff --git a/model/_global/render_search_template/structures.smithy b/model/_global/render_search_template/structures.smithy deleted file mode 100644 index 34bd9e4e..00000000 --- a/model/_global/render_search_template/structures.smithy +++ /dev/null @@ -1,45 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure RenderSearchTemplate_QueryParams { -} - -// TODO: Fill in Body Parameters -@documentation("The search definition template and its params") -structure RenderSearchTemplate_BodyParams {} - -@input -structure RenderSearchTemplate_Get_Input with [RenderSearchTemplate_QueryParams] { -} - -@input -structure RenderSearchTemplate_Post_Input with [RenderSearchTemplate_QueryParams] { - @httpPayload - content: RenderSearchTemplate_BodyParams, -} - -@input -structure RenderSearchTemplate_Get_WithId_Input with [RenderSearchTemplate_QueryParams] { - @required - @httpLabel - id: PathSearchTemplateId, -} - -@input -structure RenderSearchTemplate_Post_WithId_Input with [RenderSearchTemplate_QueryParams] { - @required - @httpLabel - id: PathSearchTemplateId, - @httpPayload - content: RenderSearchTemplate_BodyParams, -} - -// TODO: Fill in Output Structure -structure RenderSearchTemplate_Output {} diff --git a/model/_global/scripts_painless_execute/operations.smithy b/model/_global/scripts_painless_execute/operations.smithy deleted file mode 100644 index 6acc2d86..00000000 --- a/model/_global/scripts_painless_execute/operations.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/" -) - -@xOperationGroup("scripts_painless_execute") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_scripts/painless/_execute") -@documentation("Allows an arbitrary script to be executed and a result to be returned.") -operation ScriptsPainlessExecute_Get { - input: ScriptsPainlessExecute_Get_Input, - output: ScriptsPainlessExecute_Output -} - -@xOperationGroup("scripts_painless_execute") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_scripts/painless/_execute") -@documentation("Allows an arbitrary script to be executed and a result to be returned.") -operation ScriptsPainlessExecute_Post { - input: ScriptsPainlessExecute_Post_Input, - output: ScriptsPainlessExecute_Output -} diff --git a/model/_global/scripts_painless_execute/structures.smithy b/model/_global/scripts_painless_execute/structures.smithy deleted file mode 100644 index 02123baa..00000000 --- a/model/_global/scripts_painless_execute/structures.smithy +++ /dev/null @@ -1,29 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ScriptsPainlessExecute_QueryParams { -} - -// TODO: Fill in Body Parameters -@documentation("The script to execute") -structure ScriptsPainlessExecute_BodyParams {} - -@input -structure ScriptsPainlessExecute_Get_Input with [ScriptsPainlessExecute_QueryParams] { -} - -@input -structure ScriptsPainlessExecute_Post_Input with [ScriptsPainlessExecute_QueryParams] { - @httpPayload - content: ScriptsPainlessExecute_BodyParams, -} - -// TODO: Fill in Output Structure -structure ScriptsPainlessExecute_Output {} diff --git a/model/_global/scroll/operations.smithy b/model/_global/scroll/operations.smithy deleted file mode 100644 index 23a0d7ff..00000000 --- a/model/_global/scroll/operations.smithy +++ /dev/null @@ -1,60 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods" -) - -@xOperationGroup("scroll") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_search/scroll") -@documentation("Allows to retrieve a large numbers of results from a single search request.") -operation Scroll_Get { - input: Scroll_Get_Input, - output: Scroll_Output -} - -@xOperationGroup("scroll") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_search/scroll") -@documentation("Allows to retrieve a large numbers of results from a single search request.") -operation Scroll_Post { - input: Scroll_Post_Input, - output: Scroll_Output -} - -@deprecated -@xOperationGroup("scroll") -@xVersionAdded("1.0") -@xDeprecationMessage("A scroll id can be quite large and should be specified as part of the body") -@xVersionDeprecated("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_search/scroll/{scroll_id}") -@documentation("Allows to retrieve a large numbers of results from a single search request.") -operation Scroll_Get_WithScrollId { - input: Scroll_Get_WithScrollId_Input, - output: Scroll_Output -} - -@deprecated -@xOperationGroup("scroll") -@xVersionAdded("1.0") -@xDeprecationMessage("A scroll id can be quite large and should be specified as part of the body") -@xVersionDeprecated("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_search/scroll/{scroll_id}") -@documentation("Allows to retrieve a large numbers of results from a single search request.") -operation Scroll_Post_WithScrollId { - input: Scroll_Post_WithScrollId_Input, - output: Scroll_Output -} diff --git a/model/_global/scroll/structures.smithy b/model/_global/scroll/structures.smithy deleted file mode 100644 index f56b17bd..00000000 --- a/model/_global/scroll/structures.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Scroll_QueryParams { - @httpQuery("scroll") - scroll: Scroll, - - @httpQuery("scroll_id") - query_scroll_id: ScrollId, - - @httpQuery("rest_total_hits_as_int") - @default(false) - rest_total_hits_as_int: RestTotalHitsAsInt, -} - -// TODO: Fill in Body Parameters -@documentation("The scroll ID if not passed by URL or query parameter.") -structure Scroll_BodyParams {} - -@input -structure Scroll_Get_Input with [Scroll_QueryParams] { -} - -@input -structure Scroll_Post_Input with [Scroll_QueryParams] { - @httpPayload - content: Scroll_BodyParams, -} - -@input -structure Scroll_Get_WithScrollId_Input with [Scroll_QueryParams] { - @required - @httpLabel - scroll_id: PathScrollId, -} - -@input -structure Scroll_Post_WithScrollId_Input with [Scroll_QueryParams] { - @required - @httpLabel - scroll_id: PathScrollId, - @httpPayload - content: Scroll_BodyParams, -} - -// TODO: Fill in Output Structure -structure Scroll_Output {} diff --git a/model/_global/search/operations.smithy b/model/_global/search/operations.smithy deleted file mode 100644 index 4212ec1d..00000000 --- a/model/_global/search/operations.smithy +++ /dev/null @@ -1,117 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/search/" -) - -@xOperationGroup("search") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_search") -@documentation("Returns results matching a query.") -operation Search_Get { - input: Search_Get_Input, - output: Search_Output -} - -@xOperationGroup("search") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_search") -@documentation("Returns results matching a query.") -operation Search_Post { - input: Search_Post_Input, - output: Search_Output -} - -@xOperationGroup("search") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_search") -@documentation("Returns results matching a query.") -operation Search_Get_WithIndex { - input: Search_Get_WithIndex_Input, - output: Search_Output -} - -@xOperationGroup("search") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_search") -@documentation("Returns results matching a query.") -operation Search_Post_WithIndex { - input: Search_Post_WithIndex_Input, - output: Search_Output -} - -apply Search_Post @examples([ - { - title: "Examples for Post Search Operation.", - input: { - scroll: "1d", - content: { - query: { - match_all: {} - }, - fields: ["*"] - } - }, - output: { - timed_out: false, - _shards: { - total: 1, - successful: 1, - skipped: 0, - failed: 0 - }, - hits: { - total: { - value: 0, - relation: "eq" - }, - hits: [] - } - } - } -]) - -apply Search_Post_WithIndex @examples([ - { - title: "Examples for Post Search With Index Operation.", - input: { - index: "books", - scroll: "1d", - content: { - query: { - match_all: {} - }, - fields: ["*"] - } - }, - output: { - timed_out: false, - _shards: { - total: 1, - successful: 1, - skipped: 0, - failed: 0 - }, - hits: { - total: { - value: 0, - relation: "eq" - }, - hits: [] - } - } - } -]) diff --git a/model/_global/search/structures.smithy b/model/_global/search/structures.smithy deleted file mode 100644 index 51009964..00000000 --- a/model/_global/search/structures.smithy +++ /dev/null @@ -1,211 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Search_QueryParams { - @httpQuery("analyzer") - analyzer: Analyzer, - - @httpQuery("analyze_wildcard") - @default(false) - analyze_wildcard: AnalyzeWildcard, - - @httpQuery("ccs_minimize_roundtrips") - @default(true) - ccs_minimize_roundtrips: CcsMinimizeRoundtrips, - - @httpQuery("default_operator") - @default("OR") - default_operator: DefaultOperator, - - @httpQuery("df") - df: Df, - - @httpQuery("explain") - @documentation("Specify whether to return detailed information about score computation as part of a hit.") - explain: Explain, - - @httpQuery("stored_fields") - stored_fields: StoredFields, - - @httpQuery("docvalue_fields") - docvalue_fields: DocvalueFields, - - @httpQuery("from") - @default(0) - from: From, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("ignore_throttled") - ignore_throttled: IgnoreThrottled, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("lenient") - lenient: Lenient, - - @httpQuery("preference") - @default("random") - preference: Preference, - - @httpQuery("q") - q: Q, - - @httpQuery("routing") - routing: Routings, - - @httpQuery("scroll") - scroll: Scroll, - - @httpQuery("search_type") - search_type: SearchType, - - @httpQuery("size") - @documentation("Number of hits to return.") - @default(10) - size: Size, - - @httpQuery("sort") - sort: Sort, - - @httpQuery("_source") - _source: Source, - - @httpQuery("_source_excludes") - _source_excludes: SourceExcludes, - - @httpQuery("_source_includes") - _source_includes: SourceIncludes, - - @httpQuery("terminate_after") - terminate_after: TerminateAfter, - - @httpQuery("stats") - stats: Stats, - - @httpQuery("suggest_field") - suggest_field: SuggestField, - - @httpQuery("suggest_mode") - @default("missing") - suggest_mode: SuggestMode, - - @httpQuery("suggest_size") - suggest_size: SuggestSize, - - @httpQuery("suggest_text") - suggest_text: SuggestText, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("track_scores") - track_scores: TrackScores, - - @httpQuery("track_total_hits") - track_total_hits: TrackTotalHits, - - @httpQuery("allow_partial_search_results") - @default(true) - allow_partial_search_results: AllowPartialSearchResults, - - @httpQuery("typed_keys") - typed_keys: TypedKeys, - - @httpQuery("version") - version: WithVersion, - - @httpQuery("seq_no_primary_term") - seq_no_primary_term: SeqNoPrimaryTerm, - - @httpQuery("request_cache") - request_cache: RequestCache, - - @httpQuery("batched_reduce_size") - @default(512) - batched_reduce_size: BatchedReduceSize, - - @httpQuery("max_concurrent_shard_requests") - @documentation("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.") - @default(5) - max_concurrent_shard_requests: MaxConcurrentShardRequests, - - @httpQuery("pre_filter_shard_size") - pre_filter_shard_size: PreFilterShardSize, - - @httpQuery("rest_total_hits_as_int") - @default(false) - rest_total_hits_as_int: RestTotalHitsAsInt, - - @httpQuery("search_pipeline") - search_pipeline: SearchPipeline, - - @httpQuery("include_named_queries_score") - @default(false) - include_named_queries_score: IncludeNamedQueriesScore -} - -@documentation("The search definition using the Query DSL") -structure Search_BodyParams { - docvalue_fields: String, - explain: Boolean, - from: Integer, - seq_no_primary_term: Boolean, - size: Integer, - source: String, - stats: String, - terminate_after: Integer, - timeout: Time, - version: Boolean, - fields: UserDefinedValueList, - min_score: Integer, - indices_boost: UserDefinedObjectList, - query: UserDefinedObjectStructure -} - -@input -structure Search_Get_Input with [Search_QueryParams] { -} - -@input -structure Search_Post_Input with [Search_QueryParams] { - @httpPayload - content: Search_BodyParams, -} - -@input -structure Search_Get_WithIndex_Input with [Search_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -@input -structure Search_Post_WithIndex_Input with [Search_QueryParams] { - @required - @httpLabel - index: PathIndices, - @httpPayload - content: Search_BodyParams, -} - -structure Search_Output { - _scroll_id: String, - took: Long, - timed_out: Boolean, - _shards: ShardStatistics, - hits: HitsMetadata -} diff --git a/model/_global/search_shards/operations.smithy b/model/_global/search_shards/operations.smithy deleted file mode 100644 index c1755eeb..00000000 --- a/model/_global/search_shards/operations.smithy +++ /dev/null @@ -1,55 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("search_shards") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_search_shards") -@documentation("Returns information about the indices and shards that a search request would be executed against.") -operation SearchShards_Get { - input: SearchShards_Get_Input, - output: SearchShards_Output -} - -@xOperationGroup("search_shards") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_search_shards") -@documentation("Returns information about the indices and shards that a search request would be executed against.") -operation SearchShards_Post { - input: SearchShards_Post_Input, - output: SearchShards_Output -} - -@xOperationGroup("search_shards") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_search_shards") -@documentation("Returns information about the indices and shards that a search request would be executed against.") -operation SearchShards_Get_WithIndex { - input: SearchShards_Get_WithIndex_Input, - output: SearchShards_Output -} - -@xOperationGroup("search_shards") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_search_shards") -@documentation("Returns information about the indices and shards that a search request would be executed against.") -operation SearchShards_Post_WithIndex { - input: SearchShards_Post_WithIndex_Input, - output: SearchShards_Output -} diff --git a/model/_global/search_shards/structures.smithy b/model/_global/search_shards/structures.smithy deleted file mode 100644 index 5d99a2ab..00000000 --- a/model/_global/search_shards/structures.smithy +++ /dev/null @@ -1,58 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure SearchShards_QueryParams { - @httpQuery("preference") - @default("random") - preference: Preference, - - @httpQuery("routing") - routing: Routing, - - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, -} - - -@input -structure SearchShards_Get_Input with [SearchShards_QueryParams] { -} - -@input -structure SearchShards_Post_Input with [SearchShards_QueryParams] { -} - -@input -structure SearchShards_Get_WithIndex_Input with [SearchShards_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -@input -structure SearchShards_Post_WithIndex_Input with [SearchShards_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure SearchShards_Output {} diff --git a/model/_global/search_template/operations.smithy b/model/_global/search_template/operations.smithy deleted file mode 100644 index 06b93a4a..00000000 --- a/model/_global/search_template/operations.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/search-template/" -) - -@xOperationGroup("search_template") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_search/template") -@documentation("Allows to use the Mustache language to pre-render a search definition.") -operation SearchTemplate_Get { - input: SearchTemplate_Get_Input, - output: SearchTemplate_Output -} - -@xOperationGroup("search_template") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_search/template") -@documentation("Allows to use the Mustache language to pre-render a search definition.") -operation SearchTemplate_Post { - input: SearchTemplate_Post_Input, - output: SearchTemplate_Output -} - -@xOperationGroup("search_template") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_search/template") -@documentation("Allows to use the Mustache language to pre-render a search definition.") -operation SearchTemplate_Get_WithIndex { - input: SearchTemplate_Get_WithIndex_Input, - output: SearchTemplate_Output -} - -@xOperationGroup("search_template") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_search/template") -@documentation("Allows to use the Mustache language to pre-render a search definition.") -operation SearchTemplate_Post_WithIndex { - input: SearchTemplate_Post_WithIndex_Input, - output: SearchTemplate_Output -} diff --git a/model/_global/search_template/structures.smithy b/model/_global/search_template/structures.smithy deleted file mode 100644 index 77c1d77a..00000000 --- a/model/_global/search_template/structures.smithy +++ /dev/null @@ -1,90 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure SearchTemplate_QueryParams { - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("ignore_throttled") - ignore_throttled: IgnoreThrottled, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("preference") - @default("random") - preference: Preference, - - @httpQuery("routing") - routing: Routings, - - @httpQuery("scroll") - scroll: Scroll, - - @httpQuery("search_type") - search_type: SearchTypeMulti, - - @httpQuery("explain") - @documentation("Specify whether to return detailed information about score computation as part of a hit.") - explain: Explain, - - @httpQuery("profile") - profile: Profile, - - @httpQuery("typed_keys") - typed_keys: TypedKeys, - - @httpQuery("rest_total_hits_as_int") - @default(false) - rest_total_hits_as_int: RestTotalHitsAsInt, - - @httpQuery("ccs_minimize_roundtrips") - @default(true) - ccs_minimize_roundtrips: CcsMinimizeRoundtrips, -} - -// TODO: Fill in Body Parameters -@documentation("The search definition template and its params") -structure SearchTemplate_BodyParams {} - -@input -structure SearchTemplate_Get_Input with [SearchTemplate_QueryParams] { -} - -@input -structure SearchTemplate_Post_Input with [SearchTemplate_QueryParams] { - @required - @httpPayload - content: SearchTemplate_BodyParams, -} - -@input -structure SearchTemplate_Get_WithIndex_Input with [SearchTemplate_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -@input -structure SearchTemplate_Post_WithIndex_Input with [SearchTemplate_QueryParams] { - @required - @httpLabel - index: PathIndices, - @required - @httpPayload - content: SearchTemplate_BodyParams, -} - -// TODO: Fill in Output Structure -structure SearchTemplate_Output {} diff --git a/model/_global/termvectors/operations.smithy b/model/_global/termvectors/operations.smithy deleted file mode 100644 index 3a6934d9..00000000 --- a/model/_global/termvectors/operations.smithy +++ /dev/null @@ -1,55 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("termvectors") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_termvectors") -@documentation("Returns information and statistics about terms in the fields of a particular document.") -operation Termvectors_Get { - input: Termvectors_Get_Input, - output: Termvectors_Output -} - -@xOperationGroup("termvectors") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_termvectors") -@documentation("Returns information and statistics about terms in the fields of a particular document.") -operation Termvectors_Post { - input: Termvectors_Post_Input, - output: Termvectors_Output -} - -@xOperationGroup("termvectors") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_termvectors/{id}") -@documentation("Returns information and statistics about terms in the fields of a particular document.") -operation Termvectors_Get_WithId { - input: Termvectors_Get_WithId_Input, - output: Termvectors_Output -} - -@xOperationGroup("termvectors") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_termvectors/{id}") -@documentation("Returns information and statistics about terms in the fields of a particular document.") -operation Termvectors_Post_WithId { - input: Termvectors_Post_WithId_Input, - output: Termvectors_Output -} diff --git a/model/_global/termvectors/structures.smithy b/model/_global/termvectors/structures.smithy deleted file mode 100644 index 5b2720c3..00000000 --- a/model/_global/termvectors/structures.smithy +++ /dev/null @@ -1,106 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Termvectors_QueryParams { - @httpQuery("term_statistics") - @default(false) - term_statistics: TermStatistics, - - @httpQuery("field_statistics") - @default(true) - field_statistics: FieldStatistics, - - @httpQuery("fields") - @documentation("Comma-separated list of fields to return.") - fields: Fields, - - @httpQuery("offsets") - @default(true) - offsets: Offsets, - - @httpQuery("positions") - @default(true) - positions: Positions, - - @httpQuery("payloads") - @default(true) - payloads: Payloads, - - @httpQuery("preference") - @default("random") - preference: Preference, - - @httpQuery("routing") - routing: Routing, - - @httpQuery("realtime") - @documentation("Specifies if request is real-time as opposed to near-real-time.") - @default(true) - realtime: Realtime, - - @httpQuery("version") - version: Version, - - @httpQuery("version_type") - version_type: VersionType, -} - -// TODO: Fill in Body Parameters -@documentation("Define parameters and or supply a document to get termvectors for. See documentation.") -structure Termvectors_BodyParams {} - -@input -structure Termvectors_Get_Input with [Termvectors_QueryParams] { - @required - @httpLabel - @documentation("The index in which the document resides.") - index: PathIndex, -} - -@input -structure Termvectors_Post_Input with [Termvectors_QueryParams] { - @required - @httpLabel - @documentation("The index in which the document resides.") - index: PathIndex, - @httpPayload - content: Termvectors_BodyParams, -} - -@input -structure Termvectors_Get_WithId_Input with [Termvectors_QueryParams] { - @required - @httpLabel - @documentation("The index in which the document resides.") - index: PathIndex, - - @required - @httpLabel - @documentation("Document ID. When not specified a doc param should be supplied.") - id: PathDocumentId, -} - -@input -structure Termvectors_Post_WithId_Input with [Termvectors_QueryParams] { - @required - @httpLabel - @documentation("The index in which the document resides.") - index: PathIndex, - - @required - @httpLabel - @documentation("Document ID. When not specified a doc param should be supplied.") - id: PathDocumentId, - @httpPayload - content: Termvectors_BodyParams, -} - -// TODO: Fill in Output Structure -structure Termvectors_Output {} diff --git a/model/_global/update/operations.smithy b/model/_global/update/operations.smithy deleted file mode 100644 index a0b39ed0..00000000 --- a/model/_global/update/operations.smithy +++ /dev/null @@ -1,22 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/update-document/" -) - -@xOperationGroup("update") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_update/{id}") -@documentation("Updates a document with a script or partial document.") -operation Update { - input: Update_Input, - output: Update_Output -} diff --git a/model/_global/update/structures.smithy b/model/_global/update/structures.smithy deleted file mode 100644 index f0df1c32..00000000 --- a/model/_global/update/structures.smithy +++ /dev/null @@ -1,74 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure Update_QueryParams { - @httpQuery("wait_for_active_shards") - @documentation("Sets the number of shard copies that must be active before proceeding with the 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).") - @default("1") - wait_for_active_shards: WaitForActiveShards, - - @httpQuery("_source") - _source: Source, - - @httpQuery("_source_excludes") - _source_excludes: SourceExcludes, - - @httpQuery("_source_includes") - _source_includes: SourceIncludes, - - @httpQuery("lang") - @default("painless") - lang: Lang, - - @httpQuery("refresh") - @default("false") - refresh: RefreshEnum, - - @httpQuery("retry_on_conflict") - @default(0) - retry_on_conflict: RetryOnConflict, - - @httpQuery("routing") - routing: Routing, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("if_seq_no") - if_seq_no: IfSeqNo, - - @httpQuery("if_primary_term") - if_primary_term: IfPrimaryTerm, - - @httpQuery("require_alias") - @default(false) - require_alias: RequireAlias, -} - -// TODO: Fill in Body Parameters -@documentation("The request definition requires either `script` or partial `doc`") -structure Update_BodyParams {} - -@input -structure Update_Input with [Update_QueryParams] { - @required - @httpLabel - id: PathDocumentId, - - @required - @httpLabel - index: PathIndex, - @required - @httpPayload - content: Update_BodyParams, -} - -// TODO: Fill in Output Structure -structure Update_Output {} diff --git a/model/_global/update_by_query/operations.smithy b/model/_global/update_by_query/operations.smithy deleted file mode 100644 index acb44990..00000000 --- a/model/_global/update_by_query/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/document-apis/update-by-query/" -) - -@xOperationGroup("update_by_query") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_update_by_query") -@documentation("Performs an update on every document in the index without changing the source, -for example to pick up a mapping change.") -operation UpdateByQuery { - input: UpdateByQuery_Input, - output: UpdateByQuery_Output -} diff --git a/model/_global/update_by_query/structures.smithy b/model/_global/update_by_query/structures.smithy deleted file mode 100644 index a712c024..00000000 --- a/model/_global/update_by_query/structures.smithy +++ /dev/null @@ -1,144 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure UpdateByQuery_QueryParams { - @httpQuery("analyzer") - analyzer: Analyzer, - - @httpQuery("analyze_wildcard") - @default(false) - analyze_wildcard: AnalyzeWildcard, - - @httpQuery("default_operator") - @default("OR") - default_operator: DefaultOperator, - - @httpQuery("df") - df: Df, - - @httpQuery("from") - @default(0) - from: From, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("conflicts") - @default("abort") - conflicts: Conflicts, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("lenient") - lenient: Lenient, - - @httpQuery("pipeline") - pipeline: Pipeline, - - @httpQuery("preference") - @default("random") - preference: Preference, - - @httpQuery("q") - q: Q, - - @httpQuery("routing") - routing: Routings, - - @httpQuery("scroll") - scroll: Scroll, - - @httpQuery("search_type") - search_type: SearchType, - - @httpQuery("search_timeout") - search_timeout: SearchTimeout, - - @httpQuery("size") - @documentation("Deprecated, please use `max_docs` instead.") - size: Size, - - @httpQuery("max_docs") - max_docs: MaxDocs, - - @httpQuery("sort") - sort: Sort, - - @httpQuery("_source") - _source: Source, - - @httpQuery("_source_excludes") - _source_excludes: SourceExcludes, - - @httpQuery("_source_includes") - _source_includes: SourceIncludes, - - @httpQuery("terminate_after") - terminate_after: TerminateAfter, - - @httpQuery("stats") - stats: Stats, - - @httpQuery("version") - version: WithVersion, - - @httpQuery("request_cache") - request_cache: RequestCache, - - @httpQuery("refresh") - @documentation("Should the affected indexes be refreshed?.") - refresh: RefreshBoolean, - - @httpQuery("timeout") - @default("1m") - timeout: BulkTimeout, - - @httpQuery("wait_for_active_shards") - @documentation("Sets the number of shard copies that must be active before proceeding with the 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).") - @default("1") - wait_for_active_shards: WaitForActiveShards, - - @httpQuery("scroll_size") - @default(100) - scroll_size: ScrollSize, - - @httpQuery("wait_for_completion") - @default(true) - wait_for_completion: WaitForCompletionTrue, - - @httpQuery("requests_per_second") - @default(0) - requests_per_second: RequestsPerSecond, - - @httpQuery("slices") - @default("1") - slices: Slices, -} - -// TODO: Fill in Body Parameters -@documentation("The search definition using the Query DSL") -structure UpdateByQuery_BodyParams {} - -@input -structure UpdateByQuery_Input with [UpdateByQuery_QueryParams] { - @required - @httpLabel - index: PathIndices, - @httpPayload - content: UpdateByQuery_BodyParams, -} - -// TODO: Fill in Output Structure -structure UpdateByQuery_Output {} diff --git a/model/_global/update_by_query_rethrottle/operations.smithy b/model/_global/update_by_query_rethrottle/operations.smithy deleted file mode 100644 index 2b465c07..00000000 --- a/model/_global/update_by_query_rethrottle/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("update_by_query_rethrottle") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_update_by_query/{task_id}/_rethrottle") -@documentation("Changes the number of requests per second for a particular Update By Query operation.") -operation UpdateByQueryRethrottle { - input: UpdateByQueryRethrottle_Input, - output: UpdateByQueryRethrottle_Output -} diff --git a/model/_global/update_by_query_rethrottle/structures.smithy b/model/_global/update_by_query_rethrottle/structures.smithy deleted file mode 100644 index fd259db2..00000000 --- a/model/_global/update_by_query_rethrottle/structures.smithy +++ /dev/null @@ -1,27 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure UpdateByQueryRethrottle_QueryParams { - @httpQuery("requests_per_second") - @required - requests_per_second: RequestsPerSecond, -} - - -@input -structure UpdateByQueryRethrottle_Input with [UpdateByQueryRethrottle_QueryParams] { - @required - @httpLabel - @documentation("The task id to rethrottle.") - task_id: PathTaskId, -} - -// TODO: Fill in Output Structure -structure UpdateByQueryRethrottle_Output {} diff --git a/model/_metadata.smithy b/model/_metadata.smithy deleted file mode 100644 index ef0931f9..00000000 --- a/model/_metadata.smithy +++ /dev/null @@ -1,75 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" - -metadata suppressions = [ - { - id: "DeprecatedShape.OpenSearch#MasterTimeout", - namespace: "OpenSearch", - reason: "Deprecated for downstream use, not worried about warnings inside Smithy" - }, - { - id: "DeprecatedShape.OpenSearch#CatMaster", - namespace: "OpenSearch", - reason: "Deprecated for downstream use, not worried about warnings inside Smithy" - }, - { - id: "DeprecatedShape.OpenSearch#ClearScroll_WithScrollId", - namespace: "OpenSearch", - reason: "Deprecated for downstream use, not worried about warnings inside Smithy" - }, - { - id: "DeprecatedShape.OpenSearch#NodesHotThreads_Deprecated", - namespace: "OpenSearch", - reason: "Deprecated for downstream use, not worried about warnings inside Smithy" - }, - { - id: "DeprecatedShape.OpenSearch#NodesHotThreads_DeprecatedCluster", - namespace: "OpenSearch", - reason: "Deprecated for downstream use, not worried about warnings inside Smithy" - }, - { - id: "DeprecatedShape.OpenSearch#NodesHotThreads_DeprecatedDash", - namespace: "OpenSearch", - reason: "Deprecated for downstream use, not worried about warnings inside Smithy" - }, - { - id: "DeprecatedShape.OpenSearch#NodesHotThreads_WithNodeId_Deprecated", - namespace: "OpenSearch", - reason: "Deprecated for downstream use, not worried about warnings inside Smithy" - }, - { - id: "DeprecatedShape.OpenSearch#NodesHotThreads_WithNodeId_DeprecatedCluster", - namespace: "OpenSearch", - reason: "Deprecated for downstream use, not worried about warnings inside Smithy" - }, - { - id: "DeprecatedShape.OpenSearch#NodesHotThreads_WithNodeId_DeprecatedDash", - namespace: "OpenSearch", - reason: "Deprecated for downstream use, not worried about warnings inside Smithy" - }, - { - id: "DeprecatedShape.OpenSearch#PathScrollIds", - namespace: "OpenSearch", - reason: "Deprecated for downstream use, not worried about warnings inside Smithy" - }, - { - id: "DeprecatedShape.OpenSearch#Scroll_Get_WithScrollId", - namespace: "OpenSearch", - reason: "Deprecated for downstream use, not worried about warnings inside Smithy" - }, - { - id: "DeprecatedShape.OpenSearch#Scroll_Post_WithScrollId", - namespace: "OpenSearch", - reason: "Deprecated for downstream use, not worried about warnings inside Smithy" - }, - { - id: "ProtocolHttpPayload", - namespace: "OpenSearch", - reason: "AWS protocols validator rejects @httpPayload targeting lists or maps, however for our use cases the conversion to OpenAPI functions as expected." - } -] diff --git a/model/_plugins/notifications/config.smithy b/model/_plugins/notifications/config.smithy deleted file mode 100644 index d87e5b69..00000000 --- a/model/_plugins/notifications/config.smithy +++ /dev/null @@ -1,133 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -structure NotificationsConfig { - config_id: String, - @required - config: NotificationsConfigItem -} - -@documentation("Type of notification configuration.") -enum NotificationConfigType { - SLACK = "slack", - CHIME = "chime", - MICROSOFT_TEAMS = "microsoft_teams", - WEBHOOK = "webhook", - EMAIL = "email", - SNS = "sns", - SES_ACCOUNT = "ses_account", - SMTP_ACCOUNT = "smtp_account", - EMAIL_GROUP = "email_group" -} - -structure NotificationsConfigItem { - @required - name: String, - description: String - @required - config_type: NotificationConfigType, - is_enabled: Boolean, - sns: SnsItem, - slack: SlackItem, - chime: Chime, - webhook: Webhook, - smtp_account: SmtpAccount, - ses_account: SesAccount, - email_group: EmailGroup, - email: Email, - microsoft_teams: MicrosoftTeamsItem -} - -structure MicrosoftTeamsItem { - @required - url: String -} - -structure SlackItem { - @required - url: String -} - -structure SnsItem { - @required - topic_arn: String, - role_arn: String -} - -structure Chime { - @required - url: String -} - -enum HttpMethodType { - POST = "POST", - PUT = "PUT", - PATCH = "PATCH" -} - -map HeaderParamsMap { - key: String - value: Integer -} - -structure Webhook { - @required - url: String, - method: HttpMethodType, - header_params: HeaderParamsMap, -} - -enum EmailEncryptionMethod { - SSL = "ssl", - START_TLS = "start_tls", - NONE = "none" -} - -structure SmtpAccount { - @required - host: String, - @required - port: Integer, - @required - method: EmailEncryptionMethod, - @required - from_addess: String -} - -structure SesAccount { - @required - region: String, - role_arn: String, - @required - from_addess: String -} - -list EmailGroupIdList { - member: String -} - -list RecipientList { - member: RecipientListItem -} - -structure RecipientListItem { - recipient: String -} - -structure EmailGroup { - @required - recipient_list: RecipientList, - email_group_id_list: EmailGroupIdList -} - -structure Email { - @required - email_account_id: String, - recipient_list: RecipientList -} diff --git a/model/_plugins/notifications/create_config/operations.smithy b/model/_plugins/notifications/create_config/operations.smithy deleted file mode 100644 index 1933e75f..00000000 --- a/model/_plugins/notifications/create_config/operations.smithy +++ /dev/null @@ -1,22 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#create-channel-configuration" -) - -@xOperationGroup("notifications.create_config") -@xVersionAdded("2.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_plugins/_notifications/configs") -@documentation("Create channel configuration.") -operation NotificationsConfigs_Post { - input: NotificationsConfigs_Post_Input, - output: NotificationsConfigs_Post_Output -} diff --git a/model/_plugins/notifications/create_config/structures.smithy b/model/_plugins/notifications/create_config/structures.smithy deleted file mode 100644 index f269f14e..00000000 --- a/model/_plugins/notifications/create_config/structures.smithy +++ /dev/null @@ -1,20 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure NotificationsConfigs_Post_Input { - @required - @httpPayload - content: NotificationsConfig -} - -@output -structure NotificationsConfigs_Post_Output { - config_id: String -} diff --git a/model/_plugins/notifications/delete_config/operations.smithy b/model/_plugins/notifications/delete_config/operations.smithy deleted file mode 100644 index 8c880d91..00000000 --- a/model/_plugins/notifications/delete_config/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#delete-channel-configuration" -) - -@xOperationGroup("notifications.delete_config") -@xVersionAdded("2.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_plugins/_notifications/configs/{config_id}") -@documentation("Delete channel configuration.") -operation NotificationsConfigs_Delete_WithPathParams { - input: NotificationsConfigs_Delete_WithPathParams_Input, - output: NotificationsConfigs_Delete_Output -} - -@xOperationGroup("notifications.delete_config") -@xVersionAdded("2.2") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_plugins/_notifications/configs") -@documentation("Delete channel configuration.") -operation NotificationsConfigs_Delete_WithQueryParams { - input: NotificationsConfigs_Delete_WithQueryParams_Input, - output: NotificationsConfigs_Delete_Output -} diff --git a/model/_plugins/notifications/delete_config/structures.smithy b/model/_plugins/notifications/delete_config/structures.smithy deleted file mode 100644 index f2cb544f..00000000 --- a/model/_plugins/notifications/delete_config/structures.smithy +++ /dev/null @@ -1,55 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure NotificationsConfigs_Delete_WithPathParams_Input { - @required - @httpLabel - config_id: String -} - -@input -structure NotificationsConfigs_Delete_WithQueryParams_Input { - @httpQuery("config_id") - @documentation("A channel ID.") - config_id: String, - - @httpQuery("config_id_list") - @documentation("A comma-separated list of channel IDs.") - config_id_list: String -} - -structure NotificationsConfigs_Delete_Output { - delete_response_list: DeleteResponseList -} - -map DeleteResponseList { - key: String - value: RestStatus -} - -enum RestStatus { - CONTINUE = "continue", - SWITCHING_PROTOCOLS = "switching_protocols", - OK = "ok", - CREATED = "created", - ACCEPTED = "accepted", - NON_AUTHORITATIVE_INFORMATION = "non_authoritative_information", - NO_CONTENT = "no_content", - RESET_CONTENT = "reset_content", - PARTIAL_CONTENT = "partial_content", - MULTI_STATUS = "multi_status", - MULTIPLE_CHOICES = "multiple_choices", - MOVED_PERMANENTLY = "moved_permanently", - FOUND = "found", - SEE_OTHER = "see_other", - NOT_MODIFIED = "not_modified", - USE_PROXY = "use_proxy", - TEMPORARY_REDIRECT = "temporary_redirect" -} diff --git a/model/_plugins/notifications/get_configs/operations.smithy b/model/_plugins/notifications/get_configs/operations.smithy deleted file mode 100644 index 2a2c8e52..00000000 --- a/model/_plugins/notifications/get_configs/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#get-channel-configuration" -) - -@xOperationGroup("notifications.get_config") -@xVersionAdded("2.0") -@readonly -@suppress(["HttpUriConflict", "HttpMethodSemantics.UnexpectedPayload"]) -@http(method: "GET", uri: "/_plugins/_notifications/configs") -@documentation("Get channel configuration.") -operation NotificationsConfigs_Get { - input: NotificationsConfigs_Get_Input, - output: NotificationsConfigs_Get_Output -} - -@xOperationGroup("notifications.get_config") -@xVersionAdded("2.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_notifications/configs/{config_id}") -@documentation("Get channel configuration.") -operation NotificationsConfigsItem_Get { - input: NotificationsConfigsItem_Get_Input, - output: NotificationsConfigs_Get_Output -} diff --git a/model/_plugins/notifications/get_configs/structures.smithy b/model/_plugins/notifications/get_configs/structures.smithy deleted file mode 100644 index 7669b15d..00000000 --- a/model/_plugins/notifications/get_configs/structures.smithy +++ /dev/null @@ -1,165 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure NotificationsConfigs_Get_Input { - config_id_list: ConfigIdList, - sort_field: String, - sort_order: String, - from_index: Integer, - max_items: Integer, - - @httpQuery("last_updated_time_ms") - lastUpdatedTimeMs: Long, - - @httpQuery("created_time_ms") - createdTimeMs: Long, - - @httpQuery("config_type") - configType: NotificationConfigType, - - @httpQuery("email.email_account_id") - emailAccountId: String, - - @httpQuery("email.email_group_id_list") - emailGroupIdList: String, - - @httpQuery("smtp_account.method") - smtpAccountMethod: String, - - @httpQuery("ses_account.region") - sesAccountRegion: String, - - @httpQuery("name") - name: String, - - @httpQuery("name.keyword") - nameKeyword: String, - - @httpQuery("description") - description: String, - - @httpQuery("description.keyword") - descriptionKeyword: String, - - @httpQuery("slack.url") - slackUrl: String, - - @httpQuery("slack.url.keyword") - slackUrlKeyword: String, - - @httpQuery("chime.url") - chimeUrl: String, - - @httpQuery("chime.url.keyword") - chimeUrlKeyword: String, - - @httpQuery("microsoft_teams.url") - microsoftTeamsUrl: String, - - @httpQuery("microsoft_teams.url.keyword") - microsoftTeamsUrlKeyword: String, - - @httpQuery("webhook.url") - webhookUrl: String, - - @httpQuery("webhook.url.keyword") - webhookUrlKeyword: String, - - @httpQuery("smtp_account.host") - smtpAccountHost: String, - - @httpQuery("smtp_account.host.keyword") - smtpAccountHostKeyword: String, - - @httpQuery("smtp_account.from_address") - smtpAccountFromAddress: String, - - @httpQuery("smtp_account.from_address.keyword") - smtpAccountFromAddressKeyword: String, - - @httpQuery("sns.topic_arn") - snsTopicArn: String, - - @httpQuery("sns.topic_arn.keyword") - snsTopicArnKeyword: String, - - @httpQuery("sns.role_arn") - snsRoleArn: String, - - @httpQuery("sns.role_arn.keyword") - snsRoleArnKeyword: String, - - @httpQuery("ses_account.role_arn") - sesAccountRoleArn: String, - - @httpQuery("ses_account.role_arn.keyword") - sesAccountRoleArnKeyword: String, - - @httpQuery("ses_account.from_address") - sesAccountFromAddress: String, - - @httpQuery("ses_account.from_address.keyword") - sesAccountFromAddressKeyword: String, - - @httpQuery("is_enabled") - isEnabled: Boolean, - - @httpQuery("email.recipient_list.recipient") - emailRecipientListRecipient: String, - - @httpQuery("email.recipient_list.recipient.keyword") - emailRecipientListRecipientKeyword: String, - - @httpQuery("email_group.recipient_list.recipient") - emailGroupRecipientListRecipient: String, - - @httpQuery("email_group.recipient_list.recipient.keyword") - emailGroupRecipientListRecipientKeyword: String, - - @httpQuery("query") - query: String, - - @httpQuery("text_query") - textQuery: String -} - -list ConfigIdList { - member: String -} - -@input -structure NotificationsConfigsItem_Get_Input { - @required - @httpLabel - config_id: String -} - -enum TotalHitRelation { - EQ = "eq", - GTE = "gte" -} - -structure NotificationsConfigs_Get_Output { - start_index: Long, - total_hits: Long, - total_hit_relation: TotalHitRelation, - config_list: NotificationsConfigsList -} - -list NotificationsConfigsList { - member: NotificationsConfigsOutputItem -} - -structure NotificationsConfigsOutputItem { - config_id: String, - last_updated_time_ms: Long, - created_time_ms: Long, - config: NotificationsConfigItem -} diff --git a/model/_plugins/notifications/get_features/operations.smithy b/model/_plugins/notifications/get_features/operations.smithy deleted file mode 100644 index 723e85e0..00000000 --- a/model/_plugins/notifications/get_features/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-supported-channel-configurations" -) - -@xOperationGroup("notifications.list_features") -@xVersionAdded("2.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_notifications/features") -@documentation("List supported channel configurations.") -operation NotificationsFeatures_Get { - input: NotificationsFeatures_Get_Input, - output: NotificationsFeatures_Get_Output -} diff --git a/model/_plugins/notifications/get_features/structures.smithy b/model/_plugins/notifications/get_features/structures.smithy deleted file mode 100644 index 3397290a..00000000 --- a/model/_plugins/notifications/get_features/structures.smithy +++ /dev/null @@ -1,27 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure NotificationsFeatures_Get_Input { -} - -@output -structure NotificationsFeatures_Get_Output { - allowed_config_type_list: NotificationsFeaturesList, - plugin_features: NotificationsPluginFeaturesMap -} - -list NotificationsFeaturesList { - member: NotificationConfigType -} - -map NotificationsPluginFeaturesMap { - key: String, - value: String -} diff --git a/model/_plugins/notifications/test_feature/operations.smithy b/model/_plugins/notifications/test_feature/operations.smithy deleted file mode 100644 index 7f735dc5..00000000 --- a/model/_plugins/notifications/test_feature/operations.smithy +++ /dev/null @@ -1,37 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#send-test-notification" -) - -@xOperationGroup("notifications.send_test") -@xVersionAdded("2.0") -@readonly -@suppress(["HttpUriConflict"]) -@deprecated -@xDeprecationMessage("Use the POST method instead.") -@xVersionDeprecated("2.3") -@http(method: "GET", uri: "/_plugins/_notifications/feature/test/{config_id}") -@documentation("Send a test notification.") -operation NotificationsFeatureTest_Get { - input: NotificationsFeatureTest_Input, - output: NotificationsFeatureTest_Output -} - -@xOperationGroup("notifications.send_test") -@xVersionAdded("2.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_plugins/_notifications/feature/test/{config_id}") -@documentation("Send a test notification.") -operation NotificationsFeatureTest_Post { - input: NotificationsFeatureTest_Input, - output: NotificationsFeatureTest_Output -} diff --git a/model/_plugins/notifications/test_feature/structures.smithy b/model/_plugins/notifications/test_feature/structures.smithy deleted file mode 100644 index 29ac40ca..00000000 --- a/model/_plugins/notifications/test_feature/structures.smithy +++ /dev/null @@ -1,62 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -structure NotificationsFeatureTest_Input { - @required - @httpLabel - config_id: String -} - -structure NotificationsFeatureTest_Output { - event_source: EventSource, - status_list: StatusList -} - -structure EventSource { - title: String, - reference_id: String, - severity: SeverityType, - tags: TagsList -} - -enum SeverityType { - HIGH = "high", - INFO = "info", - CRITICAL = "critical" -} - -list TagsList { - member: String -} - -list StatusList { - member: EventStatus -} - -structure EventStatus { - config_id: String, - config_name: String, - config_type: NotificationConfigType, - email_recipient_status: EmailRecipientStatusList, - delivery_status: DeliveryStatus -} - -list EmailRecipientStatusList { - member: EmailRecipientStatus -} - -structure EmailRecipientStatus { - recipient: String, - delivery_status: DeliveryStatus -} - -structure DeliveryStatus { - status_code: String, - status_text: String -} diff --git a/model/_plugins/notifications/update_config/operations.smithy b/model/_plugins/notifications/update_config/operations.smithy deleted file mode 100644 index 5f5206d8..00000000 --- a/model/_plugins/notifications/update_config/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#update-channel-configuration" -) - -@xOperationGroup("notifications.update_config") -@xVersionAdded("2.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_plugins/_notifications/configs/{config_id}") -@documentation("Update channel configuration.") -operation NotificationsConfigs_Put { - input: NotificationsConfigs_Put_Input, - output: NotificationsConfigs_Put_Output -} diff --git a/model/_plugins/notifications/update_config/structures.smithy b/model/_plugins/notifications/update_config/structures.smithy deleted file mode 100644 index 4e28a811..00000000 --- a/model/_plugins/notifications/update_config/structures.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure NotificationsConfigs_Put_Input { - @required - @httpLabel - config_id: String, - - @required - @httpPayload - content: NotificationsConfig -} - -@output -structure NotificationsConfigs_Put_Output { - config_id: String -} diff --git a/model/_types/query_dsl/abstractions.smithy b/model/_types/query_dsl/abstractions.smithy deleted file mode 100644 index 8debea37..00000000 --- a/model/_types/query_dsl/abstractions.smithy +++ /dev/null @@ -1,65 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -structure UserDefinedObjectStructure { - bool: Document, - boosting: Document, - combined_fields: Document, - constant_score: Document, - dis_max: Document, - distance_feature: Document, - exists: Document, - function_score: Document, - fuzzy: UserDefinedValueMap, - geo_bounding_box: Document, - geo_distance: Document, - geo_polygon: Document, - geo_shape: Document, - has_child: Document, - has_parent: Document, - ids: Document, - intervals: UserDefinedValueMap, - knn: Document, - match: UserDefinedValueMap, - match_all: Document, - match_bool_prefix: UserDefinedValueMap, - match_none: Document, - match_phrase: UserDefinedValueMap, - match_phrase_prefix: UserDefinedValueMap, - more_like_this: Document, - multi_match: Document, - nested: Document, - parent_id: Document, - percolate: Document, - pinned: Document, - prefix:UserDefinedValueMap, - query_string: Document, - range: UserDefinedValueMap, - rank_feature: Document, - regexp: UserDefinedValueMap, - script: Document, - script_score: Document, - shape: Document, - simple_query_string: Document, - span_containing: Document, - field_masking_span: Document, - span_first: Document, - span_multi: Document, - span_near: Document, - span_not: Document, - span_or: Document, - span_term: UserDefinedValueMap, - span_within: Document, - term: UserDefinedValueMap, - terms: Document, - terms_set: UserDefinedValueMap, - wildcard: UserDefinedValueMap, - wrapper: Document, - -} diff --git a/model/cat/aliases/operations.smithy b/model/cat/aliases/operations.smithy deleted file mode 100644 index 0b79fe9b..00000000 --- a/model/cat/aliases/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/" -) - -@xOperationGroup("cat.aliases") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/aliases") -@documentation("Shows information about currently configured aliases to indices including filter and routing infos.") -operation CatAliases { - input: CatAliases_Input, - output: CatAliases_Output -} - -@xOperationGroup("cat.aliases") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/aliases/{name}") -@documentation("Shows information about currently configured aliases to indices including filter and routing infos.") -operation CatAliases_WithName { - input: CatAliases_WithName_Input, - output: CatAliases_Output -} diff --git a/model/cat/aliases/structures.smithy b/model/cat/aliases/structures.smithy deleted file mode 100644 index d4b9d390..00000000 --- a/model/cat/aliases/structures.smithy +++ /dev/null @@ -1,51 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatAliases_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("v") - @default(false) - v: V, - - @httpQuery("expand_wildcards") - @default("all") - expand_wildcards: ExpandWildcards, -} - - -@input -structure CatAliases_Input with [CatAliases_QueryParams] { -} - -@input -structure CatAliases_WithName_Input with [CatAliases_QueryParams] { - @required - @httpLabel - name: PathAliasNames, -} - -// TODO: Fill in Output Structure -structure CatAliases_Output {} diff --git a/model/cat/allocation/operations.smithy b/model/cat/allocation/operations.smithy deleted file mode 100644 index 6f0bfc93..00000000 --- a/model/cat/allocation/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/" -) - -@xOperationGroup("cat.allocation") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/allocation") -@documentation("Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.") -operation CatAllocation { - input: CatAllocation_Input, - output: CatAllocation_Output -} - -@xOperationGroup("cat.allocation") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/allocation/{node_id}") -@documentation("Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.") -operation CatAllocation_WithNodeId { - input: CatAllocation_WithNodeId_Input, - output: CatAllocation_Output -} diff --git a/model/cat/allocation/structures.smithy b/model/cat/allocation/structures.smithy deleted file mode 100644 index 2ff6522e..00000000 --- a/model/cat/allocation/structures.smithy +++ /dev/null @@ -1,57 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatAllocation_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("bytes") - bytes: Bytes, - - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatAllocation_Input with [CatAllocation_QueryParams] { -} - -@input -structure CatAllocation_WithNodeId_Input with [CatAllocation_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of node IDs or names to limit the returned information.") - node_id: PathNodeId, -} - -// TODO: Fill in Output Structure -structure CatAllocation_Output {} diff --git a/model/cat/cluster_manager/operations.smithy b/model/cat/cluster_manager/operations.smithy deleted file mode 100644 index c7fc80d8..00000000 --- a/model/cat/cluster_manager/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/" -) - -@xOperationGroup("cat.cluster_manager") -@xVersionAdded("2.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/cluster_manager") -@documentation("Returns information about the cluster-manager node.") -operation CatClusterManager { - input: CatClusterManager_Input, - output: CatClusterManager_Output -} diff --git a/model/cat/cluster_manager/structures.smithy b/model/cat/cluster_manager/structures.smithy deleted file mode 100644 index 5ae18f82..00000000 --- a/model/cat/cluster_manager/structures.smithy +++ /dev/null @@ -1,46 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatClusterManager_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatClusterManager_Input with [CatClusterManager_QueryParams] { -} - -// TODO: Fill in Output Structure -structure CatClusterManager_Output {} diff --git a/model/cat/common_params.smithy b/model/cat/common_params.smithy deleted file mode 100644 index 49ada2e1..00000000 --- a/model/cat/common_params.smithy +++ /dev/null @@ -1,28 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CommonCatQueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("v") - @default(false) - v: V, -} diff --git a/model/cat/count/operations.smithy b/model/cat/count/operations.smithy deleted file mode 100644 index 1ecf161f..00000000 --- a/model/cat/count/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-count/" -) - -@xOperationGroup("cat.count") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/count") -@documentation("Provides quick access to the document count of the entire cluster, or individual indices.") -operation CatCount { - input: CatCount_Input, - output: CatCount_Output -} - -@xOperationGroup("cat.count") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/count/{index}") -@documentation("Provides quick access to the document count of the entire cluster, or individual indices.") -operation CatCount_WithIndex { - input: CatCount_WithIndex_Input, - output: CatCount_Output -} diff --git a/model/cat/count/structures.smithy b/model/cat/count/structures.smithy deleted file mode 100644 index 182f73cb..00000000 --- a/model/cat/count/structures.smithy +++ /dev/null @@ -1,44 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatCount_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatCount_Input with [CatCount_QueryParams] { -} - -@input -structure CatCount_WithIndex_Input with [CatCount_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to limit the returned information.") - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure CatCount_Output {} diff --git a/model/cat/fielddata/operations.smithy b/model/cat/fielddata/operations.smithy deleted file mode 100644 index c8b31a67..00000000 --- a/model/cat/fielddata/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/" -) - -@xOperationGroup("cat.fielddata") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/fielddata") -@documentation("Shows how much heap memory is currently being used by fielddata on every data node in the cluster.") -operation CatFielddata { - input: CatFielddata_Input, - output: CatFielddata_Output -} - -@xOperationGroup("cat.fielddata") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/fielddata/{fields}") -@documentation("Shows how much heap memory is currently being used by fielddata on every data node in the cluster.") -operation CatFielddata_WithFields { - input: CatFielddata_WithFields_Input, - output: CatFielddata_Output -} diff --git a/model/cat/fielddata/structures.smithy b/model/cat/fielddata/structures.smithy deleted file mode 100644 index a34e9821..00000000 --- a/model/cat/fielddata/structures.smithy +++ /dev/null @@ -1,51 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatFielddata_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("bytes") - bytes: Bytes, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("v") - @default(false) - v: V, - - @httpQuery("fields") - @documentation("Comma-separated list of fields to return in the output.") - query_fields: Fields, -} - - -@input -structure CatFielddata_Input with [CatFielddata_QueryParams] { -} - -@input -structure CatFielddata_WithFields_Input with [CatFielddata_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of fields to return the fielddata size.") - fields: PathFields, -} - -// TODO: Fill in Output Structure -structure CatFielddata_Output {} diff --git a/model/cat/health/operations.smithy b/model/cat/health/operations.smithy deleted file mode 100644 index b01accbc..00000000 --- a/model/cat/health/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-health/" -) - -@xOperationGroup("cat.health") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/health") -@documentation("Returns a concise representation of the cluster health.") -operation CatHealth { - input: CatHealth_Input, - output: CatHealth_Output -} diff --git a/model/cat/health/structures.smithy b/model/cat/health/structures.smithy deleted file mode 100644 index 0be8b186..00000000 --- a/model/cat/health/structures.smithy +++ /dev/null @@ -1,43 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatHealth_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("time") - time: Time, - - @httpQuery("ts") - @default(true) - ts: Ts, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatHealth_Input with [CatHealth_QueryParams] { -} - -// TODO: Fill in Output Structure -structure CatHealth_Output {} diff --git a/model/cat/help/operations.smithy b/model/cat/help/operations.smithy deleted file mode 100644 index 29699c1d..00000000 --- a/model/cat/help/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/index/" -) - -@xOperationGroup("cat.help") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat") -@documentation("Returns help for the Cat APIs.") -operation CatHelp { - input: CatHelp_Input, - output: CatHelp_Output -} diff --git a/model/cat/help/structures.smithy b/model/cat/help/structures.smithy deleted file mode 100644 index 91494cc8..00000000 --- a/model/cat/help/structures.smithy +++ /dev/null @@ -1,26 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatHelp_QueryParams { - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, -} - - -@input -structure CatHelp_Input with [CatHelp_QueryParams] { -} - -// TODO: Fill in Output Structure -structure CatHelp_Output {} diff --git a/model/cat/indices/operations.smithy b/model/cat/indices/operations.smithy deleted file mode 100644 index 0babb143..00000000 --- a/model/cat/indices/operations.smithy +++ /dev/null @@ -1,43 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-indices/" -) - -@xOperationGroup("cat.indices") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/indices") -@documentation("Returns information about indices: number of primaries and replicas, document counts, disk size, ...") -operation CatIndices { - input: CatIndices_Input, - output: CatIndices_Output -} - -@xOperationGroup("cat.indices") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/indices/{index}") -@documentation("Returns information about indices: number of primaries and replicas, document counts, disk size, ...") -operation CatIndices_WithIndex { - input: CatIndices_WithIndex_Input, - output: CatIndices_Output -} - -apply CatIndices_WithIndex @examples([ - { - title: "Examples for Cat indices with Index Operation.", - input: { - index: "books", - } - } -]) diff --git a/model/cat/indices/structures.smithy b/model/cat/indices/structures.smithy deleted file mode 100644 index f2cdb19e..00000000 --- a/model/cat/indices/structures.smithy +++ /dev/null @@ -1,79 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatIndices_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("bytes") - bytes: Bytes, - - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("h") - h: H, - - @httpQuery("health") - health: Health, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("pri") - @default(false) - pri: Pri, - - @httpQuery("s") - s: S, - - @httpQuery("time") - time: Time, - - @httpQuery("v") - @default(false) - v: V, - - @httpQuery("include_unloaded_segments") - @default(false) - include_unloaded_segments: IncludeUnloadedSegments, - - @httpQuery("expand_wildcards") - @default("all") - expand_wildcards: ExpandWildcards, -} - - -@input -structure CatIndices_Input with [CatIndices_QueryParams] { -} - -@input -structure CatIndices_WithIndex_Input with [CatIndices_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to limit the returned information.") - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure CatIndices_Output { - // In the Cat Indices API, the dot operator is used to name a few fields. - // Smithy does not yet support this naming standard. - // It needs to be modified once we have support for the dot operator. -} diff --git a/model/cat/master/operations.smithy b/model/cat/master/operations.smithy deleted file mode 100644 index e2b61b1c..00000000 --- a/model/cat/master/operations.smithy +++ /dev/null @@ -1,26 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/" -) - -@deprecated -@xOperationGroup("cat.master") -@xVersionAdded("1.0") -@xDeprecationMessage("To promote inclusive language, please use '/_cat/cluster_manager' instead.") -@xVersionDeprecated("2.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/master") -@documentation("Returns information about the cluster-manager node.") -operation CatMaster { - input: CatMaster_Input, - output: CatMaster_Output -} diff --git a/model/cat/master/structures.smithy b/model/cat/master/structures.smithy deleted file mode 100644 index 21f7666d..00000000 --- a/model/cat/master/structures.smithy +++ /dev/null @@ -1,46 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatMaster_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatMaster_Input with [CatMaster_QueryParams] { -} - -// TODO: Fill in Output Structure -structure CatMaster_Output {} diff --git a/model/cat/nodeattrs/operations.smithy b/model/cat/nodeattrs/operations.smithy deleted file mode 100644 index 43fe7cfe..00000000 --- a/model/cat/nodeattrs/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/" -) - -@xOperationGroup("cat.nodeattrs") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/nodeattrs") -@documentation("Returns information about custom node attributes.") -operation CatNodeattrs { - input: CatNodeattrs_Input, - output: CatNodeattrs_Output -} diff --git a/model/cat/nodeattrs/structures.smithy b/model/cat/nodeattrs/structures.smithy deleted file mode 100644 index 80e87040..00000000 --- a/model/cat/nodeattrs/structures.smithy +++ /dev/null @@ -1,46 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatNodeattrs_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatNodeattrs_Input with [CatNodeattrs_QueryParams] { -} - -// TODO: Fill in Output Structure -structure CatNodeattrs_Output {} diff --git a/model/cat/nodes/operations.smithy b/model/cat/nodes/operations.smithy deleted file mode 100644 index f1ef1c87..00000000 --- a/model/cat/nodes/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/" -) - -@xOperationGroup("cat.nodes") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/nodes") -@documentation("Returns basic statistics about performance of cluster nodes.") -operation CatNodes { - input: CatNodes_Input, - output: CatNodes_Output -} diff --git a/model/cat/nodes/structures.smithy b/model/cat/nodes/structures.smithy deleted file mode 100644 index f6aaf638..00000000 --- a/model/cat/nodes/structures.smithy +++ /dev/null @@ -1,63 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatNodes_QueryParams { - @httpQuery("bytes") - bytes: Bytes, - - @httpQuery("format") - format: Format, - - @httpQuery("full_id") - @default(false) - full_id: FullId, - - @httpQuery("local") - @default(false) - @deprecated - @xDeprecationMessage("This parameter does not cause this API to act locally.") - @xVersionDeprecated("1.0") - local: Local, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("time") - time: Time, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatNodes_Input with [CatNodes_QueryParams] { -} - -// TODO: Fill in Output Structure -structure CatNodes_Output { - // In the Cat Nodes API, the dot operator is used to name a few fields. - // Smithy does not yet support this naming standard. - // It needs to be modified once we have support for the dot operator. -} diff --git a/model/cat/pending_tasks/operations.smithy b/model/cat/pending_tasks/operations.smithy deleted file mode 100644 index 4e710595..00000000 --- a/model/cat/pending_tasks/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/" -) - -@xOperationGroup("cat.pending_tasks") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/pending_tasks") -@documentation("Returns a concise representation of the cluster pending tasks.") -operation CatPendingTasks { - input: CatPendingTasks_Input, - output: CatPendingTasks_Output -} diff --git a/model/cat/pending_tasks/structures.smithy b/model/cat/pending_tasks/structures.smithy deleted file mode 100644 index 5614fffc..00000000 --- a/model/cat/pending_tasks/structures.smithy +++ /dev/null @@ -1,49 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatPendingTasks_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("time") - time: Time, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatPendingTasks_Input with [CatPendingTasks_QueryParams] { -} - -// TODO: Fill in Output Structure -structure CatPendingTasks_Output {} diff --git a/model/cat/pit_segments/operations.smithy b/model/cat/pit_segments/operations.smithy deleted file mode 100644 index 3e5bbd2b..00000000 --- a/model/cat/pit_segments/operations.smithy +++ /dev/null @@ -1,36 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/" -) -@xOperationGroup("cat.pit_segments") -@xVersionAdded("2.4") -@readonly -@suppress(["HttpUriConflict", "HttpMethodSemantics.UnexpectedPayload"]) -@http(method: "GET", uri: "/_cat/pit_segments") -@documentation("List segments for one or several PITs.") -operation CatPitSegments { - input: CatPitSegments_Input, - output: CatPitSegments_Output -} - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/point-in-time-api/" -) -@xOperationGroup("cat.all_pit_segments") -@xVersionAdded("2.4") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/pit_segments/_all") -@documentation("Lists all active point-in-time segments.") -operation CatAllPitSegments { - input: CatAllPitSegments_Input, - output: CatAllPitSegments_Output -} diff --git a/model/cat/pit_segments/structures.smithy b/model/cat/pit_segments/structures.smithy deleted file mode 100644 index ff25f460..00000000 --- a/model/cat/pit_segments/structures.smithy +++ /dev/null @@ -1,69 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatPitSegments_QueryParams with [CommonCatQueryParams] { - @httpQuery("bytes") - bytes: Bytes -} - -structure CatPitSegments_BodyParams { - @required - pit_id: PitIds -} - -list PitIds{ - member: String -} - -@input -structure CatPitSegments_Input with [CatPitSegments_QueryParams] { - @httpPayload - content: CatPitSegments_BodyParams -} - -@input -structure CatAllPitSegments_Input with [CatPitSegments_QueryParams] { -} - -@output -structure CatPitSegments_Output { - @httpPayload - content: CatPitSegmentsRecords -} - -@output -structure CatAllPitSegments_Output { - @httpPayload - content: CatPitSegmentsRecords -} - -list CatPitSegmentsRecords { - member: CatPitSegmentsRecord -} - -structure CatPitSegmentsRecord { - index: String, - shard: String, - prirep: String, - ip: String, - segment: String, - generation: String, - @jsonName("docs.count") - docs_count: String, - @jsonName("docs.deleted") - docs_deleted: String, - size: String, - @jsonName("size.memory") - size_memory: String, - committed: String, - searchable: String, - version: String, - compound: String, -} diff --git a/model/cat/plugins/operations.smithy b/model/cat/plugins/operations.smithy deleted file mode 100644 index a06512d1..00000000 --- a/model/cat/plugins/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/" -) - -@xOperationGroup("cat.plugins") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/plugins") -@documentation("Returns information about installed plugins across nodes node.") -operation CatPlugins { - input: CatPlugins_Input, - output: CatPlugins_Output -} diff --git a/model/cat/plugins/structures.smithy b/model/cat/plugins/structures.smithy deleted file mode 100644 index 900075fd..00000000 --- a/model/cat/plugins/structures.smithy +++ /dev/null @@ -1,46 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatPlugins_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatPlugins_Input with [CatPlugins_QueryParams] { -} - -// TODO: Fill in Output Structure -structure CatPlugins_Output {} diff --git a/model/cat/recovery/operations.smithy b/model/cat/recovery/operations.smithy deleted file mode 100644 index 75f49cb0..00000000 --- a/model/cat/recovery/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/" -) - -@xOperationGroup("cat.recovery") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/recovery") -@documentation("Returns information about index shard recoveries, both on-going completed.") -operation CatRecovery { - input: CatRecovery_Input, - output: CatRecovery_Output -} - -@xOperationGroup("cat.recovery") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/recovery/{index}") -@documentation("Returns information about index shard recoveries, both on-going completed.") -operation CatRecovery_WithIndex { - input: CatRecovery_WithIndex_Input, - output: CatRecovery_Output -} diff --git a/model/cat/recovery/structures.smithy b/model/cat/recovery/structures.smithy deleted file mode 100644 index 9cb6c831..00000000 --- a/model/cat/recovery/structures.smithy +++ /dev/null @@ -1,64 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatRecovery_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("active_only") - @documentation("If `true`, the response only includes ongoing shard recoveries.") - @default(false) - active_only: ActiveOnly, - - @httpQuery("bytes") - bytes: Bytes, - - @httpQuery("detailed") - @documentation("If `true`, the response includes detailed information about shard recoveries.") - @default(false) - detailed: Detailed, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("index") - @documentation("Comma-separated list or wildcard expression of index names to limit the returned information.") - query_index: Indices, - - @httpQuery("s") - s: S, - - @httpQuery("time") - time: Time, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatRecovery_Input with [CatRecovery_QueryParams] { -} - -@input -structure CatRecovery_WithIndex_Input with [CatRecovery_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list or wildcard expression of index names to limit the returned information.") - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure CatRecovery_Output {} diff --git a/model/cat/repositories/operations.smithy b/model/cat/repositories/operations.smithy deleted file mode 100644 index 2078f452..00000000 --- a/model/cat/repositories/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/" -) - -@xOperationGroup("cat.repositories") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/repositories") -@documentation("Returns information about snapshot repositories registered in the cluster.") -operation CatRepositories { - input: CatRepositories_Input, - output: CatRepositories_Output -} diff --git a/model/cat/repositories/structures.smithy b/model/cat/repositories/structures.smithy deleted file mode 100644 index 37fd6f4e..00000000 --- a/model/cat/repositories/structures.smithy +++ /dev/null @@ -1,46 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatRepositories_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatRepositories_Input with [CatRepositories_QueryParams] { -} - -// TODO: Fill in Output Structure -structure CatRepositories_Output {} diff --git a/model/cat/segment_replication/operations.smithy b/model/cat/segment_replication/operations.smithy deleted file mode 100644 index f003c8a1..00000000 --- a/model/cat/segment_replication/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/" -) - -@xOperationGroup("cat.segment_replication") -@xVersionAdded("2.6.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/segment_replication") -@documentation("Returns information about both on-going and latest completed Segment Replication events.") -operation CatSegmentReplication { - input: CatSegmentReplication_Input, - output: CatSegmentReplication_Output -} - -@xOperationGroup("cat.segment_replication") -@xVersionAdded("2.6.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/segment_replication/{index}") -@documentation("Returns information about both on-going and latest completed Segment Replication events.") -operation CatSegmentReplication_WithIndex { - input: CatSegmentReplication_WithIndex_Input, - output: CatSegmentReplication_Output -} diff --git a/model/cat/segment_replication/structures.smithy b/model/cat/segment_replication/structures.smithy deleted file mode 100644 index 0fc33c6b..00000000 --- a/model/cat/segment_replication/structures.smithy +++ /dev/null @@ -1,95 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatSegmentReplication_QueryParams with [ - CommonCatQueryParams, - IndicesOptionsQueryParams, -] { - @httpQuery("active_only") - @documentation("If `true`, the response only includes ongoing segment replication events.") - @default(false) - active_only: ActiveOnly, - - @httpQuery("completed_only") - @default(false) - completed_only: CompletedOnly, - - @httpQuery("bytes") - bytes: Bytes, - - @httpQuery("detailed") - @documentation("If `true`, the response includes detailed information about segment replications.") - @default(false) - detailed: Detailed, - - @httpQuery("shards") - shards: Shards, - - @httpQuery("index") - @documentation("Comma-separated list or wildcard expression of index names to limit the returned information.") - query_index: Indices, - - @httpQuery("time") - time: Time, - - @httpQuery("timeout") - timeout: Timeout, -} - - -@input -structure CatSegmentReplication_Input with [CatSegmentReplication_QueryParams] { -} - -@input -structure CatSegmentReplication_WithIndex_Input with [CatSegmentReplication_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list or wildcard expression of index names to limit the returned information.") - index: PathIndices, -} - -structure CatSegmentReplication_Output { - @httpPayload - content: CatSegmentReplicationRecords -} - -list CatSegmentReplicationRecords { - member: CatSegmentReplicationRecord -} - -structure CatSegmentReplicationRecord { - shardId: String, - target_node: String, - target_host: String, - checkpoints_behind: String, - bytes_behind: String, - current_lag: String, - last_completed_lag: String, - rejected_requests: String, - - stage: String, - time: String, - files_fetched: String, - files_percent: String, - bytes_fetched: String, - bytes_percent: String, - start_time: String, - stop_time: String, - files: String, - files_total: String, - bytes: String, - bytes_total: String, - replicating_stage_time_taken: String, - get_checkpoint_info_stage_time_taken: String, - file_diff_stage_time_taken: String, - get_files_stage_time_taken: String, - finalize_replication_stage_time_taken: String, -} diff --git a/model/cat/segments/operations.smithy b/model/cat/segments/operations.smithy deleted file mode 100644 index 89526736..00000000 --- a/model/cat/segments/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-segments/" -) - -@xOperationGroup("cat.segments") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/segments") -@documentation("Provides low-level information about the segments in the shards of an index.") -operation CatSegments { - input: CatSegments_Input, - output: CatSegments_Output -} - -@xOperationGroup("cat.segments") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/segments/{index}") -@documentation("Provides low-level information about the segments in the shards of an index.") -operation CatSegments_WithIndex { - input: CatSegments_WithIndex_Input, - output: CatSegments_Output -} diff --git a/model/cat/segments/structures.smithy b/model/cat/segments/structures.smithy deleted file mode 100644 index a0566855..00000000 --- a/model/cat/segments/structures.smithy +++ /dev/null @@ -1,53 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatSegments_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("bytes") - bytes: Bytes, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatSegments_Input with [CatSegments_QueryParams] { -} - -@input -structure CatSegments_WithIndex_Input with [CatSegments_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to limit the returned information.") - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure CatSegments_Output {} diff --git a/model/cat/shards/operations.smithy b/model/cat/shards/operations.smithy deleted file mode 100644 index 9cbb77d2..00000000 --- a/model/cat/shards/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-shards/" -) - -@xOperationGroup("cat.shards") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/shards") -@documentation("Provides a detailed view of shard allocation on nodes.") -operation CatShards { - input: CatShards_Input, - output: CatShards_Output -} - -@xOperationGroup("cat.shards") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/shards/{index}") -@documentation("Provides a detailed view of shard allocation on nodes.") -operation CatShards_WithIndex { - input: CatShards_WithIndex_Input, - output: CatShards_Output -} diff --git a/model/cat/shards/structures.smithy b/model/cat/shards/structures.smithy deleted file mode 100644 index b604893d..00000000 --- a/model/cat/shards/structures.smithy +++ /dev/null @@ -1,60 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatShards_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("bytes") - bytes: Bytes, - - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("time") - time: Time, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatShards_Input with [CatShards_QueryParams] { -} - -@input -structure CatShards_WithIndex_Input with [CatShards_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to limit the returned information.") - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure CatShards_Output {} diff --git a/model/cat/snapshots/operations.smithy b/model/cat/snapshots/operations.smithy deleted file mode 100644 index 7f616c51..00000000 --- a/model/cat/snapshots/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/" -) - -@xOperationGroup("cat.snapshots") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/snapshots") -@documentation("Returns all snapshots in a specific repository.") -operation CatSnapshots { - input: CatSnapshots_Input, - output: CatSnapshots_Output -} - -@xOperationGroup("cat.snapshots") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/snapshots/{repository}") -@documentation("Returns all snapshots in a specific repository.") -operation CatSnapshots_WithRepository { - input: CatSnapshots_WithRepository_Input, - output: CatSnapshots_Output -} diff --git a/model/cat/snapshots/structures.smithy b/model/cat/snapshots/structures.smithy deleted file mode 100644 index d1640309..00000000 --- a/model/cat/snapshots/structures.smithy +++ /dev/null @@ -1,56 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatSnapshots_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("ignore_unavailable") - @default(false) - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("time") - time: Time, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatSnapshots_Input with [CatSnapshots_QueryParams] { -} - -@input -structure CatSnapshots_WithRepository_Input with [CatSnapshots_QueryParams] { - @required - @httpLabel - repository: PathRepositories, -} - -// TODO: Fill in Output Structure -structure CatSnapshots_Output {} diff --git a/model/cat/tasks/operations.smithy b/model/cat/tasks/operations.smithy deleted file mode 100644 index 7e142943..00000000 --- a/model/cat/tasks/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/" -) - -@xOperationGroup("cat.tasks") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/tasks") -@documentation("Returns information about the tasks currently executing on one or more nodes in the cluster.") -operation CatTasks { - input: CatTasks_Input, - output: CatTasks_Output -} diff --git a/model/cat/tasks/structures.smithy b/model/cat/tasks/structures.smithy deleted file mode 100644 index 81cc340c..00000000 --- a/model/cat/tasks/structures.smithy +++ /dev/null @@ -1,55 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatTasks_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("nodes") - nodes: Nodes, - - @httpQuery("actions") - @documentation("Comma-separated list of actions that should be returned. Leave empty to return all.") - actions: Actions, - - @httpQuery("detailed") - @documentation("Return detailed task information.") - @default(false) - detailed: Detailed, - - @httpQuery("parent_task_id") - @documentation("Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.") - parent_task_id: ParentTaskId, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("time") - time: Time, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatTasks_Input with [CatTasks_QueryParams] { -} - -// TODO: Fill in Output Structure -structure CatTasks_Output {} diff --git a/model/cat/templates/operations.smithy b/model/cat/templates/operations.smithy deleted file mode 100644 index 7288d73f..00000000 --- a/model/cat/templates/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-templates/" -) - -@xOperationGroup("cat.templates") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/templates") -@documentation("Returns information about existing templates.") -operation CatTemplates { - input: CatTemplates_Input, - output: CatTemplates_Output -} - -@xOperationGroup("cat.templates") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/templates/{name}") -@documentation("Returns information about existing templates.") -operation CatTemplates_WithName { - input: CatTemplates_WithName_Input, - output: CatTemplates_Output -} diff --git a/model/cat/templates/structures.smithy b/model/cat/templates/structures.smithy deleted file mode 100644 index d8567a38..00000000 --- a/model/cat/templates/structures.smithy +++ /dev/null @@ -1,53 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatTemplates_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatTemplates_Input with [CatTemplates_QueryParams] { -} - -@input -structure CatTemplates_WithName_Input with [CatTemplates_QueryParams] { - @required - @httpLabel - name: PathTemplateName, -} - -// TODO: Fill in Output Structure -structure CatTemplates_Output {} diff --git a/model/cat/thread_pool/operations.smithy b/model/cat/thread_pool/operations.smithy deleted file mode 100644 index f3e74364..00000000 --- a/model/cat/thread_pool/operations.smithy +++ /dev/null @@ -1,36 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/" -) - -@xOperationGroup("cat.thread_pool") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/thread_pool") -@documentation("Returns cluster-wide thread pool statistics per node. -By default the active, queue and rejected statistics are returned for all thread pools.") -operation CatThreadPool { - input: CatThreadPool_Input, - output: CatThreadPool_Output -} - -@xOperationGroup("cat.thread_pool") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cat/thread_pool/{thread_pool_patterns}") -@documentation("Returns cluster-wide thread pool statistics per node. -By default the active, queue and rejected statistics are returned for all thread pools.") -operation CatThreadPool_WithThreadPoolPatterns { - input: CatThreadPool_WithThreadPoolPatterns_Input, - output: CatThreadPool_Output -} diff --git a/model/cat/thread_pool/structures.smithy b/model/cat/thread_pool/structures.smithy deleted file mode 100644 index abab86ad..00000000 --- a/model/cat/thread_pool/structures.smithy +++ /dev/null @@ -1,57 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure CatThreadPool_QueryParams { - @httpQuery("format") - format: Format, - - @httpQuery("size") - @documentation("The multiplier in which to display values.") - size: Size, - - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("h") - h: H, - - @httpQuery("help") - @default(false) - help: Help, - - @httpQuery("s") - s: S, - - @httpQuery("v") - @default(false) - v: V, -} - - -@input -structure CatThreadPool_Input with [CatThreadPool_QueryParams] { -} - -@input -structure CatThreadPool_WithThreadPoolPatterns_Input with [CatThreadPool_QueryParams] { - @required - @httpLabel - thread_pool_patterns: PathThreadPoolPatterns, -} - -// TODO: Fill in Output Structure -structure CatThreadPool_Output {} diff --git a/model/cluster/allocation_explain/operations.smithy b/model/cluster/allocation_explain/operations.smithy deleted file mode 100644 index e1b9ed61..00000000 --- a/model/cluster/allocation_explain/operations.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/" -) - -@xOperationGroup("cluster.allocation_explain") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cluster/allocation/explain") -@documentation("Provides explanations for shard allocations in the cluster.") -operation ClusterAllocationExplain_Get { - input: ClusterAllocationExplain_Get_Input, - output: ClusterAllocationExplain_Output -} - -@xOperationGroup("cluster.allocation_explain") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_cluster/allocation/explain") -@documentation("Provides explanations for shard allocations in the cluster.") -operation ClusterAllocationExplain_Post { - input: ClusterAllocationExplain_Post_Input, - output: ClusterAllocationExplain_Output -} diff --git a/model/cluster/allocation_explain/structures.smithy b/model/cluster/allocation_explain/structures.smithy deleted file mode 100644 index 6e58b5bf..00000000 --- a/model/cluster/allocation_explain/structures.smithy +++ /dev/null @@ -1,36 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterAllocationExplain_QueryParams { - @httpQuery("include_yes_decisions") - @default(false) - include_yes_decisions: IncludeYesDecisions, - - @httpQuery("include_disk_info") - @default(false) - include_disk_info: IncludeDiskInfo, -} - -// TODO: Fill in Body Parameters -@documentation("The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'") -structure ClusterAllocationExplain_BodyParams {} - -@input -structure ClusterAllocationExplain_Get_Input with [ClusterAllocationExplain_QueryParams] { -} - -@input -structure ClusterAllocationExplain_Post_Input with [ClusterAllocationExplain_QueryParams] { - @httpPayload - content: ClusterAllocationExplain_BodyParams, -} - -// TODO: Fill in Output Structure -structure ClusterAllocationExplain_Output {} diff --git a/model/cluster/delete_component_template/operations.smithy b/model/cluster/delete_component_template/operations.smithy deleted file mode 100644 index 06a871e1..00000000 --- a/model/cluster/delete_component_template/operations.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("cluster.delete_component_template") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_component_template/{name}") -@documentation("Deletes a component template.") -operation ClusterDeleteComponentTemplate { - input: ClusterDeleteComponentTemplate_Input, - output: ClusterDeleteComponentTemplate_Output -} diff --git a/model/cluster/delete_component_template/structures.smithy b/model/cluster/delete_component_template/structures.smithy deleted file mode 100644 index aa149f28..00000000 --- a/model/cluster/delete_component_template/structures.smithy +++ /dev/null @@ -1,31 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterDeleteComponentTemplate_QueryParams { - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - - -@input -structure ClusterDeleteComponentTemplate_Input with [ClusterDeleteComponentTemplate_QueryParams] { - @required - @httpLabel - name: PathTemplateName, -} - -// TODO: Fill in Output Structure -structure ClusterDeleteComponentTemplate_Output {} diff --git a/model/cluster/delete_decommission_awareness/operations.smithy b/model/cluster/delete_decommission_awareness/operations.smithy deleted file mode 100644 index 78caee21..00000000 --- a/model/cluster/delete_decommission_awareness/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone" -) - -@xOperationGroup("cluster.delete_decommission_awareness") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_cluster/decommission/awareness") -@documentation("Delete any existing decommission.") -operation ClusterDeleteDecommissionAwareness { - input: ClusterDeleteDecommissionAwareness_Input, - output: ClusterDeleteDecommissionAwareness_Output -} diff --git a/model/cluster/delete_decommission_awareness/structures.smithy b/model/cluster/delete_decommission_awareness/structures.smithy deleted file mode 100644 index 8c13bce1..00000000 --- a/model/cluster/delete_decommission_awareness/structures.smithy +++ /dev/null @@ -1,20 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterDeleteDecommissionAwareness_QueryParams { -} - - -@input -structure ClusterDeleteDecommissionAwareness_Input with [ClusterDeleteDecommissionAwareness_QueryParams] { -} - -// TODO: Fill in Output Structure -structure ClusterDeleteDecommissionAwareness_Output {} diff --git a/model/cluster/delete_voting_config_exclusions/operations.smithy b/model/cluster/delete_voting_config_exclusions/operations.smithy deleted file mode 100644 index df7427fe..00000000 --- a/model/cluster/delete_voting_config_exclusions/operations.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("cluster.delete_voting_config_exclusions") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_cluster/voting_config_exclusions") -@documentation("Clears cluster voting config exclusions.") -operation ClusterDeleteVotingConfigExclusions { - input: ClusterDeleteVotingConfigExclusions_Input, - output: ClusterDeleteVotingConfigExclusions_Output -} diff --git a/model/cluster/delete_voting_config_exclusions/structures.smithy b/model/cluster/delete_voting_config_exclusions/structures.smithy deleted file mode 100644 index 8bbb8543..00000000 --- a/model/cluster/delete_voting_config_exclusions/structures.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterDeleteVotingConfigExclusions_QueryParams { - @httpQuery("wait_for_removal") - @default(true) - wait_for_removal: WaitForRemoval, -} - - -@input -structure ClusterDeleteVotingConfigExclusions_Input with [ClusterDeleteVotingConfigExclusions_QueryParams] { -} - -// TODO: Fill in Output Structure -structure ClusterDeleteVotingConfigExclusions_Output {} diff --git a/model/cluster/delete_weighted_routing/operations.smithy b/model/cluster/delete_weighted_routing/operations.smithy deleted file mode 100644 index 8709d207..00000000 --- a/model/cluster/delete_weighted_routing/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-deleting-weights" -) - -@xOperationGroup("cluster.delete_weighted_routing") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_cluster/routing/awareness/weights") -@documentation("Delete weighted shard routing weights.") -operation ClusterDeleteWeightedRouting { - input: ClusterDeleteWeightedRouting_Input, - output: ClusterDeleteWeightedRouting_Output -} diff --git a/model/cluster/delete_weighted_routing/structures.smithy b/model/cluster/delete_weighted_routing/structures.smithy deleted file mode 100644 index 14704a9a..00000000 --- a/model/cluster/delete_weighted_routing/structures.smithy +++ /dev/null @@ -1,20 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterDeleteWeightedRouting_QueryParams { -} - - -@input -structure ClusterDeleteWeightedRouting_Input with [ClusterDeleteWeightedRouting_QueryParams] { -} - -// TODO: Fill in Output Structure -structure ClusterDeleteWeightedRouting_Output {} diff --git a/model/cluster/exists_component_template/operations.smithy b/model/cluster/exists_component_template/operations.smithy deleted file mode 100644 index 35dc8357..00000000 --- a/model/cluster/exists_component_template/operations.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("cluster.exists_component_template") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@readonly -@http(method: "HEAD", uri: "/_component_template/{name}") -@documentation("Returns information about whether a particular component template exist.") -operation ClusterExistsComponentTemplate { - input: ClusterExistsComponentTemplate_Input, - output: ClusterExistsComponentTemplate_Output -} diff --git a/model/cluster/exists_component_template/structures.smithy b/model/cluster/exists_component_template/structures.smithy deleted file mode 100644 index d41e9bcc..00000000 --- a/model/cluster/exists_component_template/structures.smithy +++ /dev/null @@ -1,32 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterExistsComponentTemplate_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("local") - @default(false) - local: Local, -} - - -@input -structure ClusterExistsComponentTemplate_Input with [ClusterExistsComponentTemplate_QueryParams] { - @required - @httpLabel - name: PathTemplateName, -} - -// TODO: Fill in Output Structure -structure ClusterExistsComponentTemplate_Output {} diff --git a/model/cluster/get_component_template/operations.smithy b/model/cluster/get_component_template/operations.smithy deleted file mode 100644 index f207f8d4..00000000 --- a/model/cluster/get_component_template/operations.smithy +++ /dev/null @@ -1,35 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("cluster.get_component_template") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_component_template") -@documentation("Returns one or more component templates.") -operation ClusterGetComponentTemplate { - input: ClusterGetComponentTemplate_Input, - output: ClusterGetComponentTemplate_Output -} - -@xOperationGroup("cluster.get_component_template") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_component_template/{name}") -@documentation("Returns one or more component templates.") -operation ClusterGetComponentTemplate_WithName { - input: ClusterGetComponentTemplate_WithName_Input, - output: ClusterGetComponentTemplate_Output -} diff --git a/model/cluster/get_component_template/structures.smithy b/model/cluster/get_component_template/structures.smithy deleted file mode 100644 index 58b02c23..00000000 --- a/model/cluster/get_component_template/structures.smithy +++ /dev/null @@ -1,36 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterGetComponentTemplate_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("local") - @default(false) - local: Local, -} - - -@input -structure ClusterGetComponentTemplate_Input with [ClusterGetComponentTemplate_QueryParams] { -} - -@input -structure ClusterGetComponentTemplate_WithName_Input with [ClusterGetComponentTemplate_QueryParams] { - @required - @httpLabel - name: PathComponentTemplateNames, -} - -// TODO: Fill in Output Structure -structure ClusterGetComponentTemplate_Output {} diff --git a/model/cluster/get_decommission_awareness/operations.smithy b/model/cluster/get_decommission_awareness/operations.smithy deleted file mode 100644 index 4f3d754d..00000000 --- a/model/cluster/get_decommission_awareness/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-getting-zone-decommission-status" -) - -@xOperationGroup("cluster.get_decommission_awareness") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cluster/decommission/awareness/{awareness_attribute_name}/_status") -@documentation("Get details and status of decommissioned attribute.") -operation ClusterGetDecommissionAwareness { - input: ClusterGetDecommissionAwareness_Input, - output: ClusterGetDecommissionAwareness_Output -} diff --git a/model/cluster/get_decommission_awareness/structures.smithy b/model/cluster/get_decommission_awareness/structures.smithy deleted file mode 100644 index 5121e1ce..00000000 --- a/model/cluster/get_decommission_awareness/structures.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterGetDecommissionAwareness_QueryParams { -} - - -@input -structure ClusterGetDecommissionAwareness_Input with [ClusterGetDecommissionAwareness_QueryParams] { - @required - @httpLabel - awareness_attribute_name: PathAwarenessAttributeName, -} - -// TODO: Fill in Output Structure -structure ClusterGetDecommissionAwareness_Output {} diff --git a/model/cluster/get_settings/operations.smithy b/model/cluster/get_settings/operations.smithy deleted file mode 100644 index 031b5a2b..00000000 --- a/model/cluster/get_settings/operations.smithy +++ /dev/null @@ -1,32 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/" -) - -@xOperationGroup("cluster.get_settings") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cluster/settings") -@documentation("Returns cluster settings.") -operation ClusterGetSettings { - input: ClusterGetSettings_Input, - output: ClusterGetSettings_Output -} - -apply ClusterGetSettings @examples([ - { - title: "Examples for Get cluster settings Operation.", - input: { - include_defaults: true - } - } -]) diff --git a/model/cluster/get_settings/structures.smithy b/model/cluster/get_settings/structures.smithy deleted file mode 100644 index 6947e488..00000000 --- a/model/cluster/get_settings/structures.smithy +++ /dev/null @@ -1,42 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterGetSettings_QueryParams { - @httpQuery("flat_settings") - @default(false) - flat_settings: FlatSettings, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("include_defaults") - @documentation("Whether to return all default clusters setting.") - @default(false) - include_defaults: IncludeDefaults, -} - - -@input -structure ClusterGetSettings_Input with [ClusterGetSettings_QueryParams] { -} - -structure ClusterGetSettings_Output { - persistent: UserDefinedValueMap, - - transient: UserDefinedValueMap, - - defaults: UserDefinedValueMap, -} diff --git a/model/cluster/get_weighted_routing/operations.smithy b/model/cluster/get_weighted_routing/operations.smithy deleted file mode 100644 index b8c4c396..00000000 --- a/model/cluster/get_weighted_routing/operations.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-getting-weights-for-all-zones" -) - -@xOperationGroup("cluster.get_weighted_routing") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cluster/routing/awareness/{attribute}/weights") -@documentation("Fetches weighted shard routing weights.") -operation ClusterGetWeightedRouting { - input: ClusterGetWeightedRouting_Input, - output: ClusterGetWeightedRouting_Output -} diff --git a/model/cluster/get_weighted_routing/structures.smithy b/model/cluster/get_weighted_routing/structures.smithy deleted file mode 100644 index 138384ad..00000000 --- a/model/cluster/get_weighted_routing/structures.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterGetWeightedRouting_QueryParams { -} - - -@input -structure ClusterGetWeightedRouting_Input with [ClusterGetWeightedRouting_QueryParams] { - @required - @httpLabel - attribute: PathAttribute, -} - -// TODO: Fill in Output Structure -structure ClusterGetWeightedRouting_Output {} diff --git a/model/cluster/health/operations.smithy b/model/cluster/health/operations.smithy deleted file mode 100644 index 272b249a..00000000 --- a/model/cluster/health/operations.smithy +++ /dev/null @@ -1,35 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/" -) - -@xOperationGroup("cluster.health") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cluster/health") -@documentation("Returns basic information about the health of the cluster.") -operation ClusterHealth { - input: ClusterHealth_Input, - output: ClusterHealth_Output -} - -@xOperationGroup("cluster.health") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cluster/health/{index}") -@documentation("Returns basic information about the health of the cluster.") -operation ClusterHealth_WithIndex { - input: ClusterHealth_WithIndex_Input, - output: ClusterHealth_Output -} diff --git a/model/cluster/health/structures.smithy b/model/cluster/health/structures.smithy deleted file mode 100644 index 577806a3..00000000 --- a/model/cluster/health/structures.smithy +++ /dev/null @@ -1,70 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterHealth_QueryParams { - @httpQuery("expand_wildcards") - @default("all") - expand_wildcards: ExpandWildcards, - - @httpQuery("level") - @default("cluster") - level: ClusterHealthLevel, - - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("wait_for_active_shards") - @documentation("Wait until the specified number of shards is active.") - wait_for_active_shards: WaitForActiveShards, - - @httpQuery("wait_for_nodes") - wait_for_nodes: WaitForNodes, - - @httpQuery("wait_for_events") - wait_for_events: WaitForEvents, - - @httpQuery("wait_for_no_relocating_shards") - wait_for_no_relocating_shards: WaitForNoRelocatingShards, - - @httpQuery("wait_for_no_initializing_shards") - wait_for_no_initializing_shards: WaitForNoInitializingShards, - - @httpQuery("wait_for_status") - wait_for_status: WaitForStatus, - - @httpQuery("awareness_attribute") - awareness_attribute: AwarenessAttribute, -} - - -@input -structure ClusterHealth_Input with [ClusterHealth_QueryParams] { -} - -@input -structure ClusterHealth_WithIndex_Input with [ClusterHealth_QueryParams] { - @required - @httpLabel - @documentation("Limit the information returned to specific indicies.") - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure ClusterHealth_Output {} diff --git a/model/cluster/pending_tasks/operations.smithy b/model/cluster/pending_tasks/operations.smithy deleted file mode 100644 index f1021b31..00000000 --- a/model/cluster/pending_tasks/operations.smithy +++ /dev/null @@ -1,25 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("cluster.pending_tasks") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cluster/pending_tasks") -@documentation("Returns a list of any cluster-level changes (e.g. create index, update mapping, -allocate or fail shard) which have not yet been executed.") -operation ClusterPendingTasks { - input: ClusterPendingTasks_Input, - output: ClusterPendingTasks_Output -} diff --git a/model/cluster/pending_tasks/structures.smithy b/model/cluster/pending_tasks/structures.smithy deleted file mode 100644 index ebb3adb3..00000000 --- a/model/cluster/pending_tasks/structures.smithy +++ /dev/null @@ -1,29 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterPendingTasks_QueryParams { - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - - -@input -structure ClusterPendingTasks_Input with [ClusterPendingTasks_QueryParams] { -} - -// TODO: Fill in Output Structure -structure ClusterPendingTasks_Output {} diff --git a/model/cluster/post_voting_config_exclusions/operations.smithy b/model/cluster/post_voting_config_exclusions/operations.smithy deleted file mode 100644 index 5dd8cfd4..00000000 --- a/model/cluster/post_voting_config_exclusions/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("cluster.post_voting_config_exclusions") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_cluster/voting_config_exclusions") -@documentation("Updates the cluster voting config exclusions by node ids or node names.") -operation ClusterPostVotingConfigExclusions { - input: ClusterPostVotingConfigExclusions_Input, - output: ClusterPostVotingConfigExclusions_Output -} diff --git a/model/cluster/post_voting_config_exclusions/structures.smithy b/model/cluster/post_voting_config_exclusions/structures.smithy deleted file mode 100644 index 7bd2e8b8..00000000 --- a/model/cluster/post_voting_config_exclusions/structures.smithy +++ /dev/null @@ -1,28 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterPostVotingConfigExclusions_QueryParams { - @httpQuery("node_ids") - node_ids: NodeIds, - - @httpQuery("node_names") - node_names: NodeNames, - - @httpQuery("timeout") - timeout: Timeout, -} - - -@input -structure ClusterPostVotingConfigExclusions_Input with [ClusterPostVotingConfigExclusions_QueryParams] { -} - -// TODO: Fill in Output Structure -structure ClusterPostVotingConfigExclusions_Output {} diff --git a/model/cluster/put_component_template/operations.smithy b/model/cluster/put_component_template/operations.smithy deleted file mode 100644 index 362b4d31..00000000 --- a/model/cluster/put_component_template/operations.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template" -) - -@xOperationGroup("cluster.put_component_template") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_component_template/{name}") -@documentation("Creates or updates a component template.") -operation ClusterPutComponentTemplate_Put { - input: ClusterPutComponentTemplate_Put_Input, - output: ClusterPutComponentTemplate_Output -} - -@xOperationGroup("cluster.put_component_template") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_component_template/{name}") -@documentation("Creates or updates a component template.") -operation ClusterPutComponentTemplate_Post { - input: ClusterPutComponentTemplate_Post_Input, - output: ClusterPutComponentTemplate_Output -} diff --git a/model/cluster/put_component_template/structures.smithy b/model/cluster/put_component_template/structures.smithy deleted file mode 100644 index 919e8199..00000000 --- a/model/cluster/put_component_template/structures.smithy +++ /dev/null @@ -1,51 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterPutComponentTemplate_QueryParams { - @httpQuery("create") - @default(false) - create: Create, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - -// TODO: Fill in Body Parameters -@documentation("The template definition") -structure ClusterPutComponentTemplate_BodyParams {} - -@input -structure ClusterPutComponentTemplate_Put_Input with [ClusterPutComponentTemplate_QueryParams] { - @required - @httpLabel - name: PathTemplateName, - @required - @httpPayload - content: ClusterPutComponentTemplate_BodyParams, -} - -@input -structure ClusterPutComponentTemplate_Post_Input with [ClusterPutComponentTemplate_QueryParams] { - @required - @httpLabel - name: PathTemplateName, - @required - @httpPayload - content: ClusterPutComponentTemplate_BodyParams, -} - -// TODO: Fill in Output Structure -structure ClusterPutComponentTemplate_Output {} diff --git a/model/cluster/put_decommission_awareness/operations.smithy b/model/cluster/put_decommission_awareness/operations.smithy deleted file mode 100644 index bc244ff8..00000000 --- a/model/cluster/put_decommission_awareness/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone" -) - -@xOperationGroup("cluster.put_decommission_awareness") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}") -@documentation("Decommissions an awareness attribute.") -operation ClusterPutDecommissionAwareness { - input: ClusterPutDecommissionAwareness_Input, - output: ClusterPutDecommissionAwareness_Output -} diff --git a/model/cluster/put_decommission_awareness/structures.smithy b/model/cluster/put_decommission_awareness/structures.smithy deleted file mode 100644 index e680802a..00000000 --- a/model/cluster/put_decommission_awareness/structures.smithy +++ /dev/null @@ -1,27 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterPutDecommissionAwareness_QueryParams { -} - - -@input -structure ClusterPutDecommissionAwareness_Input with [ClusterPutDecommissionAwareness_QueryParams] { - @required - @httpLabel - awareness_attribute_name: PathAwarenessAttributeName, - - @required - @httpLabel - awareness_attribute_value: PathAwarenessAttributeValue, -} - -// TODO: Fill in Output Structure -structure ClusterPutDecommissionAwareness_Output {} diff --git a/model/cluster/put_settings/operations.smithy b/model/cluster/put_settings/operations.smithy deleted file mode 100644 index 37ee59c9..00000000 --- a/model/cluster/put_settings/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cluster-settings/" -) - -@xOperationGroup("cluster.put_settings") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_cluster/settings") -@documentation("Updates the cluster settings.") -operation ClusterPutSettings { - input: ClusterPutSettings_Input, - output: ClusterPutSettings_Output -} diff --git a/model/cluster/put_settings/structures.smithy b/model/cluster/put_settings/structures.smithy deleted file mode 100644 index fa03ac2b..00000000 --- a/model/cluster/put_settings/structures.smithy +++ /dev/null @@ -1,46 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterPutSettings_QueryParams { - @httpQuery("flat_settings") - @default(false) - flat_settings: FlatSettings, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("timeout") - timeout: Timeout, -} - -@documentation("The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart).") -structure ClusterPutSettings_BodyParams { - persistent: UserDefinedValueMap, - - transient: UserDefinedValueMap -} - -@input -structure ClusterPutSettings_Input with [ClusterPutSettings_QueryParams] { - @required - @httpPayload - content: ClusterPutSettings_BodyParams, -} - -structure ClusterPutSettings_Output { - acknowledged: Boolean, - - persistent: UserDefinedValueMap, - - transient: UserDefinedValueMap -} diff --git a/model/cluster/put_weighted_routing/operations.smithy b/model/cluster/put_weighted_routing/operations.smithy deleted file mode 100644 index 31ab85f4..00000000 --- a/model/cluster/put_weighted_routing/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-weighted-round-robin-search" -) - -@xOperationGroup("cluster.put_weighted_routing") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_cluster/routing/awareness/{attribute}/weights") -@documentation("Updates weighted shard routing weights.") -operation ClusterPutWeightedRouting { - input: ClusterPutWeightedRouting_Input, - output: ClusterPutWeightedRouting_Output -} diff --git a/model/cluster/put_weighted_routing/structures.smithy b/model/cluster/put_weighted_routing/structures.smithy deleted file mode 100644 index 481a31a7..00000000 --- a/model/cluster/put_weighted_routing/structures.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterPutWeightedRouting_QueryParams { -} - - -@input -structure ClusterPutWeightedRouting_Input with [ClusterPutWeightedRouting_QueryParams] { - @required - @httpLabel - attribute: PathAttribute, -} - -// TODO: Fill in Output Structure -structure ClusterPutWeightedRouting_Output {} diff --git a/model/cluster/remote_info/operations.smithy b/model/cluster/remote_info/operations.smithy deleted file mode 100644 index 3f008bd0..00000000 --- a/model/cluster/remote_info/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/remote-info/" -) - -@xOperationGroup("cluster.remote_info") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_remote/info") -@documentation("Returns the information about configured remote clusters.") -operation ClusterRemoteInfo { - input: ClusterRemoteInfo_Input, - output: ClusterRemoteInfo_Output -} diff --git a/model/cluster/remote_info/structures.smithy b/model/cluster/remote_info/structures.smithy deleted file mode 100644 index a029d32f..00000000 --- a/model/cluster/remote_info/structures.smithy +++ /dev/null @@ -1,20 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterRemoteInfo_QueryParams { -} - - -@input -structure ClusterRemoteInfo_Input with [ClusterRemoteInfo_QueryParams] { -} - -// TODO: Fill in Output Structure -structure ClusterRemoteInfo_Output {} diff --git a/model/cluster/reroute/operations.smithy b/model/cluster/reroute/operations.smithy deleted file mode 100644 index 12b68acb..00000000 --- a/model/cluster/reroute/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("cluster.reroute") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_cluster/reroute") -@documentation("Allows to manually change the allocation of individual shards in the cluster.") -operation ClusterReroute { - input: ClusterReroute_Input, - output: ClusterReroute_Output -} diff --git a/model/cluster/reroute/structures.smithy b/model/cluster/reroute/structures.smithy deleted file mode 100644 index b8121355..00000000 --- a/model/cluster/reroute/structures.smithy +++ /dev/null @@ -1,46 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterReroute_QueryParams { - @httpQuery("dry_run") - dry_run: ClusterRerouteDryRun, - - @httpQuery("explain") - @documentation("Return an explanation of why the commands can or cannot be executed.") - explain: Explain, - - @httpQuery("retry_failed") - retry_failed: RetryFailed, - - @httpQuery("metric") - metric: ClusterRerouteMetric, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("timeout") - timeout: Timeout, -} - -// TODO: Fill in Body Parameters -@documentation("The definition of `commands` to perform (`move`, `cancel`, `allocate`)") -structure ClusterReroute_BodyParams {} - -@input -structure ClusterReroute_Input with [ClusterReroute_QueryParams] { - @httpPayload - content: ClusterReroute_BodyParams, -} - -// TODO: Fill in Output Structure -structure ClusterReroute_Output {} diff --git a/model/cluster/state/operations.smithy b/model/cluster/state/operations.smithy deleted file mode 100644 index b9110c84..00000000 --- a/model/cluster/state/operations.smithy +++ /dev/null @@ -1,46 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("cluster.state") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cluster/state") -@documentation("Returns a comprehensive information about the state of the cluster.") -operation ClusterState { - input: ClusterState_Input, - output: ClusterState_Output -} - -@xOperationGroup("cluster.state") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cluster/state/{metric}") -@documentation("Returns a comprehensive information about the state of the cluster.") -operation ClusterState_WithMetric { - input: ClusterState_WithMetric_Input, - output: ClusterState_Output -} - -@xOperationGroup("cluster.state") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cluster/state/{metric}/{index}") -@documentation("Returns a comprehensive information about the state of the cluster.") -operation ClusterState_WithIndexMetric { - input: ClusterState_WithIndexMetric_Input, - output: ClusterState_Output -} diff --git a/model/cluster/state/structures.smithy b/model/cluster/state/structures.smithy deleted file mode 100644 index f4e36ccd..00000000 --- a/model/cluster/state/structures.smithy +++ /dev/null @@ -1,67 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterState_QueryParams { - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("flat_settings") - @default(false) - flat_settings: FlatSettings, - - @httpQuery("wait_for_metadata_version") - wait_for_metadata_version: WaitForMetadataVersion, - - @httpQuery("wait_for_timeout") - wait_for_timeout: WaitForTimeout, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, -} - - -@input -structure ClusterState_Input with [ClusterState_QueryParams] { -} - -@input -structure ClusterState_WithMetric_Input with [ClusterState_QueryParams] { - @required - @httpLabel - metric: PathClusterStateMetric, -} - -@input -structure ClusterState_WithIndexMetric_Input with [ClusterState_QueryParams] { - @required - @httpLabel - index: PathIndices, - - @required - @httpLabel - metric: PathClusterStateMetric, -} - -// TODO: Fill in Output Structure -structure ClusterState_Output {} diff --git a/model/cluster/stats/operations.smithy b/model/cluster/stats/operations.smithy deleted file mode 100644 index d1b3e9ff..00000000 --- a/model/cluster/stats/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/" -) - -@xOperationGroup("cluster.stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cluster/stats") -@documentation("Returns high-level overview of cluster statistics.") -operation ClusterStats { - input: ClusterStats_Input, - output: ClusterStats_Output -} - -@xOperationGroup("cluster.stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cluster/stats/nodes/{node_id}") -@documentation("Returns high-level overview of cluster statistics.") -operation ClusterStats_WithNodeId { - input: ClusterStats_WithNodeId_Input, - output: ClusterStats_Output -} diff --git a/model/cluster/stats/structures.smithy b/model/cluster/stats/structures.smithy deleted file mode 100644 index 65879d9a..00000000 --- a/model/cluster/stats/structures.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure ClusterStats_QueryParams { - @httpQuery("flat_settings") - @default(false) - flat_settings: FlatSettings, - - @httpQuery("timeout") - timeout: Timeout, -} - - -@input -structure ClusterStats_Input with [ClusterStats_QueryParams] { -} - -@input -structure ClusterStats_WithNodeId_Input with [ClusterStats_QueryParams] { - @required - @httpLabel - node_id: PathNodeId, -} - -// TODO: Fill in Output Structure -structure ClusterStats_Output {} diff --git a/model/common_booleans.smithy b/model/common_booleans.smithy deleted file mode 100644 index 8221b08c..00000000 --- a/model/common_booleans.smithy +++ /dev/null @@ -1,217 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -boolean AcceptDataLoss - -boolean ActiveOnly - -@documentation("Execute validation on all shards instead of one random shard per index.") -boolean AllShards - -@documentation("Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified).") -boolean AllowNoIndices - -@documentation("Allow if point in time can be created with partial failures.") -boolean AllowPartialPitCreation - -@documentation("Indicate if an error should be returned if there is a partial search failure or timeout.") -boolean AllowPartialSearchResults - -@documentation("Specify whether wildcard and prefix queries should be analyzed.") -boolean AnalyzeWildcard - -@documentation("Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.") -boolean CcsMinimizeRoundtrips - -@documentation("Simulate the operation only and return the resulting state.") -boolean ClusterRerouteDryRun - -@documentation("If `true`, the response only includes latest completed segment replication events.") -boolean CompletedOnly - -@documentation("whether or not to copy settings from the source index.") -boolean CopySettings - -@documentation("Whether the index template should only be added if new or can also replace an existing one.") -boolean Create - -boolean Detailed - -@documentation("Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown.") -boolean DfExplainSnapshot - -@documentation("Checks whether local node is commissioned or not. If set to true on a local call it will throw exception if node is decommissioned.") -boolean EnsureNodeCommissioned - -boolean Explain - -@documentation("Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.") -boolean FieldStatistics - -@documentation("Clear field data.") -boolean Fielddata - -@documentation("Return settings in flat format.") -boolean FlatSettings - -@documentation("Specify whether the index should be flushed after performing the operation.") -boolean Flush - -@documentation("If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices.") -boolean ForbidClosedIndices - -@documentation("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).") -boolean Force - -@documentation("Return the full node ID instead of the shortened version.") -boolean FullId - -@documentation("Return help information.") -boolean Help - -@documentation("Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue.") -boolean IgnoreIdleThreads - -@documentation("Whether specified concrete, expanded or aliased indices should be ignored when throttled.") -boolean IgnoreThrottled - -@documentation("Whether specified concrete indices should be ignored when unavailable (missing or closed).") -boolean IgnoreUnavailable - -boolean IncludeDefaults - -@documentation("Return information about disk usage and shard sizes.") -boolean IncludeDiskInfo - -@documentation("Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)") -boolean IncludeNamedQueriesScore - -@documentation("Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).") -boolean IncludeSegmentFileSizes - -@documentation("If set to true segment stats will include stats for segments that are not currently loaded into memory.") -boolean IncludeUnloadedSegments - -@documentation("Indicates whether unmapped fields should be included in the response.") -boolean IncludeUnmapped - -@documentation("Return 'YES' decisions in explanation.") -boolean IncludeYesDecisions - -@documentation("If set to true the rollover action will only be validated but not actually performed even if a condition matches.") -boolean IndicesRolloverDryRun - -@documentation("Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.") -boolean Lenient - -@documentation("Return local information, do not retrieve the state from cluster-manager node.") -boolean Local - -@documentation("Specifies if term offsets should be returned.") -boolean Offsets - -@documentation("If true, only ancient (an older Lucene major release) segments will be upgraded.") -boolean OnlyAncientSegments - -@documentation("Specify whether the operation should only expunge deleted documents.") -boolean OnlyExpungeDeletes - -@documentation("Specifies if term payloads should be returned.") -boolean Payloads - -@documentation("Specifies if term positions should be returned.") -boolean Positions - -@documentation("Whether to update existing settings. If set to `true` existing settings on an index remain unchanged.") -boolean PreserveExisting - -@documentation("Set to true to return stats only for primary shards.") -boolean Pri - -@documentation("Specify whether the operation should only perform on primary shards. Defaults to false.") -boolean PrimaryOnly - -@documentation("Specify whether to profile the query execution.") -boolean Profile - -@documentation("Clear query caches.") -boolean Query - -@documentation("Specify whether to perform the operation in realtime or search mode.") -boolean Realtime - -boolean RefreshBoolean - -@documentation("Clear request cache.") -boolean Request - -@documentation("Specify if request cache should be used for this request or not, defaults to index level setting.") -boolean RequestCache - -@documentation("When true, requires destination to be an alias.") -boolean RequireAlias - -@documentation("Indicates whether hits.total should be rendered as an integer or an object in the rest search response.") -boolean RestTotalHitsAsInt - -@documentation("Retries allocation of shards that are blocked due to too many subsequent allocation failures.") -boolean RetryFailed - -@documentation("Provide a more detailed explanation showing the actual Lucene query that will be executed.") -boolean Rewrite - -@documentation("Specify whether to return sequence number and primary term of the last modification of each hit.") -boolean SeqNoPrimaryTerm - -@documentation("Specifies if total term frequency and document frequency should be returned.") -boolean TermStatistics - -@documentation("Whether to calculate and return scores even if they are not used for sorting.") -boolean TrackScores - -@documentation("Indicate if the number of documents that match the query should be tracked.") -boolean TrackTotalHits - -@documentation("Set to false to disable timestamping.") -boolean Ts - -@documentation("Specify whether aggregation and suggester names should be prefixed by their respective types in the response.") -boolean TypedKeys - -@documentation("Verbose mode. Display column headers.") -boolean V - -boolean Verbose - -@documentation("Whether to verify the repository after creation.") -boolean Verify - -@documentation("Should this request wait until the operation has completed before returning.") -boolean WaitForCompletionFalse - -@documentation("Should this request wait until the operation has completed before returning.") -boolean WaitForCompletionTrue - -@documentation("Whether to wait until there are no initializing shards in the cluster.") -boolean WaitForNoInitializingShards - -@documentation("Whether to wait until there are no relocating shards in the cluster.") -boolean WaitForNoRelocatingShards - -@documentation("Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list.") -boolean WaitForRemoval - -@documentation("If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. If set to false the flush will be skipped iff if another flush operation is already running.") -boolean WaitIfOngoing - -@documentation("Whether to return document version as part of a hit.") -boolean WithVersion - -@documentation("When true, applies mappings only to the write index of an alias or data stream.") -boolean WriteIndexOnly diff --git a/model/common_enum_lists.smithy b/model/common_enum_lists.smithy deleted file mode 100644 index 368301ae..00000000 --- a/model/common_enum_lists.smithy +++ /dev/null @@ -1,36 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@documentation("Limit the information returned to the specified metrics. Defaults to all but metadata.") -list ClusterRerouteMetric { - member: ClusterRerouteMetric_Member -} - -enum ClusterRerouteMetric_Member { - ALL = "_all" - BLOCKS = "blocks" - METADATA = "metadata" - NODES = "nodes" - ROUTING_TABLE = "routing_table" - MASTER_NODE = "master_node" - CLUSTER_MANAGER_NODE = "cluster_manager_node" - VERSION = "version" -} - -@documentation("Comma-separated list of statuses used to filter on shards to get store information for.") -list Status { - member: Status_Member -} - -enum Status_Member { - GREEN = "green" - YELLOW = "yellow" - RED = "red" - ALL = "all" -} diff --git a/model/common_enums.smithy b/model/common_enums.smithy deleted file mode 100644 index 3286ad53..00000000 --- a/model/common_enums.smithy +++ /dev/null @@ -1,164 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@documentation("The unit in which to display byte values.") -enum Bytes { - B = "b" - K = "k" - KB = "kb" - M = "m" - MB = "mb" - G = "g" - GB = "gb" - T = "t" - TB = "tb" - P = "p" - PB = "pb" -} - -@documentation("Specify the level of detail for returned information.") -enum ClusterHealthLevel { - CLUSTER = "cluster" - INDICES = "indices" - SHARDS = "shards" - AWARENESS_ATTRIBUTES = "awareness_attributes" -} - -@documentation("What to do when the operation encounters version conflicts?.") -enum Conflicts { - ABORT = "abort" - PROCEED = "proceed" -} - -@documentation("The default operator for query string query (AND or OR).") -enum DefaultOperator { - AND = "AND" - OR = "OR" -} - -@documentation("Whether to expand wildcard expression to concrete indices that are open, closed or both.") -enum ExpandWildcards { - @documentation("Match any data stream or index, including hidden ones.") - ALL = "all" - @documentation("Match open, non-hidden indices. Also matches any non-hidden data stream.") - OPEN = "open" - @documentation("Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.") - CLOSED = "closed" - @documentation("Match hidden data streams and hidden indices. Must be combined with open, closed, or both.") - HIDDEN = "hidden" - @documentation("Wildcard expressions are not accepted.") - NONE = "none" -} - -@documentation("Group tasks by nodes or parent/child relationships.") -enum GroupBy { - NODES = "nodes" - PARENTS = "parents" - NONE = "none" -} - -@documentation("Health status ('green', 'yellow', or 'red') to filter only indices matching the specified health status.") -enum Health { - GREEN = "green" - YELLOW = "yellow" - RED = "red" -} - -@documentation("Return stats aggregated at cluster, index or shard level.") -enum IndiciesStatLevel { - CLUSTER = "cluster" - INDICES = "indices" - SHARDS = "shards" -} - -@documentation("Return indices stats aggregated at index, node or shard level.") -enum NodesStatLevel { - INDICES = "indices" - NODE = "node" - SHARDS = "shards" -} - -@documentation("Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create` for requests without an explicit document ID.") -enum OpType { - INDEX = "index" - CREATE = "create" -} - -@documentation("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.") -enum RefreshEnum { - TRUE = "true" - FALSE = "false" - WAIT_FOR = "wait_for" -} - -@documentation("The type to sample.") -enum SampleType { - CPU = "cpu" - WAIT = "wait" - BLOCK = "block" -} - -@documentation("Search operation type.") -enum SearchType { - @documentation("Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.") - QUERY_THEN_FETCH = "query_then_fetch" - @documentation("Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.") - DFS_QUERY_THEN_FETCH = "dfs_query_then_fetch" -} - -@documentation("Search operation type.") -enum SearchTypeMulti { - QUERY_THEN_FETCH = "query_then_fetch" - QUERY_AND_FETCH = "query_and_fetch" - DFS_QUERY_THEN_FETCH = "dfs_query_then_fetch" - DFS_QUERY_AND_FETCH = "dfs_query_and_fetch" -} - -@documentation("Specify suggest mode.") -enum SuggestMode { - MISSING = "missing" - POPULAR = "popular" - ALWAYS = "always" -} - -@documentation("The unit in which to display time values.") -enum Time { - D = "d" - H = "h" - M = "m" - S = "s" - MS = "ms" - MICROS = "micros" - NANOS = "nanos" -} - -@documentation("Specific version type.") -enum VersionType { - INTERNAL = "internal" - EXTERNAL = "external" - EXTERNAL_GTE = "external_gte" - FORCE = "force" -} - -@documentation("Wait until all currently queued events with the given priority are processed.") -enum WaitForEvents { - IMMEDIATE = "immediate" - URGENT = "urgent" - HIGH = "high" - NORMAL = "normal" - LOW = "low" - LANGUID = "languid" -} - -@documentation("Wait until cluster is in a specific state.") -enum WaitForStatus { - GREEN = "green" - YELLOW = "yellow" - RED = "red" -} diff --git a/model/common_integers.smithy b/model/common_integers.smithy deleted file mode 100644 index a91c369e..00000000 --- a/model/common_integers.smithy +++ /dev/null @@ -1,69 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@documentation("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.") -integer BatchedReduceSize - -@documentation("Starting offset.") -integer From - -@documentation("only perform the operation if the last operation that has changed the document has the specified primary term.") -integer IfPrimaryTerm - -@documentation("only perform the operation if the last operation that has changed the document has the specified sequence number.") -integer IfSeqNo - -@documentation("Controls the maximum number of concurrent searches the multi search api will execute.") -integer MaxConcurrentSearches - -integer MaxConcurrentShardRequests - -@documentation("Maximum number of documents to process (default: all documents).") -integer MaxDocs - -@documentation("The number of segments the index should be merged into (default: dynamic).") -integer MaxNumSegments - -@documentation("Include only documents with a specific `_score` value in the result.") -integer MinScore - -@documentation("The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers).") -integer Order - -@documentation("Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip 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.") -integer PreFilterShardSize - -@documentation("The throttle for this request in sub-requests per second. -1 means no throttle.") -integer RequestsPerSecond - -@documentation("Specify how many times should the operation be retried when a conflict occurs.") -integer RetryOnConflict - -@documentation("Size on the scroll request powering the operation.") -integer ScrollSize - -integer Size - -@documentation("Number of samples of thread stacktrace.") -integer SnapshotsCount - -@documentation("How many suggestions to return in response.") -integer SuggestSize - -@documentation("The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.") -integer TerminateAfter - -@documentation("Specify the number of threads to provide information for.") -integer Threads - -@documentation("Explicit version number for concurrency control.") -integer Version - -@documentation("Wait for the metadata version to be equal or greater than the specified metadata version.") -integer WaitForMetadataVersion diff --git a/model/common_string_lists.smithy b/model/common_string_lists.smithy deleted file mode 100644 index 6ebab124..00000000 --- a/model/common_string_lists.smithy +++ /dev/null @@ -1,110 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -list Actions { - member: String -} - -@documentation("Comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards).") -list CompletionFields { - member: String -} - -@documentation("Comma-separated list of fields to return as the docvalue representation of a field for each hit.") -list DocvalueFields { - member: String -} - -@documentation("Comma-separated list of fields for `fielddata` index metric (supports wildcards).") -list FielddataFields { - member: String -} - -list Fields { - member: String -} - -@documentation("Comma-separated list of search groups for `search` index metric.") -list Groups { - member: String -} - -@documentation("Comma-separated list of column names to display.") -list H { - member: String -} - -@documentation("Comma-separated list of documents ids. You must define ids as parameter or set 'ids' or 'docs' in the request body.") -list Ids { - member: String -} - -list IndexNames { - member: String -} - -@documentation("Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.") -list Indices { - member: String -} - -@documentation("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.") -list Nodes { - member: String -} - -@documentation("Comma-separated list of specific routing values.") -list Routings { - member: String -} - -@documentation("Comma-separated list of column names or column aliases to sort by.") -list S { - member: String -} - -@documentation("Comma-separated list of shards to display.") -list Shards { - member: String -} - -@documentation("Comma-separated list of : pairs.") -list Sort { - member: String -} - -@documentation("True or false to return the _source field or not, or a list of fields to return.") -list Source { - member: String -} - -@documentation("List of fields to exclude from the returned _source field.") -list SourceExcludes { - member: String -} - -@documentation("List of fields to extract and return from the _source field.") -list SourceIncludes { - member: String -} - -@documentation("Specific 'tag' of the request for logging and statistical purposes.") -list Stats { - member: String -} - -@documentation("Comma-separated list of stored fields to return.") -list StoredFields { - member: String -} - -@documentation("Comma-separated list of document types for the `indexing` index metric.") -list Types { - member: String -} diff --git a/model/common_strings.smithy b/model/common_strings.smithy deleted file mode 100644 index 4850744a..00000000 --- a/model/common_strings.smithy +++ /dev/null @@ -1,381 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@xDataType("array") -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Comma-separated list of alias names.") -string PathAliasNames - -@xDataType("array") -@xEnumOptions(["_all", "blocks", "metadata", "nodes", "routing_table", "routing_nodes", "master_node", "cluster_manager_node", "version"]) -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Limit the information returned to the specified metrics.") -string PathClusterStateMetric - -@xDataType("array") -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("The Comma-separated names of the component templates.") -string PathComponentTemplateNames - -@xDataType("array") -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -string PathFields - -@xDataType("array") -@xEnumOptions([ - "_all", - "store", - "indexing", - "get", - "search", - "merge", - "flush", - "refresh", - "query_cache", - "fielddata", - "docs", - "warmer", - "completion", - "segments", - "translog", - "suggest", - "request_cache", - "recovery" -]) -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified.") -string PathIndexMetric - -@xDataType("array") -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Comma-separated list of names or wildcard expressions.") -string PathIndexNames - -@xDataType("array") -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices.") -string PathIndices - -@xDataType("array") -@xEnumOptions([ - "_all", - "store", - "indexing", - "get", - "search", - "merge", - "flush", - "refresh", - "query_cache", - "fielddata", - "docs", - "warmer", - "completion", - "segments", - "translog", - "suggest", - "request_cache", - "recovery" -]) -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Limit the information returned the specific metrics.") -string PathIndicesStatsMetric - -@xDataType("array") -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices.") -string PathName - -@xDataType("array") -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("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.") -string PathNodeId - -@xDataType("array") -@xEnumOptions(["settings", "os", "process", "jvm", "thread_pool", "transport", "http", "plugins", "ingest"]) -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Comma-separated list of metrics you wish returned. Leave empty to return all.") -string PathNodesInfoMetric - -@xDataType("array") -@xEnumOptions(["_all", "breaker", "fs", "http", "indices", "jvm", "os", "process", "thread_pool", "transport", "discovery", "indexing_pressure", "search_pipeline"]) -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Limit the information returned to the specified metrics.") -string PathNodesStatsMetric - -@xDataType("array") -@xEnumOptions(["_all", "rest_actions"]) -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Limit the information returned to the specified metrics.") -string PathNodesUsageMetric - -@xDataType("array") -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Comma-separated list of pipeline ids. Wildcards supported.") -string PathPipelineIds - -@xDataType("array") -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Comma-separated list of repository names.") -string PathRepositories - -@deprecated -@xDataType("array") -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Comma-separated list of scroll IDs to clear.") -string PathScrollIds - -@xDataType("array") -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Comma-separated list of settings.") -string PathSettingNames - -@xDataType("array") -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Comma-separated list of snapshot names.") -string PathSnapshots - -@xDataType("array") -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Comma-separated list of data streams; use `_all` or empty string to perform the operation on all data streams.") -string PathStreamNames - -@xDataType("array") -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Comma-separated names of the index templates.") -string PathTemplateNames - -@xDataType("array") -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Comma-separated list of regular-expressions to filter the thread pools in the output.") -string PathThreadPoolPatterns - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("The name of the alias to rollover.") -string PathAlias - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("The name of the alias to be created or updated.") -string PathAliasName - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Awareness attribute name.") -string PathAttribute - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Awareness attribute name.") -string PathAwarenessAttributeName - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Awareness attribute value.") -string PathAwarenessAttributeValue - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("The block to add (one of read, write, read_only or metadata).") -string PathBlock - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Script context.") -string PathContext - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Document ID.") -string PathDocumentId - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Index name.") -string PathIndex - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("The name of the index (it must be a concrete index name).") -string PathIndexName - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("The UUID of the dangling index.") -string PathIndexUuid - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("The name of the rollover index.") -string PathNewIndex - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Pipeline ID.") -string PathPipelineId - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Repository name.") -string PathRepository - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Script ID.") -string PathScriptId - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Scroll ID.") -string PathScrollId - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("The id of the stored search template.") -string PathSearchTemplateId - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Snapshot name.") -string PathSnapshot - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("The name of the data stream.") -string PathStreamName - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("The name of the target index.") -string PathTarget - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("The name of the cloned snapshot to create.") -string PathTargetSnapshot - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -string PathTaskId - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("The name of the template.") -string PathTemplateName - -@xDataType("array") -@xEnumOptions(["circuit_breaker_triggered", "total_load_time", "eviction_count", "hit_count", "miss_count", "graph_memory_usage", "graph_memory_usage_percentage", "graph_index_requests", "graph_index_errors", "graph_query_requests", "graph_query_errors", "knn_query_requests", "cache_capacity_reached", "load_success_count", "load_exception_count", "indices_in_cache", "script_compilations", "script_compilation_errors", "script_query_requests", "script_query_errors", "nmslib_initialized", "faiss_initialized", "model_index_status", "indexing_from_model_degraded", "training_requests", "training_errors", "training_memory_usage", "training_memory_usage_percentage"]) -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats.") -string PathStats - -@pattern("^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$") -@documentation("The id of the model.") -string PathModelId - -@documentation("The analyzer to use for the query string.") -string Analyzer - -@documentation("The awareness attribute for which the health is required.") -string AwarenessAttribute - -@documentation("User defined reason for dry-run creating the new template for simulation purposes.") -string Cause - -@documentation("The field to use as default where no field prefix is given in the query string.") -string Df - -@documentation("The default field for query string query.") -string DfExplain - -@documentation("Default document type for items which don't provide one.") -string DocumentType - -@documentation("A short version of the Accept header, e.g. json, yaml.") -string Format - -string Index - -@xDataType("time") -@pattern("^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$") -@documentation("Specify the keep alive for point in time.") -string KeepAlive - -@documentation("The script language.") -string Lang - -@documentation("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.") -string NodeIds - -@documentation("Preferred node to execute training.") -string NodeId - -@documentation("Comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_ids.") -string NodeNames - -string ParentTaskId - -@documentation("The pipeline id to preprocess incoming documents with.") -string Pipeline - -@documentation("Customizable sequence of processing stages applied to search queries.") -string SearchPipeline - -@documentation("Specify the node or shard the operation should be performed on.") -string Preference - -@documentation("Query in the Lucene query string syntax.") -string Q - -@documentation("Routing value.") -string Routing - -@documentation("Scroll ID.") -string ScrollId - -@documentation("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`.") -string Slices - -@documentation("Specify which field to use for suggestions.") -string SuggestField - -@documentation("The source text for which the suggestions should be returned.") -string SuggestText - -string WaitForActiveShards - -@documentation("Wait until the specified number of nodes is available.") -string WaitForNodes - -@xDataType("time") -@pattern("^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$") -@documentation("Time each individual bulk request should wait for shards that are unavailable.") -string BulkTimeout - -@xDataType("time") -@xVersionAdded("2.0.0") -@pattern("^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$") -@documentation("Operation timeout for connection to cluster-manager node.") -string ClusterManagerTimeout - -@xDataType("time") -@pattern("^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$") -@documentation("The interval for the second sampling of threads.") -string Interval - -@deprecated -@xDataType("time") -@xDeprecationMessage("To promote inclusive language, use 'cluster_manager_timeout' instead.") -@xVersionDeprecated("2.0.0") -@pattern("^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$") -@documentation("Operation timeout for connection to master node.") -string MasterTimeout - -@xDataType("time") -@pattern("^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$") -@documentation("Specify how long a consistent view of the index should be maintained for scrolled search.") -string Scroll - -@xDataType("time") -@pattern("^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$") -@documentation("Explicit timeout for each search request. Defaults to no timeout.") -string SearchTimeout - -@xDataType("time") -@pattern("^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$") -@documentation("Operation timeout.") -string Timeout - -@xDataType("time") -@pattern("^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$") -@documentation("The maximum time to wait for wait_for_metadata_version before timing out.") -string WaitForTimeout - -@xDataType("time") -@pattern("^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$") -@documentation("Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.") -string TaskExecutionTimeout diff --git a/model/common_structures.smithy b/model/common_structures.smithy deleted file mode 100644 index 83860a13..00000000 --- a/model/common_structures.smithy +++ /dev/null @@ -1,61 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -map UserDefinedValueMap{ - key: String, - value: UserDefinedValue -} - -document UserDefinedValue - -list UserDefinedValueList{ - member: String -} - -list UserDefinedObjectList{ - member: Document -} - -structure ShardStatistics{ - total: Integer, - successful: Integer, - skipped: Integer, - failed: Integer -} - -structure HitsMetadata{ - total: Total, - max_score: Double, - hits: ListHits -} - -structure Total{ - value: Integer, - relation: Relation, -} - -list ListHits{ - member: Hits -} - -enum Relation { - @documentation("Accurate") - EQ = "eq" - @documentation("Lower bound, including returned documents") - GTE = "gte" -} - -structure Hits{ - _index: String, - _type: String, - _id: String, - _score: Float, - _source: Document, - fields: Document -} diff --git a/model/dangling_indices/delete_dangling_index/operations.smithy b/model/dangling_indices/delete_dangling_index/operations.smithy deleted file mode 100644 index af0baef0..00000000 --- a/model/dangling_indices/delete_dangling_index/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/" -) - -@xOperationGroup("dangling_indices.delete_dangling_index") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_dangling/{index_uuid}") -@documentation("Deletes the specified dangling index.") -operation DanglingIndicesDeleteDanglingIndex { - input: DanglingIndicesDeleteDanglingIndex_Input, - output: DanglingIndicesDeleteDanglingIndex_Output -} diff --git a/model/dangling_indices/delete_dangling_index/structures.smithy b/model/dangling_indices/delete_dangling_index/structures.smithy deleted file mode 100644 index d4467523..00000000 --- a/model/dangling_indices/delete_dangling_index/structures.smithy +++ /dev/null @@ -1,35 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure DanglingIndicesDeleteDanglingIndex_QueryParams { - @httpQuery("accept_data_loss") - @documentation("Must be set to true in order to delete the dangling index.") - accept_data_loss: AcceptDataLoss, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - - -@input -structure DanglingIndicesDeleteDanglingIndex_Input with [DanglingIndicesDeleteDanglingIndex_QueryParams] { - @required - @httpLabel - index_uuid: PathIndexUuid, -} - -// TODO: Fill in Output Structure -structure DanglingIndicesDeleteDanglingIndex_Output {} diff --git a/model/dangling_indices/import_dangling_index/operations.smithy b/model/dangling_indices/import_dangling_index/operations.smithy deleted file mode 100644 index 91a7e9f8..00000000 --- a/model/dangling_indices/import_dangling_index/operations.smithy +++ /dev/null @@ -1,22 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/" -) - -@xOperationGroup("dangling_indices.import_dangling_index") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_dangling/{index_uuid}") -@documentation("Imports the specified dangling index.") -operation DanglingIndicesImportDanglingIndex { - input: DanglingIndicesImportDanglingIndex_Input, - output: DanglingIndicesImportDanglingIndex_Output -} diff --git a/model/dangling_indices/import_dangling_index/structures.smithy b/model/dangling_indices/import_dangling_index/structures.smithy deleted file mode 100644 index 088d26a8..00000000 --- a/model/dangling_indices/import_dangling_index/structures.smithy +++ /dev/null @@ -1,35 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure DanglingIndicesImportDanglingIndex_QueryParams { - @httpQuery("accept_data_loss") - @documentation("Must be set to true in order to import the dangling index.") - accept_data_loss: AcceptDataLoss, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - - -@input -structure DanglingIndicesImportDanglingIndex_Input with [DanglingIndicesImportDanglingIndex_QueryParams] { - @required - @httpLabel - index_uuid: PathIndexUuid, -} - -// TODO: Fill in Output Structure -structure DanglingIndicesImportDanglingIndex_Output {} diff --git a/model/dangling_indices/list_dangling_indices/operations.smithy b/model/dangling_indices/list_dangling_indices/operations.smithy deleted file mode 100644 index 1796eb68..00000000 --- a/model/dangling_indices/list_dangling_indices/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/" -) - -@xOperationGroup("dangling_indices.list_dangling_indices") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_dangling") -@documentation("Returns all dangling indices.") -operation DanglingIndicesListDanglingIndices { - input: DanglingIndicesListDanglingIndices_Input, - output: DanglingIndicesListDanglingIndices_Output -} diff --git a/model/dangling_indices/list_dangling_indices/structures.smithy b/model/dangling_indices/list_dangling_indices/structures.smithy deleted file mode 100644 index a85b2f35..00000000 --- a/model/dangling_indices/list_dangling_indices/structures.smithy +++ /dev/null @@ -1,20 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure DanglingIndicesListDanglingIndices_QueryParams { -} - - -@input -structure DanglingIndicesListDanglingIndices_Input with [DanglingIndicesListDanglingIndices_QueryParams] { -} - -// TODO: Fill in Output Structure -structure DanglingIndicesListDanglingIndices_Output {} diff --git a/model/indices/add_block/operations.smithy b/model/indices/add_block/operations.smithy deleted file mode 100644 index 835d6332..00000000 --- a/model/indices/add_block/operations.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.add_block") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/{index}/_block/{block}") -@documentation("Adds a block to an index.") -operation IndicesAddBlock { - input: IndicesAddBlock_Input, - output: IndicesAddBlock_Output -} diff --git a/model/indices/add_block/structures.smithy b/model/indices/add_block/structures.smithy deleted file mode 100644 index 09316439..00000000 --- a/model/indices/add_block/structures.smithy +++ /dev/null @@ -1,46 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesAddBlock_QueryParams { - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, -} - - -@input -structure IndicesAddBlock_Input with [IndicesAddBlock_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to add a block to.") - index: PathIndices, - - @required - @httpLabel - block: PathBlock, -} - -// TODO: Fill in Output Structure -structure IndicesAddBlock_Output {} diff --git a/model/indices/analyze/operations.smithy b/model/indices/analyze/operations.smithy deleted file mode 100644 index acabf83e..00000000 --- a/model/indices/analyze/operations.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/" -) - -@xOperationGroup("indices.analyze") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_analyze") -@documentation("Performs the analysis process on a text and return the tokens breakdown of the text.") -operation IndicesAnalyze_Get { - input: IndicesAnalyze_Get_Input, - output: IndicesAnalyze_Output -} - -@xOperationGroup("indices.analyze") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_analyze") -@documentation("Performs the analysis process on a text and return the tokens breakdown of the text.") -operation IndicesAnalyze_Post { - input: IndicesAnalyze_Post_Input, - output: IndicesAnalyze_Output -} - -@xOperationGroup("indices.analyze") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_analyze") -@documentation("Performs the analysis process on a text and return the tokens breakdown of the text.") -operation IndicesAnalyze_Get_WithIndex { - input: IndicesAnalyze_Get_WithIndex_Input, - output: IndicesAnalyze_Output -} - -@xOperationGroup("indices.analyze") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_analyze") -@documentation("Performs the analysis process on a text and return the tokens breakdown of the text.") -operation IndicesAnalyze_Post_WithIndex { - input: IndicesAnalyze_Post_WithIndex_Input, - output: IndicesAnalyze_Output -} diff --git a/model/indices/analyze/structures.smithy b/model/indices/analyze/structures.smithy deleted file mode 100644 index 827b775b..00000000 --- a/model/indices/analyze/structures.smithy +++ /dev/null @@ -1,50 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesAnalyze_QueryParams { - @httpQuery("index") - @documentation("The name of the index to scope the operation.") - query_index: Index, -} - -// TODO: Fill in Body Parameters -@documentation("Define analyzer/tokenizer parameters and the text on which the analysis should be performed") -structure IndicesAnalyze_BodyParams {} - -@input -structure IndicesAnalyze_Get_Input with [IndicesAnalyze_QueryParams] { -} - -@input -structure IndicesAnalyze_Post_Input with [IndicesAnalyze_QueryParams] { - @httpPayload - content: IndicesAnalyze_BodyParams, -} - -@input -structure IndicesAnalyze_Get_WithIndex_Input with [IndicesAnalyze_QueryParams] { - @required - @httpLabel - @documentation("The name of the index to scope the operation.") - index: PathIndex, -} - -@input -structure IndicesAnalyze_Post_WithIndex_Input with [IndicesAnalyze_QueryParams] { - @required - @httpLabel - @documentation("The name of the index to scope the operation.") - index: PathIndex, - @httpPayload - content: IndicesAnalyze_BodyParams, -} - -// TODO: Fill in Output Structure -structure IndicesAnalyze_Output {} diff --git a/model/indices/clear_cache/operations.smithy b/model/indices/clear_cache/operations.smithy deleted file mode 100644 index 7083af57..00000000 --- a/model/indices/clear_cache/operations.smithy +++ /dev/null @@ -1,32 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/" -) - -@xOperationGroup("indices.clear_cache") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_cache/clear") -@documentation("Clears all or specific caches for one or more indices.") -operation IndicesClearCache { - input: IndicesClearCache_Input, - output: IndicesClearCache_Output -} - -@xOperationGroup("indices.clear_cache") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_cache/clear") -@documentation("Clears all or specific caches for one or more indices.") -operation IndicesClearCache_WithIndex { - input: IndicesClearCache_WithIndex_Input, - output: IndicesClearCache_Output -} diff --git a/model/indices/clear_cache/structures.smithy b/model/indices/clear_cache/structures.smithy deleted file mode 100644 index c6bf2117..00000000 --- a/model/indices/clear_cache/structures.smithy +++ /dev/null @@ -1,52 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesClearCache_QueryParams { - @httpQuery("fielddata") - fielddata: Fielddata, - - @httpQuery("fields") - @documentation("Comma-separated list of fields to clear when using the `fielddata` parameter (default: all).") - fields: Fields, - - @httpQuery("query") - query: Query, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("index") - query_index: Indices, - - @httpQuery("request") - request: Request, -} - - -@input -structure IndicesClearCache_Input with [IndicesClearCache_QueryParams] { -} - -@input -structure IndicesClearCache_WithIndex_Input with [IndicesClearCache_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure IndicesClearCache_Output {} diff --git a/model/indices/clone/operations.smithy b/model/indices/clone/operations.smithy deleted file mode 100644 index b1c1a0c5..00000000 --- a/model/indices/clone/operations.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/index-apis/clone/" -) - -@xOperationGroup("indices.clone") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/{index}/_clone/{target}") -@documentation("Clones an index.") -operation IndicesClone_Put { - input: IndicesClone_Put_Input, - output: IndicesClone_Output -} - -@xOperationGroup("indices.clone") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_clone/{target}") -@documentation("Clones an index.") -operation IndicesClone_Post { - input: IndicesClone_Post_Input, - output: IndicesClone_Output -} diff --git a/model/indices/clone/structures.smithy b/model/indices/clone/structures.smithy deleted file mode 100644 index b84cb4b0..00000000 --- a/model/indices/clone/structures.smithy +++ /dev/null @@ -1,66 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesClone_QueryParams { - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("wait_for_active_shards") - @documentation("Set the number of active shards to wait for on the cloned index before the operation returns.") - wait_for_active_shards: WaitForActiveShards, - - @httpQuery("wait_for_completion") - @default(true) - wait_for_completion: WaitForCompletionTrue, - - @httpQuery("task_execution_timeout") - task_execution_timeout: TaskExecutionTimeout, -} - -// TODO: Fill in Body Parameters -@documentation("The configuration for the target index (`settings` and `aliases`)") -structure IndicesClone_BodyParams {} - -@input -structure IndicesClone_Put_Input with [IndicesClone_QueryParams] { - @required - @httpLabel - @documentation("The name of the source index to clone.") - index: PathIndex, - - @required - @httpLabel - target: PathTarget, - @httpPayload - content: IndicesClone_BodyParams, -} - -@input -structure IndicesClone_Post_Input with [IndicesClone_QueryParams] { - @required - @httpLabel - @documentation("The name of the source index to clone.") - index: PathIndex, - - @required - @httpLabel - target: PathTarget, - @httpPayload - content: IndicesClone_BodyParams, -} - -// TODO: Fill in Output Structure -structure IndicesClone_Output {} diff --git a/model/indices/close/operations.smithy b/model/indices/close/operations.smithy deleted file mode 100644 index 091f24a5..00000000 --- a/model/indices/close/operations.smithy +++ /dev/null @@ -1,22 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/index-apis/close-index/" -) - -@xOperationGroup("indices.close") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_close") -@documentation("Closes an index.") -operation IndicesClose { - input: IndicesClose_Input, - output: IndicesClose_Output -} diff --git a/model/indices/close/structures.smithy b/model/indices/close/structures.smithy deleted file mode 100644 index c8bb5e08..00000000 --- a/model/indices/close/structures.smithy +++ /dev/null @@ -1,46 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesClose_QueryParams { - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("wait_for_active_shards") - @documentation("Sets the number of active shards to wait for before the operation returns.") - wait_for_active_shards: WaitForActiveShards, -} - - -@input -structure IndicesClose_Input with [IndicesClose_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to close.") - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure IndicesClose_Output {} diff --git a/model/indices/create/operations.smithy b/model/indices/create/operations.smithy deleted file mode 100644 index 33889d59..00000000 --- a/model/indices/create/operations.smithy +++ /dev/null @@ -1,38 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/index-apis/create-index/" -) - -@xOperationGroup("indices.create") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/{index}") -@documentation("Creates an index with optional settings and mappings.") -operation IndicesCreate { - input: IndicesCreate_Input, - output: IndicesCreate_Output -} - - -apply IndicesCreate @examples([ - { - title: "Examples for Create Index Operation.", - input: { - index: "books" - }, - output: { - index: "books", - shards_acknowledged: true, - acknowledged: true - } - } -]) diff --git a/model/indices/create/structures.smithy b/model/indices/create/structures.smithy deleted file mode 100644 index 7208972a..00000000 --- a/model/indices/create/structures.smithy +++ /dev/null @@ -1,56 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesCreate_QueryParams { - @httpQuery("wait_for_active_shards") - @documentation("Set the number of active shards to wait for before the operation returns.") - wait_for_active_shards: WaitForActiveShards, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - -@documentation("The configuration for the index (`settings` and `mappings`)") -structure IndicesCreate_BodyParams { - //TODO: Placeholders. aliases, mapping and settings need to be updated with proper structures - - aliases: UserDefinedValueMap, - - mapping: UserDefinedValueMap, - - settings: UserDefinedValueMap -} - -@input -structure IndicesCreate_Input with [IndicesCreate_QueryParams] { - @required - @httpLabel - index: PathIndex, - @httpPayload - content: IndicesCreate_BodyParams, -} - - -structure IndicesCreate_Output { - @required - index: Index, - - @required - shards_acknowledged: Boolean, - - @required - acknowledged: Boolean -} diff --git a/model/indices/create_data_stream/operations.smithy b/model/indices/create_data_stream/operations.smithy deleted file mode 100644 index 5f8d83e9..00000000 --- a/model/indices/create_data_stream/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/im-plugin/data-streams/" -) - -@xOperationGroup("indices.create_data_stream") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_data_stream/{name}") -@documentation("Creates or updates a data stream.") -operation IndicesCreateDataStream { - input: IndicesCreateDataStream_Input, - output: IndicesCreateDataStream_Output -} diff --git a/model/indices/create_data_stream/structures.smithy b/model/indices/create_data_stream/structures.smithy deleted file mode 100644 index 8cc3d3b3..00000000 --- a/model/indices/create_data_stream/structures.smithy +++ /dev/null @@ -1,29 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesCreateDataStream_QueryParams { -} - -// TODO: Fill in Body Parameters -@documentation("The data stream definition") -structure IndicesCreateDataStream_BodyParams {} - -@input -structure IndicesCreateDataStream_Input with [IndicesCreateDataStream_QueryParams] { - @required - @httpLabel - name: PathStreamName, - @httpPayload - content: IndicesCreateDataStream_BodyParams, -} - -structure IndicesCreateDataStream_Output { - acknowledged: Boolean -} diff --git a/model/indices/data_stream.smithy b/model/indices/data_stream.smithy deleted file mode 100644 index 89dd0dad..00000000 --- a/model/indices/data_stream.smithy +++ /dev/null @@ -1,40 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -structure DataStream { - name: String, - timestamp_field: DataStreamTimestampField, - indices: DataStreamIndices, - generation: Long, - status: DataStreamStatus, - template: String -} - -list DataStreamIndices { - member: DataStreamIndex -} - -structure DataStreamIndex { - index_name: String, - index_uuid: String -} - -structure DataStreamTimestampField { - name: String -} - -enum DataStreamStatus { - GREEN = "green" - YELLOW = "yellow" - RED = "red" -} - -list DataStreamList { - member: DataStream -} diff --git a/model/indices/data_streams_stats/operations.smithy b/model/indices/data_streams_stats/operations.smithy deleted file mode 100644 index 590005e2..00000000 --- a/model/indices/data_streams_stats/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/im-plugin/data-streams/" -) - -@xOperationGroup("indices.data_streams_stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_data_stream/_stats") -@documentation("Provides statistics on operations happening in a data stream.") -operation IndicesDataStreamsStats { - input: IndicesDataStreamsStats_Input, - output: IndicesDataStreamsStats_Output -} - -@xOperationGroup("indices.data_streams_stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_data_stream/{name}/_stats") -@documentation("Provides statistics on operations happening in a data stream.") -operation IndicesDataStreamsStats_WithName { - input: IndicesDataStreamsStats_WithName_Input, - output: IndicesDataStreamsStats_Output -} diff --git a/model/indices/data_streams_stats/structures.smithy b/model/indices/data_streams_stats/structures.smithy deleted file mode 100644 index 06b2f9b7..00000000 --- a/model/indices/data_streams_stats/structures.smithy +++ /dev/null @@ -1,27 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesDataStreamsStats_QueryParams { -} - - -@input -structure IndicesDataStreamsStats_Input with [IndicesDataStreamsStats_QueryParams] { -} - -@input -structure IndicesDataStreamsStats_WithName_Input with [IndicesDataStreamsStats_QueryParams] { - @required - @httpLabel - name: PathStreamNames, -} - -// TODO: Fill in Output Structure -structure IndicesDataStreamsStats_Output {} diff --git a/model/indices/delete/operations.smithy b/model/indices/delete/operations.smithy deleted file mode 100644 index 48675c45..00000000 --- a/model/indices/delete/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/" -) -@xOperationGroup("indices.delete") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/{index}") -@documentation("Deletes an index.") -operation IndicesDelete { - input: IndicesDelete_Input, - output: IndicesDelete_Output -} - -apply IndicesDelete @examples([ - { - title: "Examples for Delete Index Operation.", - input: { - index: "books" - }, - output: { - acknowledged: true - } - } -]) diff --git a/model/indices/delete/structures.smithy b/model/indices/delete/structures.smithy deleted file mode 100644 index d5f1ced4..00000000 --- a/model/indices/delete/structures.smithy +++ /dev/null @@ -1,45 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesDelete_QueryParams { - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("ignore_unavailable") - @default(false) - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - @default(false) - allow_no_indices: AllowNoIndices, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, -} - - -@input -structure IndicesDelete_Input with [IndicesDelete_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to delete; use `_all` or `*` string to delete all indices.") - index: PathIndices, -} - -structure IndicesDelete_Output { - acknowledged: Boolean -} diff --git a/model/indices/delete_alias/operations.smithy b/model/indices/delete_alias/operations.smithy deleted file mode 100644 index 2e8b31a1..00000000 --- a/model/indices/delete_alias/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases" -) - -@xOperationGroup("indices.delete_alias") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/{index}/_alias/{name}") -@documentation("Deletes an alias.") -operation IndicesDeleteAlias { - input: IndicesDeleteAlias_Input, - output: IndicesDeleteAlias_Output -} - -@xOperationGroup("indices.delete_alias") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/{index}/_aliases/{name}") -@documentation("Deletes an alias.") -operation IndicesDeleteAlias_Plural { - input: IndicesDeleteAlias_Plural_Input, - output: IndicesDeleteAlias_Output -} diff --git a/model/indices/delete_alias/structures.smithy b/model/indices/delete_alias/structures.smithy deleted file mode 100644 index e5072ae2..00000000 --- a/model/indices/delete_alias/structures.smithy +++ /dev/null @@ -1,46 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesDeleteAlias_QueryParams { - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - - -@input -structure IndicesDeleteAlias_Input with [IndicesDeleteAlias_QueryParams] { - @required - @httpLabel - index: PathIndices, - - @required - @httpLabel - name: PathName, -} - -@input -structure IndicesDeleteAlias_Plural_Input with [IndicesDeleteAlias_QueryParams] { - @required - @httpLabel - index: PathIndices, - - @required - @httpLabel - name: PathName, -} - -// TODO: Fill in Output Structure -structure IndicesDeleteAlias_Output {} diff --git a/model/indices/delete_data_stream/operations.smithy b/model/indices/delete_data_stream/operations.smithy deleted file mode 100644 index 8f7f362f..00000000 --- a/model/indices/delete_data_stream/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/im-plugin/data-streams/" -) - -@xOperationGroup("indices.delete_data_stream") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_data_stream/{name}") -@documentation("Deletes a data stream.") -operation IndicesDeleteDataStream { - input: IndicesDeleteDataStream_Input, - output: IndicesDeleteDataStream_Output -} diff --git a/model/indices/delete_data_stream/structures.smithy b/model/indices/delete_data_stream/structures.smithy deleted file mode 100644 index d821bb47..00000000 --- a/model/indices/delete_data_stream/structures.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesDeleteDataStream_QueryParams { -} - - -@input -structure IndicesDeleteDataStream_Input with [IndicesDeleteDataStream_QueryParams] { - @required - @httpLabel - name: PathStreamNames, -} - -structure IndicesDeleteDataStream_Output { - acknowledged: Boolean -} diff --git a/model/indices/delete_index_template/operations.smithy b/model/indices/delete_index_template/operations.smithy deleted file mode 100644 index 11a28c6d..00000000 --- a/model/indices/delete_index_template/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/im-plugin/index-templates/#delete-a-template" -) - -@xOperationGroup("indices.delete_index_template") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_index_template/{name}") -@documentation("Deletes an index template.") -operation IndicesDeleteIndexTemplate { - input: IndicesDeleteIndexTemplate_Input, - output: IndicesDeleteIndexTemplate_Output -} diff --git a/model/indices/delete_index_template/structures.smithy b/model/indices/delete_index_template/structures.smithy deleted file mode 100644 index 363e9a8e..00000000 --- a/model/indices/delete_index_template/structures.smithy +++ /dev/null @@ -1,31 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesDeleteIndexTemplate_QueryParams { - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - - -@input -structure IndicesDeleteIndexTemplate_Input with [IndicesDeleteIndexTemplate_QueryParams] { - @required - @httpLabel - name: PathTemplateName, -} - -// TODO: Fill in Output Structure -structure IndicesDeleteIndexTemplate_Output {} diff --git a/model/indices/delete_template/operations.smithy b/model/indices/delete_template/operations.smithy deleted file mode 100644 index 09805acb..00000000 --- a/model/indices/delete_template/operations.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.delete_template") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_template/{name}") -@documentation("Deletes an index template.") -operation IndicesDeleteTemplate { - input: IndicesDeleteTemplate_Input, - output: IndicesDeleteTemplate_Output -} diff --git a/model/indices/delete_template/structures.smithy b/model/indices/delete_template/structures.smithy deleted file mode 100644 index d3529561..00000000 --- a/model/indices/delete_template/structures.smithy +++ /dev/null @@ -1,31 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesDeleteTemplate_QueryParams { - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - - -@input -structure IndicesDeleteTemplate_Input with [IndicesDeleteTemplate_QueryParams] { - @required - @httpLabel - name: PathTemplateName, -} - -// TODO: Fill in Output Structure -structure IndicesDeleteTemplate_Output {} diff --git a/model/indices/exists/operations.smithy b/model/indices/exists/operations.smithy deleted file mode 100644 index ce510226..00000000 --- a/model/indices/exists/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/index-apis/exists/" -) - -@xOperationGroup("indices.exists") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@readonly -@http(method: "HEAD", uri: "/{index}") -@documentation("Returns information about whether a particular index exists.") -operation IndicesExists { - input: IndicesExists_Input, - output: IndicesExists_Output -} diff --git a/model/indices/exists/structures.smithy b/model/indices/exists/structures.smithy deleted file mode 100644 index 2829b251..00000000 --- a/model/indices/exists/structures.smithy +++ /dev/null @@ -1,48 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesExists_QueryParams { - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("ignore_unavailable") - @default(false) - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - @default(false) - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("flat_settings") - @default(false) - flat_settings: FlatSettings, - - @httpQuery("include_defaults") - @documentation("Whether to return all default setting for each of the indices.") - @default(false) - include_defaults: IncludeDefaults, -} - - -@input -structure IndicesExists_Input with [IndicesExists_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices.") - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure IndicesExists_Output {} diff --git a/model/indices/exists_alias/operations.smithy b/model/indices/exists_alias/operations.smithy deleted file mode 100644 index f3588a16..00000000 --- a/model/indices/exists_alias/operations.smithy +++ /dev/null @@ -1,35 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.exists_alias") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@readonly -@http(method: "HEAD", uri: "/_alias/{name}") -@documentation("Returns information about whether a particular alias exists.") -operation IndicesExistsAlias { - input: IndicesExistsAlias_Input, - output: IndicesExistsAlias_Output -} - -@xOperationGroup("indices.exists_alias") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@readonly -@http(method: "HEAD", uri: "/{index}/_alias/{name}") -@documentation("Returns information about whether a particular alias exists.") -operation IndicesExistsAlias_WithIndex { - input: IndicesExistsAlias_WithIndex_Input, - output: IndicesExistsAlias_Output -} diff --git a/model/indices/exists_alias/structures.smithy b/model/indices/exists_alias/structures.smithy deleted file mode 100644 index d04538a0..00000000 --- a/model/indices/exists_alias/structures.smithy +++ /dev/null @@ -1,48 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesExistsAlias_QueryParams { - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("all") - expand_wildcards: ExpandWildcards, - - @httpQuery("local") - @default(false) - local: Local, -} - - -@input -structure IndicesExistsAlias_Input with [IndicesExistsAlias_QueryParams] { - @required - @httpLabel - name: PathAliasNames, -} - -@input -structure IndicesExistsAlias_WithIndex_Input with [IndicesExistsAlias_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to filter aliases.") - index: PathIndices, - - @required - @httpLabel - name: PathAliasNames, -} - -// TODO: Fill in Output Structure -structure IndicesExistsAlias_Output {} diff --git a/model/indices/exists_index_template/operations.smithy b/model/indices/exists_index_template/operations.smithy deleted file mode 100644 index 03ad5904..00000000 --- a/model/indices/exists_index_template/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/im-plugin/index-templates/" -) - -@xOperationGroup("indices.exists_index_template") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@readonly -@http(method: "HEAD", uri: "/_index_template/{name}") -@documentation("Returns information about whether a particular index template exists.") -operation IndicesExistsIndexTemplate { - input: IndicesExistsIndexTemplate_Input, - output: IndicesExistsIndexTemplate_Output -} diff --git a/model/indices/exists_index_template/structures.smithy b/model/indices/exists_index_template/structures.smithy deleted file mode 100644 index c6b0b0ad..00000000 --- a/model/indices/exists_index_template/structures.smithy +++ /dev/null @@ -1,36 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesExistsIndexTemplate_QueryParams { - @httpQuery("flat_settings") - @default(false) - flat_settings: FlatSettings, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("local") - @default(false) - local: Local, -} - - -@input -structure IndicesExistsIndexTemplate_Input with [IndicesExistsIndexTemplate_QueryParams] { - @required - @httpLabel - name: PathTemplateName, -} - -// TODO: Fill in Output Structure -structure IndicesExistsIndexTemplate_Output {} diff --git a/model/indices/exists_template/operations.smithy b/model/indices/exists_template/operations.smithy deleted file mode 100644 index cf41cbe7..00000000 --- a/model/indices/exists_template/operations.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.exists_template") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@readonly -@http(method: "HEAD", uri: "/_template/{name}") -@documentation("Returns information about whether a particular index template exists.") -operation IndicesExistsTemplate { - input: IndicesExistsTemplate_Input, - output: IndicesExistsTemplate_Output -} diff --git a/model/indices/exists_template/structures.smithy b/model/indices/exists_template/structures.smithy deleted file mode 100644 index ef747396..00000000 --- a/model/indices/exists_template/structures.smithy +++ /dev/null @@ -1,36 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesExistsTemplate_QueryParams { - @httpQuery("flat_settings") - @default(false) - flat_settings: FlatSettings, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("local") - @default(false) - local: Local, -} - - -@input -structure IndicesExistsTemplate_Input with [IndicesExistsTemplate_QueryParams] { - @required - @httpLabel - name: PathTemplateNames, -} - -// TODO: Fill in Output Structure -structure IndicesExistsTemplate_Output {} diff --git a/model/indices/flush/operations.smithy b/model/indices/flush/operations.smithy deleted file mode 100644 index d6c059e6..00000000 --- a/model/indices/flush/operations.smithy +++ /dev/null @@ -1,55 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.flush") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_flush") -@documentation("Performs the flush operation on one or more indices.") -operation IndicesFlush_Post { - input: IndicesFlush_Post_Input, - output: IndicesFlush_Output -} - -@xOperationGroup("indices.flush") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_flush") -@documentation("Performs the flush operation on one or more indices.") -operation IndicesFlush_Get { - input: IndicesFlush_Get_Input, - output: IndicesFlush_Output -} - -@xOperationGroup("indices.flush") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_flush") -@documentation("Performs the flush operation on one or more indices.") -operation IndicesFlush_Post_WithIndex { - input: IndicesFlush_Post_WithIndex_Input, - output: IndicesFlush_Output -} - -@xOperationGroup("indices.flush") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_flush") -@documentation("Performs the flush operation on one or more indices.") -operation IndicesFlush_Get_WithIndex { - input: IndicesFlush_Get_WithIndex_Input, - output: IndicesFlush_Output -} diff --git a/model/indices/flush/structures.smithy b/model/indices/flush/structures.smithy deleted file mode 100644 index cbb85c19..00000000 --- a/model/indices/flush/structures.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesFlush_QueryParams { - @httpQuery("force") - force: Force, - - @httpQuery("wait_if_ongoing") - @default(true) - wait_if_ongoing: WaitIfOngoing, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, -} - - -@input -structure IndicesFlush_Post_Input with [IndicesFlush_QueryParams] { -} - -@input -structure IndicesFlush_Get_Input with [IndicesFlush_QueryParams] { -} - -@input -structure IndicesFlush_Post_WithIndex_Input with [IndicesFlush_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -@input -structure IndicesFlush_Get_WithIndex_Input with [IndicesFlush_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure IndicesFlush_Output {} diff --git a/model/indices/forcemerge/operations.smithy b/model/indices/forcemerge/operations.smithy deleted file mode 100644 index 9e9fcac9..00000000 --- a/model/indices/forcemerge/operations.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.forcemerge") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_forcemerge") -@documentation("Performs the force merge operation on one or more indices.") -operation IndicesForcemerge { - input: IndicesForcemerge_Input, - output: IndicesForcemerge_Output -} - -@xOperationGroup("indices.forcemerge") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_forcemerge") -@documentation("Performs the force merge operation on one or more indices.") -operation IndicesForcemerge_WithIndex { - input: IndicesForcemerge_WithIndex_Input, - output: IndicesForcemerge_Output -} diff --git a/model/indices/forcemerge/structures.smithy b/model/indices/forcemerge/structures.smithy deleted file mode 100644 index 81b47f46..00000000 --- a/model/indices/forcemerge/structures.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesForcemerge_QueryParams { - @httpQuery("flush") - @default(true) - flush: Flush, - - @httpQuery("primary_only") - @default(false) - primary_only: PrimaryOnly, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("max_num_segments") - max_num_segments: MaxNumSegments, - - @httpQuery("only_expunge_deletes") - only_expunge_deletes: OnlyExpungeDeletes, - - @httpQuery("wait_for_completion") - @default(true) - wait_for_completion: WaitForCompletionTrue, -} - - -@input -structure IndicesForcemerge_Input with [IndicesForcemerge_QueryParams] { -} - -@input -structure IndicesForcemerge_WithIndex_Input with [IndicesForcemerge_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure IndicesForcemerge_Output {} diff --git a/model/indices/get/operations.smithy b/model/indices/get/operations.smithy deleted file mode 100644 index c5157c6a..00000000 --- a/model/indices/get/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/index-apis/get-index/" -) - -@xOperationGroup("indices.get") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}") -@documentation("Returns information about one or more indices.") -operation IndicesGet { - input: IndicesGet_Input, - output: IndicesGet_Output -} diff --git a/model/indices/get/structures.smithy b/model/indices/get/structures.smithy deleted file mode 100644 index ebbf4595..00000000 --- a/model/indices/get/structures.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesGet_QueryParams { - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("ignore_unavailable") - @default(false) - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - @default(false) - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("flat_settings") - @default(false) - flat_settings: FlatSettings, - - @httpQuery("include_defaults") - @documentation("Whether to return all default setting for each of the indices.") - @default(false) - include_defaults: IncludeDefaults, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - - -@input -structure IndicesGet_Input with [IndicesGet_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices.") - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure IndicesGet_Output {} diff --git a/model/indices/get_alias/operations.smithy b/model/indices/get_alias/operations.smithy deleted file mode 100644 index a080ec09..00000000 --- a/model/indices/get_alias/operations.smithy +++ /dev/null @@ -1,56 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/im-plugin/index-alias/" -) - -@xOperationGroup("indices.get_alias") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_alias") -@documentation("Returns an alias.") -operation IndicesGetAlias { - input: IndicesGetAlias_Input, - output: IndicesGetAlias_Output -} - -@xOperationGroup("indices.get_alias") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_alias") -@documentation("Returns an alias.") -operation IndicesGetAlias_WithIndex { - input: IndicesGetAlias_WithIndex_Input, - output: IndicesGetAlias_Output -} - -@xOperationGroup("indices.get_alias") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_alias/{name}") -@documentation("Returns an alias.") -operation IndicesGetAlias_WithName { - input: IndicesGetAlias_WithName_Input, - output: IndicesGetAlias_Output -} - -@xOperationGroup("indices.get_alias") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_alias/{name}") -@documentation("Returns an alias.") -operation IndicesGetAlias_WithIndexName { - input: IndicesGetAlias_WithIndexName_Input, - output: IndicesGetAlias_Output -} diff --git a/model/indices/get_alias/structures.smithy b/model/indices/get_alias/structures.smithy deleted file mode 100644 index 500a65eb..00000000 --- a/model/indices/get_alias/structures.smithy +++ /dev/null @@ -1,60 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesGetAlias_QueryParams { - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("all") - expand_wildcards: ExpandWildcards, - - @httpQuery("local") - @default(false) - local: Local, -} - - -@input -structure IndicesGetAlias_Input with [IndicesGetAlias_QueryParams] { -} - -@input -structure IndicesGetAlias_WithIndex_Input with [IndicesGetAlias_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to filter aliases.") - index: PathIndices, -} - -@input -structure IndicesGetAlias_WithName_Input with [IndicesGetAlias_QueryParams] { - @required - @httpLabel - name: PathAliasNames, -} - -@input -structure IndicesGetAlias_WithIndexName_Input with [IndicesGetAlias_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to filter aliases.") - index: PathIndices, - - @required - @httpLabel - name: PathAliasNames, -} - -// TODO: Fill in Output Structure -structure IndicesGetAlias_Output {} diff --git a/model/indices/get_data_stream/operations.smithy b/model/indices/get_data_stream/operations.smithy deleted file mode 100644 index eed37e5d..00000000 --- a/model/indices/get_data_stream/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/im-plugin/data-streams/" -) - -@xOperationGroup("indices.get_data_stream") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_data_stream") -@documentation("Returns data streams.") -operation IndicesGetDataStream { - input: IndicesGetDataStream_Input, - output: IndicesGetDataStream_Output -} - -@xOperationGroup("indices.get_data_stream") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_data_stream/{name}") -@documentation("Returns data streams.") -operation IndicesGetDataStream_WithName { - input: IndicesGetDataStream_WithName_Input, - output: IndicesGetDataStream_Output -} diff --git a/model/indices/get_data_stream/structures.smithy b/model/indices/get_data_stream/structures.smithy deleted file mode 100644 index f5c60a1c..00000000 --- a/model/indices/get_data_stream/structures.smithy +++ /dev/null @@ -1,27 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesGetDataStream_QueryParams { -} - -@input -structure IndicesGetDataStream_Input with [IndicesGetDataStream_QueryParams] { -} - -@input -structure IndicesGetDataStream_WithName_Input with [IndicesGetDataStream_QueryParams] { - @required - @httpLabel - name: PathStreamNames, -} - -structure IndicesGetDataStream_Output { - data_streams: DataStreamList -} diff --git a/model/indices/get_field_mapping/operations.smithy b/model/indices/get_field_mapping/operations.smithy deleted file mode 100644 index 4444897b..00000000 --- a/model/indices/get_field_mapping/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/field-types/index/" -) - -@xOperationGroup("indices.get_field_mapping") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_mapping/field/{fields}") -@documentation("Returns mapping for one or more fields.") -operation IndicesGetFieldMapping { - input: IndicesGetFieldMapping_Input, - output: IndicesGetFieldMapping_Output -} - -@xOperationGroup("indices.get_field_mapping") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_mapping/field/{fields}") -@documentation("Returns mapping for one or more fields.") -operation IndicesGetFieldMapping_WithIndex { - input: IndicesGetFieldMapping_WithIndex_Input, - output: IndicesGetFieldMapping_Output -} diff --git a/model/indices/get_field_mapping/structures.smithy b/model/indices/get_field_mapping/structures.smithy deleted file mode 100644 index 477b8dc1..00000000 --- a/model/indices/get_field_mapping/structures.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesGetFieldMapping_QueryParams { - @httpQuery("include_defaults") - @documentation("Whether the default mapping values should be returned as well.") - include_defaults: IncludeDefaults, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("local") - @default(false) - local: Local, -} - - -@input -structure IndicesGetFieldMapping_Input with [IndicesGetFieldMapping_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of fields.") - fields: PathFields, -} - -@input -structure IndicesGetFieldMapping_WithIndex_Input with [IndicesGetFieldMapping_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices.") - index: PathIndices, - - @required - @httpLabel - @documentation("Comma-separated list of fields.") - fields: PathFields, -} - -// TODO: Fill in Output Structure -structure IndicesGetFieldMapping_Output {} diff --git a/model/indices/get_index_template/operations.smithy b/model/indices/get_index_template/operations.smithy deleted file mode 100644 index e4ef95a0..00000000 --- a/model/indices/get_index_template/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/im-plugin/index-templates/" -) - -@xOperationGroup("indices.get_index_template") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_index_template") -@documentation("Returns an index template.") -operation IndicesGetIndexTemplate { - input: IndicesGetIndexTemplate_Input, - output: IndicesGetIndexTemplate_Output -} - -@xOperationGroup("indices.get_index_template") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_index_template/{name}") -@documentation("Returns an index template.") -operation IndicesGetIndexTemplate_WithName { - input: IndicesGetIndexTemplate_WithName_Input, - output: IndicesGetIndexTemplate_Output -} diff --git a/model/indices/get_index_template/structures.smithy b/model/indices/get_index_template/structures.smithy deleted file mode 100644 index af01925e..00000000 --- a/model/indices/get_index_template/structures.smithy +++ /dev/null @@ -1,40 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesGetIndexTemplate_QueryParams { - @httpQuery("flat_settings") - @default(false) - flat_settings: FlatSettings, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("local") - @default(false) - local: Local, -} - - -@input -structure IndicesGetIndexTemplate_Input with [IndicesGetIndexTemplate_QueryParams] { -} - -@input -structure IndicesGetIndexTemplate_WithName_Input with [IndicesGetIndexTemplate_QueryParams] { - @required - @httpLabel - name: PathTemplateNames, -} - -// TODO: Fill in Output Structure -structure IndicesGetIndexTemplate_Output {} diff --git a/model/indices/get_mapping/operations.smithy b/model/indices/get_mapping/operations.smithy deleted file mode 100644 index c8044c2c..00000000 --- a/model/indices/get_mapping/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/field-types/index/#get-a-mapping" -) - -@xOperationGroup("indices.get_mapping") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_mapping") -@documentation("Returns mappings for one or more indices.") -operation IndicesGetMapping { - input: IndicesGetMapping_Input, - output: IndicesGetMapping_Output -} - -@xOperationGroup("indices.get_mapping") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_mapping") -@documentation("Returns mappings for one or more indices.") -operation IndicesGetMapping_WithIndex { - input: IndicesGetMapping_WithIndex_Input, - output: IndicesGetMapping_Output -} diff --git a/model/indices/get_mapping/structures.smithy b/model/indices/get_mapping/structures.smithy deleted file mode 100644 index 1d54c219..00000000 --- a/model/indices/get_mapping/structures.smithy +++ /dev/null @@ -1,50 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesGetMapping_QueryParams { - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("local") - @default(false) - @deprecated - @xDeprecationMessage("This parameter is a no-op and field mappings are always retrieved locally.") - @xVersionDeprecated("1.0") - local: Local, -} - - -@input -structure IndicesGetMapping_Input with [IndicesGetMapping_QueryParams] { -} - -@input -structure IndicesGetMapping_WithIndex_Input with [IndicesGetMapping_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices.") - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure IndicesGetMapping_Output {} diff --git a/model/indices/get_settings/operations.smithy b/model/indices/get_settings/operations.smithy deleted file mode 100644 index 5b430d9f..00000000 --- a/model/indices/get_settings/operations.smithy +++ /dev/null @@ -1,75 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/" -) - -@xOperationGroup("indices.get_settings") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_settings") -@documentation("Returns settings for one or more indices.") -operation IndicesGetSettings { - input: IndicesGetSettings_Input, - output: IndicesGetSettings_Output -} - -@xOperationGroup("indices.get_settings") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_settings") -@documentation("Returns settings for one or more indices.") -operation IndicesGetSettings_WithIndex { - input: IndicesGetSettings_WithIndex_Input, - output: IndicesGetSettings_Output -} - -@xOperationGroup("indices.get_settings") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_settings/{name}") -@documentation("Returns settings for one or more indices.") -operation IndicesGetSettings_WithName { - input: IndicesGetSettings_WithName_Input, - output: IndicesGetSettings_Output -} - -@xOperationGroup("indices.get_settings") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_settings/{name}") -@documentation("Returns settings for one or more indices.") -operation IndicesGetSettings_WithIndexName { - input: IndicesGetSettings_WithIndexName_Input, - output: IndicesGetSettings_Output -} - -apply IndicesGetSettings_WithIndex @examples([ - { - title: "Examples for Get settings Index Operation.", - input: { - index: "books" - }, - } -]) - -apply IndicesGetSettings_WithIndexName @examples([ - { - title: "Examples for Get settings Index-setting Operation.", - input: { - index: "books", - name: "index" - } - } -]) diff --git a/model/indices/get_settings/structures.smithy b/model/indices/get_settings/structures.smithy deleted file mode 100644 index 54e6194b..00000000 --- a/model/indices/get_settings/structures.smithy +++ /dev/null @@ -1,73 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesGetSettings_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("all") - expand_wildcards: ExpandWildcards, - - @httpQuery("flat_settings") - @default(false) - flat_settings: FlatSettings, - - @httpQuery("local") - @default(false) - local: Local, - - @httpQuery("include_defaults") - @documentation("Whether to return all default setting for each of the indices.") - @default(false) - include_defaults: IncludeDefaults, -} - - -@input -structure IndicesGetSettings_Input with [IndicesGetSettings_QueryParams] { -} - -@input -structure IndicesGetSettings_WithIndex_Input with [IndicesGetSettings_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -@input -structure IndicesGetSettings_WithName_Input with [IndicesGetSettings_QueryParams] { - @required - @httpLabel - name: PathSettingNames, -} - -@input -structure IndicesGetSettings_WithIndexName_Input with [IndicesGetSettings_QueryParams] { - @required - @httpLabel - index: PathIndices, - - @required - @httpLabel - name: PathSettingNames, -} - -// TODO: Fill in Output Structure -structure IndicesGetSettings_Output {} diff --git a/model/indices/get_template/operations.smithy b/model/indices/get_template/operations.smithy deleted file mode 100644 index 20c7e484..00000000 --- a/model/indices/get_template/operations.smithy +++ /dev/null @@ -1,35 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.get_template") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_template") -@documentation("Returns an index template.") -operation IndicesGetTemplate { - input: IndicesGetTemplate_Input, - output: IndicesGetTemplate_Output -} - -@xOperationGroup("indices.get_template") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_template/{name}") -@documentation("Returns an index template.") -operation IndicesGetTemplate_WithName { - input: IndicesGetTemplate_WithName_Input, - output: IndicesGetTemplate_Output -} diff --git a/model/indices/get_template/structures.smithy b/model/indices/get_template/structures.smithy deleted file mode 100644 index 7b1ce427..00000000 --- a/model/indices/get_template/structures.smithy +++ /dev/null @@ -1,40 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesGetTemplate_QueryParams { - @httpQuery("flat_settings") - @default(false) - flat_settings: FlatSettings, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("local") - @default(false) - local: Local, -} - - -@input -structure IndicesGetTemplate_Input with [IndicesGetTemplate_QueryParams] { -} - -@input -structure IndicesGetTemplate_WithName_Input with [IndicesGetTemplate_QueryParams] { - @required - @httpLabel - name: PathTemplateNames, -} - -// TODO: Fill in Output Structure -structure IndicesGetTemplate_Output {} diff --git a/model/indices/get_upgrade/operations.smithy b/model/indices/get_upgrade/operations.smithy deleted file mode 100644 index 0c96fc9e..00000000 --- a/model/indices/get_upgrade/operations.smithy +++ /dev/null @@ -1,35 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.get_upgrade") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_upgrade") -@documentation("The _upgrade API is no longer useful and will be removed.") -operation IndicesGetUpgrade { - input: IndicesGetUpgrade_Input, - output: IndicesGetUpgrade_Output -} - -@xOperationGroup("indices.get_upgrade") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_upgrade") -@documentation("The _upgrade API is no longer useful and will be removed.") -operation IndicesGetUpgrade_WithIndex { - input: IndicesGetUpgrade_WithIndex_Input, - output: IndicesGetUpgrade_Output -} diff --git a/model/indices/get_upgrade/structures.smithy b/model/indices/get_upgrade/structures.smithy deleted file mode 100644 index 53a8bdc8..00000000 --- a/model/indices/get_upgrade/structures.smithy +++ /dev/null @@ -1,36 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesGetUpgrade_QueryParams { - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, -} - - -@input -structure IndicesGetUpgrade_Input with [IndicesGetUpgrade_QueryParams] { -} - -@input -structure IndicesGetUpgrade_WithIndex_Input with [IndicesGetUpgrade_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure IndicesGetUpgrade_Output {} diff --git a/model/indices/indices_options.smithy b/model/indices/indices_options.smithy deleted file mode 100644 index b595c2e4..00000000 --- a/model/indices/indices_options.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesOptionsQueryParams { - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - expand_wildcards: ExpandWildcards, - - @httpQuery("ignore_throttled") - ignore_throttled: IgnoreThrottled, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, -} diff --git a/model/indices/open/operations.smithy b/model/indices/open/operations.smithy deleted file mode 100644 index 2fc1e29f..00000000 --- a/model/indices/open/operations.smithy +++ /dev/null @@ -1,22 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/index-apis/open-index/" -) - -@xOperationGroup("indices.open") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_open") -@documentation("Opens an index.") -operation IndicesOpen { - input: IndicesOpen_Input, - output: IndicesOpen_Output -} diff --git a/model/indices/open/structures.smithy b/model/indices/open/structures.smithy deleted file mode 100644 index f99cdf1a..00000000 --- a/model/indices/open/structures.smithy +++ /dev/null @@ -1,53 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesOpen_QueryParams { - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("closed") - expand_wildcards: ExpandWildcards, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("wait_for_active_shards") - @documentation("Sets the number of active shards to wait for before the operation returns.") - wait_for_active_shards: WaitForActiveShards, - - @httpQuery("wait_for_completion") - @default(true) - wait_for_completion: WaitForCompletionTrue, - - @httpQuery("task_execution_timeout") - task_execution_timeout: TaskExecutionTimeout, -} - - -@input -structure IndicesOpen_Input with [IndicesOpen_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of indices to open.") - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure IndicesOpen_Output {} diff --git a/model/indices/put_alias/operations.smithy b/model/indices/put_alias/operations.smithy deleted file mode 100644 index 282baf24..00000000 --- a/model/indices/put_alias/operations.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases" -) - -@xOperationGroup("indices.put_alias") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/{index}/_alias/{name}") -@documentation("Creates or updates an alias.") -operation IndicesPutAlias_Put { - input: IndicesPutAlias_Put_Input, - output: IndicesPutAlias_Output -} - -@xOperationGroup("indices.put_alias") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_alias/{name}") -@documentation("Creates or updates an alias.") -operation IndicesPutAlias_Post { - input: IndicesPutAlias_Post_Input, - output: IndicesPutAlias_Output -} - -@xOperationGroup("indices.put_alias") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/{index}/_aliases/{name}") -@documentation("Creates or updates an alias.") -operation IndicesPutAlias_Put_Plural { - input: IndicesPutAlias_Put_Plural_Input, - output: IndicesPutAlias_Output -} - -@xOperationGroup("indices.put_alias") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_aliases/{name}") -@documentation("Creates or updates an alias.") -operation IndicesPutAlias_Post_Plural { - input: IndicesPutAlias_Post_Plural_Input, - output: IndicesPutAlias_Output -} diff --git a/model/indices/put_alias/structures.smithy b/model/indices/put_alias/structures.smithy deleted file mode 100644 index 3def0f7d..00000000 --- a/model/indices/put_alias/structures.smithy +++ /dev/null @@ -1,79 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesPutAlias_QueryParams { - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - -// TODO: Fill in Body Parameters -@documentation("The settings for the alias, such as `routing` or `filter`") -structure IndicesPutAlias_BodyParams {} - -@input -structure IndicesPutAlias_Put_Input with [IndicesPutAlias_QueryParams] { - @required - @httpLabel - index: PathIndices, - - @required - @httpLabel - name: PathAliasName, - @httpPayload - content: IndicesPutAlias_BodyParams, -} - -@input -structure IndicesPutAlias_Post_Input with [IndicesPutAlias_QueryParams] { - @required - @httpLabel - index: PathIndices, - - @required - @httpLabel - name: PathAliasName, - @httpPayload - content: IndicesPutAlias_BodyParams, -} - -@input -structure IndicesPutAlias_Put_Plural_Input with [IndicesPutAlias_QueryParams] { - @required - @httpLabel - index: PathIndices, - - @required - @httpLabel - name: PathAliasName, - @httpPayload - content: IndicesPutAlias_BodyParams, -} - -@input -structure IndicesPutAlias_Post_Plural_Input with [IndicesPutAlias_QueryParams] { - @required - @httpLabel - index: PathIndices, - - @required - @httpLabel - name: PathAliasName, - @httpPayload - content: IndicesPutAlias_BodyParams, -} - -// TODO: Fill in Output Structure -structure IndicesPutAlias_Output {} diff --git a/model/indices/put_index_template/operations.smithy b/model/indices/put_index_template/operations.smithy deleted file mode 100644 index 7e923472..00000000 --- a/model/indices/put_index_template/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/im-plugin/index-templates/" -) - -@xOperationGroup("indices.put_index_template") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_index_template/{name}") -@documentation("Creates or updates an index template.") -operation IndicesPutIndexTemplate_Put { - input: IndicesPutIndexTemplate_Put_Input, - output: IndicesPutIndexTemplate_Output -} - -@xOperationGroup("indices.put_index_template") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_index_template/{name}") -@documentation("Creates or updates an index template.") -operation IndicesPutIndexTemplate_Post { - input: IndicesPutIndexTemplate_Post_Input, - output: IndicesPutIndexTemplate_Output -} diff --git a/model/indices/put_index_template/structures.smithy b/model/indices/put_index_template/structures.smithy deleted file mode 100644 index 30aa8db0..00000000 --- a/model/indices/put_index_template/structures.smithy +++ /dev/null @@ -1,53 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesPutIndexTemplate_QueryParams { - @httpQuery("create") - @default(false) - create: Create, - - @httpQuery("cause") - @documentation("User defined reason for creating/updating the index template.") - @default("false") - cause: Cause, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - -// TODO: Fill in Body Parameters -@documentation("The template definition") -structure IndicesPutIndexTemplate_BodyParams {} - -@input -structure IndicesPutIndexTemplate_Put_Input with [IndicesPutIndexTemplate_QueryParams] { - @required - @httpLabel - name: PathTemplateName, - @required - @httpPayload - content: IndicesPutIndexTemplate_BodyParams, -} - -@input -structure IndicesPutIndexTemplate_Post_Input with [IndicesPutIndexTemplate_QueryParams] { - @required - @httpLabel - name: PathTemplateName, - @required - @httpPayload - content: IndicesPutIndexTemplate_BodyParams, -} - -// TODO: Fill in Output Structure -structure IndicesPutIndexTemplate_Output {} diff --git a/model/indices/put_mapping/operations.smithy b/model/indices/put_mapping/operations.smithy deleted file mode 100644 index 53d84037..00000000 --- a/model/indices/put_mapping/operations.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/" -) - -@xOperationGroup("indices.put_mapping") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/{index}/_mapping") -@documentation("Updates the index mappings.") -operation IndicesPutMapping_Put { - input: IndicesPutMapping_Put_Input, - output: IndicesPutMapping_Output -} - -@xOperationGroup("indices.put_mapping") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_mapping") -@documentation("Updates the index mappings.") -operation IndicesPutMapping_Post { - input: IndicesPutMapping_Post_Input, - output: IndicesPutMapping_Output -} diff --git a/model/indices/put_mapping/structures.smithy b/model/indices/put_mapping/structures.smithy deleted file mode 100644 index 1a33e1c7..00000000 --- a/model/indices/put_mapping/structures.smithy +++ /dev/null @@ -1,62 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesPutMapping_QueryParams { - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("write_index_only") - @default(false) - write_index_only: WriteIndexOnly, -} - -// TODO: Fill in Body Parameters -@documentation("The mapping definition") -structure IndicesPutMapping_BodyParams {} - -@input -structure IndicesPutMapping_Put_Input with [IndicesPutMapping_QueryParams] { - @required - @httpLabel - index: PathIndices, - @required - @httpPayload - content: IndicesPutMapping_BodyParams, -} - -@input -structure IndicesPutMapping_Post_Input with [IndicesPutMapping_QueryParams] { - @required - @httpLabel - index: PathIndices, - @required - @httpPayload - content: IndicesPutMapping_BodyParams, -} - -structure IndicesPutMapping_Output { - acknowledged: Boolean -} diff --git a/model/indices/put_settings/operations.smithy b/model/indices/put_settings/operations.smithy deleted file mode 100644 index 5e98da2b..00000000 --- a/model/indices/put_settings/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/" -) - -@xOperationGroup("indices.put_settings") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_settings") -@documentation("Updates the index settings.") -operation IndicesPutSettings { - input: IndicesPutSettings_Input, - output: IndicesPutSettings_Output -} - -@xOperationGroup("indices.put_settings") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/{index}/_settings") -@documentation("Updates the index settings.") -operation IndicesPutSettings_WithIndex { - input: IndicesPutSettings_WithIndex_Input, - output: IndicesPutSettings_Output -} diff --git a/model/indices/put_settings/structures.smithy b/model/indices/put_settings/structures.smithy deleted file mode 100644 index be042808..00000000 --- a/model/indices/put_settings/structures.smithy +++ /dev/null @@ -1,62 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesPutSettings_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("preserve_existing") - @default(false) - preserve_existing: PreserveExisting, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("flat_settings") - @default(false) - flat_settings: FlatSettings, -} - -// TODO: Fill in Body Parameters -@documentation("The index settings to be updated") -structure IndicesPutSettings_BodyParams {} - -@input -structure IndicesPutSettings_Input with [IndicesPutSettings_QueryParams] { - @required - @httpPayload - content: IndicesPutSettings_BodyParams, -} - -@input -structure IndicesPutSettings_WithIndex_Input with [IndicesPutSettings_QueryParams] { - @required - @httpLabel - index: PathIndices, - @required - @httpPayload - content: IndicesPutSettings_BodyParams, -} - -// TODO: Fill in Output Structure -structure IndicesPutSettings_Output {} diff --git a/model/indices/put_template/operations.smithy b/model/indices/put_template/operations.smithy deleted file mode 100644 index 13f1911a..00000000 --- a/model/indices/put_template/operations.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/im-plugin/index-templates/" -) - -@xOperationGroup("indices.put_template") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_template/{name}") -@documentation("Creates or updates an index template.") -operation IndicesPutTemplate_Put { - input: IndicesPutTemplate_Put_Input, - output: IndicesPutTemplate_Output -} - -@xOperationGroup("indices.put_template") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_template/{name}") -@documentation("Creates or updates an index template.") -operation IndicesPutTemplate_Post { - input: IndicesPutTemplate_Post_Input, - output: IndicesPutTemplate_Output -} diff --git a/model/indices/put_template/structures.smithy b/model/indices/put_template/structures.smithy deleted file mode 100644 index cde3806f..00000000 --- a/model/indices/put_template/structures.smithy +++ /dev/null @@ -1,51 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesPutTemplate_QueryParams { - @httpQuery("order") - order: Order, - - @httpQuery("create") - @default(false) - create: Create, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - -// TODO: Fill in Body Parameters -@documentation("The template definition") -structure IndicesPutTemplate_BodyParams {} - -@input -structure IndicesPutTemplate_Put_Input with [IndicesPutTemplate_QueryParams] { - @required - @httpLabel - name: PathTemplateName, - @required - @httpPayload - content: IndicesPutTemplate_BodyParams, -} - -@input -structure IndicesPutTemplate_Post_Input with [IndicesPutTemplate_QueryParams] { - @required - @httpLabel - name: PathTemplateName, - @required - @httpPayload - content: IndicesPutTemplate_BodyParams, -} - -// TODO: Fill in Output Structure -structure IndicesPutTemplate_Output {} diff --git a/model/indices/recovery/operations.smithy b/model/indices/recovery/operations.smithy deleted file mode 100644 index 95b1e0f1..00000000 --- a/model/indices/recovery/operations.smithy +++ /dev/null @@ -1,35 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.recovery") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_recovery") -@documentation("Returns information about ongoing index shard recoveries.") -operation IndicesRecovery { - input: IndicesRecovery_Input, - output: IndicesRecovery_Output -} - -@xOperationGroup("indices.recovery") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_recovery") -@documentation("Returns information about ongoing index shard recoveries.") -operation IndicesRecovery_WithIndex { - input: IndicesRecovery_WithIndex_Input, - output: IndicesRecovery_Output -} diff --git a/model/indices/recovery/structures.smithy b/model/indices/recovery/structures.smithy deleted file mode 100644 index 94139931..00000000 --- a/model/indices/recovery/structures.smithy +++ /dev/null @@ -1,36 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesRecovery_QueryParams { - @httpQuery("detailed") - @documentation("Whether to display detailed information about shard recovery.") - @default(false) - detailed: Detailed, - - @httpQuery("active_only") - @documentation("Display only those recoveries that are currently on-going.") - @default(false) - active_only: ActiveOnly, -} - - -@input -structure IndicesRecovery_Input with [IndicesRecovery_QueryParams] { -} - -@input -structure IndicesRecovery_WithIndex_Input with [IndicesRecovery_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure IndicesRecovery_Output {} diff --git a/model/indices/refresh/operations.smithy b/model/indices/refresh/operations.smithy deleted file mode 100644 index ff9c575f..00000000 --- a/model/indices/refresh/operations.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability" -) - -@xOperationGroup("indices.refresh") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_refresh") -@documentation("Performs the refresh operation in one or more indices.") -operation IndicesRefresh_Post { - input: IndicesRefresh_Post_Input, - output: IndicesRefresh_Output -} - -@xOperationGroup("indices.refresh") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_refresh") -@documentation("Performs the refresh operation in one or more indices.") -operation IndicesRefresh_Get { - input: IndicesRefresh_Get_Input, - output: IndicesRefresh_Output -} - -@xOperationGroup("indices.refresh") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_refresh") -@documentation("Performs the refresh operation in one or more indices.") -operation IndicesRefresh_Post_WithIndex { - input: IndicesRefresh_Post_WithIndex_Input, - output: IndicesRefresh_Output -} - -@xOperationGroup("indices.refresh") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_refresh") -@documentation("Performs the refresh operation in one or more indices.") -operation IndicesRefresh_Get_WithIndex { - input: IndicesRefresh_Get_WithIndex_Input, - output: IndicesRefresh_Output -} diff --git a/model/indices/refresh/structures.smithy b/model/indices/refresh/structures.smithy deleted file mode 100644 index ffe6d9ab..00000000 --- a/model/indices/refresh/structures.smithy +++ /dev/null @@ -1,47 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesRefresh_QueryParams { - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, -} - - -@input -structure IndicesRefresh_Post_Input with [IndicesRefresh_QueryParams] { -} - -@input -structure IndicesRefresh_Get_Input with [IndicesRefresh_QueryParams] { -} - -@input -structure IndicesRefresh_Post_WithIndex_Input with [IndicesRefresh_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -@input -structure IndicesRefresh_Get_WithIndex_Input with [IndicesRefresh_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure IndicesRefresh_Output {} diff --git a/model/indices/resolve_index/operations.smithy b/model/indices/resolve_index/operations.smithy deleted file mode 100644 index 8e8aaa3a..00000000 --- a/model/indices/resolve_index/operations.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.resolve_index") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_resolve/index/{name}") -@documentation("Returns information about any matching indices, aliases, and data streams.") -operation IndicesResolveIndex { - input: IndicesResolveIndex_Input, - output: IndicesResolveIndex_Output -} diff --git a/model/indices/resolve_index/structures.smithy b/model/indices/resolve_index/structures.smithy deleted file mode 100644 index c62d0002..00000000 --- a/model/indices/resolve_index/structures.smithy +++ /dev/null @@ -1,26 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesResolveIndex_QueryParams { - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, -} - - -@input -structure IndicesResolveIndex_Input with [IndicesResolveIndex_QueryParams] { - @required - @httpLabel - name: PathIndexNames, -} - -// TODO: Fill in Output Structure -structure IndicesResolveIndex_Output {} diff --git a/model/indices/rollover/operations.smithy b/model/indices/rollover/operations.smithy deleted file mode 100644 index ee0a5eb6..00000000 --- a/model/indices/rollover/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/" -) - -@xOperationGroup("indices.rollover") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{alias}/_rollover") -@documentation("Updates an alias to point to a new index when the existing index -is considered to be too large or too old.") -operation IndicesRollover { - input: IndicesRollover_Input, - output: IndicesRollover_Output -} - -@xOperationGroup("indices.rollover") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{alias}/_rollover/{new_index}") -@documentation("Updates an alias to point to a new index when the existing index -is considered to be too large or too old.") -operation IndicesRollover_WithNewIndex { - input: IndicesRollover_WithNewIndex_Input, - output: IndicesRollover_Output -} diff --git a/model/indices/rollover/structures.smithy b/model/indices/rollover/structures.smithy deleted file mode 100644 index f5f20bbc..00000000 --- a/model/indices/rollover/structures.smithy +++ /dev/null @@ -1,57 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesRollover_QueryParams { - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("dry_run") - @default(false) - dry_run: IndicesRolloverDryRun, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("wait_for_active_shards") - @documentation("Set the number of active shards to wait for on the newly created rollover index before the operation returns.") - wait_for_active_shards: WaitForActiveShards, -} - -// TODO: Fill in Body Parameters -@documentation("The conditions that needs to be met for executing rollover") -structure IndicesRollover_BodyParams {} - -@input -structure IndicesRollover_Input with [IndicesRollover_QueryParams] { - @required - @httpLabel - alias: PathAlias, - @httpPayload - content: IndicesRollover_BodyParams, -} - -@input -structure IndicesRollover_WithNewIndex_Input with [IndicesRollover_QueryParams] { - @required - @httpLabel - alias: PathAlias, - - @required - @httpLabel - new_index: PathNewIndex, - @httpPayload - content: IndicesRollover_BodyParams, -} - -// TODO: Fill in Output Structure -structure IndicesRollover_Output {} diff --git a/model/indices/segments/operations.smithy b/model/indices/segments/operations.smithy deleted file mode 100644 index 67286549..00000000 --- a/model/indices/segments/operations.smithy +++ /dev/null @@ -1,35 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.segments") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_segments") -@documentation("Provides low-level information about segments in a Lucene index.") -operation IndicesSegments { - input: IndicesSegments_Input, - output: IndicesSegments_Output -} - -@xOperationGroup("indices.segments") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_segments") -@documentation("Provides low-level information about segments in a Lucene index.") -operation IndicesSegments_WithIndex { - input: IndicesSegments_WithIndex_Input, - output: IndicesSegments_Output -} diff --git a/model/indices/segments/structures.smithy b/model/indices/segments/structures.smithy deleted file mode 100644 index 09a094bc..00000000 --- a/model/indices/segments/structures.smithy +++ /dev/null @@ -1,41 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesSegments_QueryParams { - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("verbose") - @documentation("Includes detailed memory usage by Lucene.") - @default(false) - verbose: Verbose, -} - - -@input -structure IndicesSegments_Input with [IndicesSegments_QueryParams] { -} - -@input -structure IndicesSegments_WithIndex_Input with [IndicesSegments_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure IndicesSegments_Output {} diff --git a/model/indices/shard_stores/operations.smithy b/model/indices/shard_stores/operations.smithy deleted file mode 100644 index d9daef10..00000000 --- a/model/indices/shard_stores/operations.smithy +++ /dev/null @@ -1,35 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.shard_stores") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_shard_stores") -@documentation("Provides store information for shard copies of indices.") -operation IndicesShardStores { - input: IndicesShardStores_Input, - output: IndicesShardStores_Output -} - -@xOperationGroup("indices.shard_stores") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_shard_stores") -@documentation("Provides store information for shard copies of indices.") -operation IndicesShardStores_WithIndex { - input: IndicesShardStores_WithIndex_Input, - output: IndicesShardStores_Output -} diff --git a/model/indices/shard_stores/structures.smithy b/model/indices/shard_stores/structures.smithy deleted file mode 100644 index 54d3b534..00000000 --- a/model/indices/shard_stores/structures.smithy +++ /dev/null @@ -1,39 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesShardStores_QueryParams { - @httpQuery("status") - status: Status, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, -} - - -@input -structure IndicesShardStores_Input with [IndicesShardStores_QueryParams] { -} - -@input -structure IndicesShardStores_WithIndex_Input with [IndicesShardStores_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure IndicesShardStores_Output {} diff --git a/model/indices/shrink/operations.smithy b/model/indices/shrink/operations.smithy deleted file mode 100644 index b2a8bafc..00000000 --- a/model/indices/shrink/operations.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/" -) - -@xOperationGroup("indices.shrink") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/{index}/_shrink/{target}") -@documentation("Allow to shrink an existing index into a new index with fewer primary shards.") -operation IndicesShrink_Put { - input: IndicesShrink_Put_Input, - output: IndicesShrink_Output -} - -@xOperationGroup("indices.shrink") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_shrink/{target}") -@documentation("Allow to shrink an existing index into a new index with fewer primary shards.") -operation IndicesShrink_Post { - input: IndicesShrink_Post_Input, - output: IndicesShrink_Output -} diff --git a/model/indices/shrink/structures.smithy b/model/indices/shrink/structures.smithy deleted file mode 100644 index 5fdb7d99..00000000 --- a/model/indices/shrink/structures.smithy +++ /dev/null @@ -1,70 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesShrink_QueryParams { - @httpQuery("copy_settings") - @default(false) - copy_settings: CopySettings, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("wait_for_active_shards") - @documentation("Set the number of active shards to wait for on the shrunken index before the operation returns.") - wait_for_active_shards: WaitForActiveShards, - - @httpQuery("wait_for_completion") - @default(true) - wait_for_completion: WaitForCompletionTrue, - - @httpQuery("task_execution_timeout") - task_execution_timeout: TaskExecutionTimeout, -} - -// TODO: Fill in Body Parameters -@documentation("The configuration for the target index (`settings` and `aliases`)") -structure IndicesShrink_BodyParams {} - -@input -structure IndicesShrink_Put_Input with [IndicesShrink_QueryParams] { - @required - @httpLabel - @documentation("The name of the source index to shrink.") - index: PathIndex, - - @required - @httpLabel - target: PathTarget, - @httpPayload - content: IndicesShrink_BodyParams, -} - -@input -structure IndicesShrink_Post_Input with [IndicesShrink_QueryParams] { - @required - @httpLabel - @documentation("The name of the source index to shrink.") - index: PathIndex, - - @required - @httpLabel - target: PathTarget, - @httpPayload - content: IndicesShrink_BodyParams, -} - -// TODO: Fill in Output Structure -structure IndicesShrink_Output {} diff --git a/model/indices/simulate_index_template/operations.smithy b/model/indices/simulate_index_template/operations.smithy deleted file mode 100644 index ada9e199..00000000 --- a/model/indices/simulate_index_template/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.simulate_index_template") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_index_template/_simulate_index/{name}") -@documentation("Simulate matching the given index name against the index templates in the system.") -operation IndicesSimulateIndexTemplate { - input: IndicesSimulateIndexTemplate_Input, - output: IndicesSimulateIndexTemplate_Output -} diff --git a/model/indices/simulate_index_template/structures.smithy b/model/indices/simulate_index_template/structures.smithy deleted file mode 100644 index 1c9e646a..00000000 --- a/model/indices/simulate_index_template/structures.smithy +++ /dev/null @@ -1,42 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesSimulateIndexTemplate_QueryParams { - @httpQuery("create") - @documentation("Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one.") - @default(false) - create: Create, - - @httpQuery("cause") - @default("false") - cause: Cause, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - -// TODO: Fill in Body Parameters -@documentation("New index template definition, which will be included in the simulation, as if it already exists in the system") -structure IndicesSimulateIndexTemplate_BodyParams {} - -@input -structure IndicesSimulateIndexTemplate_Input with [IndicesSimulateIndexTemplate_QueryParams] { - @required - @httpLabel - name: PathIndexName, - @httpPayload - content: IndicesSimulateIndexTemplate_BodyParams, -} - -// TODO: Fill in Output Structure -structure IndicesSimulateIndexTemplate_Output {} diff --git a/model/indices/simulate_template/operations.smithy b/model/indices/simulate_template/operations.smithy deleted file mode 100644 index 4cefc5fc..00000000 --- a/model/indices/simulate_template/operations.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.simulate_template") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_index_template/_simulate") -@documentation("Simulate resolving the given template name or body.") -operation IndicesSimulateTemplate { - input: IndicesSimulateTemplate_Input, - output: IndicesSimulateTemplate_Output -} - -@xOperationGroup("indices.simulate_template") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_index_template/_simulate/{name}") -@documentation("Simulate resolving the given template name or body.") -operation IndicesSimulateTemplate_WithName { - input: IndicesSimulateTemplate_WithName_Input, - output: IndicesSimulateTemplate_Output -} diff --git a/model/indices/simulate_template/structures.smithy b/model/indices/simulate_template/structures.smithy deleted file mode 100644 index 77312c80..00000000 --- a/model/indices/simulate_template/structures.smithy +++ /dev/null @@ -1,48 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesSimulateTemplate_QueryParams { - @httpQuery("create") - @documentation("Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one.") - @default(false) - create: Create, - - @httpQuery("cause") - @default("false") - cause: Cause, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - -// TODO: Fill in Body Parameters -@documentation("New index template definition to be simulated, if no index template name is specified") -structure IndicesSimulateTemplate_BodyParams {} - -@input -structure IndicesSimulateTemplate_Input with [IndicesSimulateTemplate_QueryParams] { - @httpPayload - content: IndicesSimulateTemplate_BodyParams, -} - -@input -structure IndicesSimulateTemplate_WithName_Input with [IndicesSimulateTemplate_QueryParams] { - @required - @httpLabel - name: PathTemplateName, - @httpPayload - content: IndicesSimulateTemplate_BodyParams, -} - -// TODO: Fill in Output Structure -structure IndicesSimulateTemplate_Output {} diff --git a/model/indices/split/operations.smithy b/model/indices/split/operations.smithy deleted file mode 100644 index c45c28d3..00000000 --- a/model/indices/split/operations.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/index-apis/split/" -) - -@xOperationGroup("indices.split") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/{index}/_split/{target}") -@documentation("Allows you to split an existing index into a new index with more primary shards.") -operation IndicesSplit_Put { - input: IndicesSplit_Put_Input, - output: IndicesSplit_Output -} - -@xOperationGroup("indices.split") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_split/{target}") -@documentation("Allows you to split an existing index into a new index with more primary shards.") -operation IndicesSplit_Post { - input: IndicesSplit_Post_Input, - output: IndicesSplit_Output -} diff --git a/model/indices/split/structures.smithy b/model/indices/split/structures.smithy deleted file mode 100644 index c21d1c74..00000000 --- a/model/indices/split/structures.smithy +++ /dev/null @@ -1,70 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesSplit_QueryParams { - @httpQuery("copy_settings") - @default(false) - copy_settings: CopySettings, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("wait_for_active_shards") - @documentation("Set the number of active shards to wait for on the shrunken index before the operation returns.") - wait_for_active_shards: WaitForActiveShards, - - @httpQuery("wait_for_completion") - @default(true) - wait_for_completion: WaitForCompletionTrue, - - @httpQuery("task_execution_timeout") - task_execution_timeout: TaskExecutionTimeout, -} - -// TODO: Fill in Body Parameters -@documentation("The configuration for the target index (`settings` and `aliases`)") -structure IndicesSplit_BodyParams {} - -@input -structure IndicesSplit_Put_Input with [IndicesSplit_QueryParams] { - @required - @httpLabel - @documentation("The name of the source index to split.") - index: PathIndex, - - @required - @httpLabel - target: PathTarget, - @httpPayload - content: IndicesSplit_BodyParams, -} - -@input -structure IndicesSplit_Post_Input with [IndicesSplit_QueryParams] { - @required - @httpLabel - @documentation("The name of the source index to split.") - index: PathIndex, - - @required - @httpLabel - target: PathTarget, - @httpPayload - content: IndicesSplit_BodyParams, -} - -// TODO: Fill in Output Structure -structure IndicesSplit_Output {} diff --git a/model/indices/stats/operations.smithy b/model/indices/stats/operations.smithy deleted file mode 100644 index 66fe88f7..00000000 --- a/model/indices/stats/operations.smithy +++ /dev/null @@ -1,57 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_stats") -@documentation("Provides statistics on operations happening in an index.") -operation IndicesStats { - input: IndicesStats_Input, - output: IndicesStats_Output -} - -@xOperationGroup("indices.stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_stats") -@documentation("Provides statistics on operations happening in an index.") -operation IndicesStats_WithIndex { - input: IndicesStats_WithIndex_Input, - output: IndicesStats_Output -} - -@xOperationGroup("indices.stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_stats/{metric}") -@documentation("Provides statistics on operations happening in an index.") -operation IndicesStats_WithMetric { - input: IndicesStats_WithMetric_Input, - output: IndicesStats_Output -} - -@xOperationGroup("indices.stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_stats/{metric}") -@documentation("Provides statistics on operations happening in an index.") -operation IndicesStats_WithIndexMetric { - input: IndicesStats_WithIndexMetric_Input, - output: IndicesStats_Output -} diff --git a/model/indices/stats/structures.smithy b/model/indices/stats/structures.smithy deleted file mode 100644 index 58165acd..00000000 --- a/model/indices/stats/structures.smithy +++ /dev/null @@ -1,77 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesStats_QueryParams { - @httpQuery("completion_fields") - completion_fields: CompletionFields, - - @httpQuery("fielddata_fields") - fielddata_fields: FielddataFields, - - @httpQuery("fields") - @documentation("Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).") - fields: Fields, - - @httpQuery("groups") - groups: Groups, - - @httpQuery("level") - @default("indices") - level: IndiciesStatLevel, - - @httpQuery("include_segment_file_sizes") - @default(false) - include_segment_file_sizes: IncludeSegmentFileSizes, - - @httpQuery("include_unloaded_segments") - @default(false) - include_unloaded_segments: IncludeUnloadedSegments, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("forbid_closed_indices") - @default(true) - forbid_closed_indices: ForbidClosedIndices, -} - - -@input -structure IndicesStats_Input with [IndicesStats_QueryParams] { -} - -@input -structure IndicesStats_WithIndex_Input with [IndicesStats_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -@input -structure IndicesStats_WithMetric_Input with [IndicesStats_QueryParams] { - @required - @httpLabel - metric: PathIndicesStatsMetric, -} - -@input -structure IndicesStats_WithIndexMetric_Input with [IndicesStats_QueryParams] { - @required - @httpLabel - index: PathIndices, - - @required - @httpLabel - metric: PathIndicesStatsMetric, -} - -// TODO: Fill in Output Structure -structure IndicesStats_Output {} diff --git a/model/indices/update_aliases/operations.smithy b/model/indices/update_aliases/operations.smithy deleted file mode 100644 index 900d6da4..00000000 --- a/model/indices/update_aliases/operations.smithy +++ /dev/null @@ -1,22 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/alias/" -) - -@xOperationGroup("indices.update_aliases") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_aliases") -@documentation("Updates index aliases.") -operation IndicesUpdateAliases { - input: IndicesUpdateAliases_Input, - output: IndicesUpdateAliases_Output -} diff --git a/model/indices/update_aliases/structures.smithy b/model/indices/update_aliases/structures.smithy deleted file mode 100644 index c54028c8..00000000 --- a/model/indices/update_aliases/structures.smithy +++ /dev/null @@ -1,73 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesUpdateAliases_QueryParams { - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - -@documentation("The definition of `actions` to perform") -structure IndicesUpdateAliases_BodyParams { - actions: ActionObjectStructure -} - -structure ActionObjectStructure { - - add: UserDefinedStructure, - - remove: UserDefinedStructure, - - remove_index: UserDefinedStructure - -} - -structure UserDefinedStructure{ - - alias: String, - - aliases: UserDefinedValueList, - - filter: Document, - - index: String, - - indices: UserDefinedValueList, - - index_routing: String, - - is_hidden: Boolean, - - is_write_index: Boolean, - - must_exist: String, - - routing: String, - - search_routing: String - -} - -@input -structure IndicesUpdateAliases_Input with [IndicesUpdateAliases_QueryParams] { - @required - @httpPayload - content: IndicesUpdateAliases_BodyParams, -} - -structure IndicesUpdateAliases_Output { - @required - acknowledged:Boolean -} diff --git a/model/indices/upgrade/operations.smithy b/model/indices/upgrade/operations.smithy deleted file mode 100644 index a2a1fa2a..00000000 --- a/model/indices/upgrade/operations.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.upgrade") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_upgrade") -@documentation("The _upgrade API is no longer useful and will be removed.") -operation IndicesUpgrade { - input: IndicesUpgrade_Input, - output: IndicesUpgrade_Output -} - -@xOperationGroup("indices.upgrade") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_upgrade") -@documentation("The _upgrade API is no longer useful and will be removed.") -operation IndicesUpgrade_WithIndex { - input: IndicesUpgrade_WithIndex_Input, - output: IndicesUpgrade_Output -} diff --git a/model/indices/upgrade/structures.smithy b/model/indices/upgrade/structures.smithy deleted file mode 100644 index 7866b8ca..00000000 --- a/model/indices/upgrade/structures.smithy +++ /dev/null @@ -1,43 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesUpgrade_QueryParams { - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("wait_for_completion") - @default(false) - wait_for_completion: WaitForCompletionFalse, - - @httpQuery("only_ancient_segments") - only_ancient_segments: OnlyAncientSegments, -} - - -@input -structure IndicesUpgrade_Input with [IndicesUpgrade_QueryParams] { -} - -@input -structure IndicesUpgrade_WithIndex_Input with [IndicesUpgrade_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure IndicesUpgrade_Output {} diff --git a/model/indices/validate_query/operations.smithy b/model/indices/validate_query/operations.smithy deleted file mode 100644 index 646de918..00000000 --- a/model/indices/validate_query/operations.smithy +++ /dev/null @@ -1,55 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("indices.validate_query") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_validate/query") -@documentation("Allows a user to validate a potentially expensive query without executing it.") -operation IndicesValidateQuery_Get { - input: IndicesValidateQuery_Get_Input, - output: IndicesValidateQuery_Output -} - -@xOperationGroup("indices.validate_query") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_validate/query") -@documentation("Allows a user to validate a potentially expensive query without executing it.") -operation IndicesValidateQuery_Post { - input: IndicesValidateQuery_Post_Input, - output: IndicesValidateQuery_Output -} - -@xOperationGroup("indices.validate_query") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/{index}/_validate/query") -@documentation("Allows a user to validate a potentially expensive query without executing it.") -operation IndicesValidateQuery_Get_WithIndex { - input: IndicesValidateQuery_Get_WithIndex_Input, - output: IndicesValidateQuery_Output -} - -@xOperationGroup("indices.validate_query") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/{index}/_validate/query") -@documentation("Allows a user to validate a potentially expensive query without executing it.") -operation IndicesValidateQuery_Post_WithIndex { - input: IndicesValidateQuery_Post_WithIndex_Input, - output: IndicesValidateQuery_Output -} diff --git a/model/indices/validate_query/structures.smithy b/model/indices/validate_query/structures.smithy deleted file mode 100644 index 7d7cae83..00000000 --- a/model/indices/validate_query/structures.smithy +++ /dev/null @@ -1,84 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IndicesValidateQuery_QueryParams { - @httpQuery("explain") - @documentation("Return detailed information about the error.") - explain: Explain, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("q") - q: Q, - - @httpQuery("analyzer") - analyzer: Analyzer, - - @httpQuery("analyze_wildcard") - @default(false) - analyze_wildcard: AnalyzeWildcard, - - @httpQuery("default_operator") - @default("OR") - default_operator: DefaultOperator, - - @httpQuery("df") - df: Df, - - @httpQuery("lenient") - lenient: Lenient, - - @httpQuery("rewrite") - rewrite: Rewrite, - - @httpQuery("all_shards") - all_shards: AllShards, -} - -// TODO: Fill in Body Parameters -@documentation("The query definition specified with the Query DSL") -structure IndicesValidateQuery_BodyParams {} - -@input -structure IndicesValidateQuery_Get_Input with [IndicesValidateQuery_QueryParams] { -} - -@input -structure IndicesValidateQuery_Post_Input with [IndicesValidateQuery_QueryParams] { - @httpPayload - content: IndicesValidateQuery_BodyParams, -} - -@input -structure IndicesValidateQuery_Get_WithIndex_Input with [IndicesValidateQuery_QueryParams] { - @required - @httpLabel - index: PathIndices, -} - -@input -structure IndicesValidateQuery_Post_WithIndex_Input with [IndicesValidateQuery_QueryParams] { - @required - @httpLabel - index: PathIndices, - @httpPayload - content: IndicesValidateQuery_BodyParams, -} - -// TODO: Fill in Output Structure -structure IndicesValidateQuery_Output {} diff --git a/model/ingest/delete_pipeline/operations.smithy b/model/ingest/delete_pipeline/operations.smithy deleted file mode 100644 index 7bd68b60..00000000 --- a/model/ingest/delete_pipeline/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/" -) - -@xOperationGroup("ingest.delete_pipeline") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_ingest/pipeline/{id}") -@documentation("Deletes a pipeline.") -operation IngestDeletePipeline { - input: IngestDeletePipeline_Input, - output: IngestDeletePipeline_Output -} diff --git a/model/ingest/delete_pipeline/structures.smithy b/model/ingest/delete_pipeline/structures.smithy deleted file mode 100644 index 54007625..00000000 --- a/model/ingest/delete_pipeline/structures.smithy +++ /dev/null @@ -1,31 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IngestDeletePipeline_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("timeout") - timeout: Timeout, -} - - -@input -structure IngestDeletePipeline_Input with [IngestDeletePipeline_QueryParams] { - @required - @httpLabel - id: PathPipelineId, -} - -// TODO: Fill in Output Structure -structure IngestDeletePipeline_Output {} diff --git a/model/ingest/get_pipeline/operations.smithy b/model/ingest/get_pipeline/operations.smithy deleted file mode 100644 index 32326b35..00000000 --- a/model/ingest/get_pipeline/operations.smithy +++ /dev/null @@ -1,35 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/" -) - -@xOperationGroup("ingest.get_pipeline") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_ingest/pipeline") -@documentation("Returns a pipeline.") -operation IngestGetPipeline { - input: IngestGetPipeline_Input, - output: IngestGetPipeline_Output -} - -@xOperationGroup("ingest.get_pipeline") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_ingest/pipeline/{id}") -@documentation("Returns a pipeline.") -operation IngestGetPipeline_WithId { - input: IngestGetPipeline_WithId_Input, - output: IngestGetPipeline_Output -} diff --git a/model/ingest/get_pipeline/structures.smithy b/model/ingest/get_pipeline/structures.smithy deleted file mode 100644 index 15d38585..00000000 --- a/model/ingest/get_pipeline/structures.smithy +++ /dev/null @@ -1,32 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IngestGetPipeline_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - - -@input -structure IngestGetPipeline_Input with [IngestGetPipeline_QueryParams] { -} - -@input -structure IngestGetPipeline_WithId_Input with [IngestGetPipeline_QueryParams] { - @required - @httpLabel - id: PathPipelineIds, -} - -// TODO: Fill in Output Structure -structure IngestGetPipeline_Output {} diff --git a/model/ingest/processor_grok/operations.smithy b/model/ingest/processor_grok/operations.smithy deleted file mode 100644 index e7f149c8..00000000 --- a/model/ingest/processor_grok/operations.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("ingest.processor_grok") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_ingest/processor/grok") -@documentation("Returns a list of the built-in patterns.") -operation IngestProcessorGrok { - input: IngestProcessorGrok_Input, - output: IngestProcessorGrok_Output -} diff --git a/model/ingest/processor_grok/structures.smithy b/model/ingest/processor_grok/structures.smithy deleted file mode 100644 index 50465890..00000000 --- a/model/ingest/processor_grok/structures.smithy +++ /dev/null @@ -1,20 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IngestProcessorGrok_QueryParams { -} - - -@input -structure IngestProcessorGrok_Input with [IngestProcessorGrok_QueryParams] { -} - -// TODO: Fill in Output Structure -structure IngestProcessorGrok_Output {} diff --git a/model/ingest/put_pipeline/operations.smithy b/model/ingest/put_pipeline/operations.smithy deleted file mode 100644 index 38a755ba..00000000 --- a/model/ingest/put_pipeline/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/" -) - -@xOperationGroup("ingest.put_pipeline") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_ingest/pipeline/{id}") -@documentation("Creates or updates a pipeline.") -operation IngestPutPipeline { - input: IngestPutPipeline_Input, - output: IngestPutPipeline_Output -} diff --git a/model/ingest/put_pipeline/structures.smithy b/model/ingest/put_pipeline/structures.smithy deleted file mode 100644 index afc239bb..00000000 --- a/model/ingest/put_pipeline/structures.smithy +++ /dev/null @@ -1,37 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IngestPutPipeline_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("timeout") - timeout: Timeout, -} - -// TODO: Fill in Body Parameters -@documentation("The ingest definition") -structure IngestPutPipeline_BodyParams {} - -@input -structure IngestPutPipeline_Input with [IngestPutPipeline_QueryParams] { - @required - @httpLabel - id: PathPipelineId, - @required - @httpPayload - content: IngestPutPipeline_BodyParams, -} - -// TODO: Fill in Output Structure -structure IngestPutPipeline_Output {} diff --git a/model/ingest/simulate/operations.smithy b/model/ingest/simulate/operations.smithy deleted file mode 100644 index 7ab7fa5a..00000000 --- a/model/ingest/simulate/operations.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/" -) - -@xOperationGroup("ingest.simulate") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_ingest/pipeline/_simulate") -@documentation("Allows to simulate a pipeline with example documents.") -operation IngestSimulate_Get { - input: IngestSimulate_Get_Input, - output: IngestSimulate_Output -} - -@xOperationGroup("ingest.simulate") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_ingest/pipeline/_simulate") -@documentation("Allows to simulate a pipeline with example documents.") -operation IngestSimulate_Post { - input: IngestSimulate_Post_Input, - output: IngestSimulate_Output -} - -@xOperationGroup("ingest.simulate") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_ingest/pipeline/{id}/_simulate") -@documentation("Allows to simulate a pipeline with example documents.") -operation IngestSimulate_Get_WithId { - input: IngestSimulate_Get_WithId_Input, - output: IngestSimulate_Output -} - -@xOperationGroup("ingest.simulate") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_ingest/pipeline/{id}/_simulate") -@documentation("Allows to simulate a pipeline with example documents.") -operation IngestSimulate_Post_WithId { - input: IngestSimulate_Post_WithId_Input, - output: IngestSimulate_Output -} diff --git a/model/ingest/simulate/structures.smithy b/model/ingest/simulate/structures.smithy deleted file mode 100644 index 0b152540..00000000 --- a/model/ingest/simulate/structures.smithy +++ /dev/null @@ -1,51 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure IngestSimulate_QueryParams { - @httpQuery("verbose") - @documentation("Verbose mode. Display data output for each processor in executed pipeline.") - @default(false) - verbose: Verbose, -} - -// TODO: Fill in Body Parameters -@documentation("The simulate definition") -structure IngestSimulate_BodyParams {} - -@input -structure IngestSimulate_Get_Input with [IngestSimulate_QueryParams] { -} - -@input -structure IngestSimulate_Post_Input with [IngestSimulate_QueryParams] { - @required - @httpPayload - content: IngestSimulate_BodyParams, -} - -@input -structure IngestSimulate_Get_WithId_Input with [IngestSimulate_QueryParams] { - @required - @httpLabel - id: PathPipelineId, -} - -@input -structure IngestSimulate_Post_WithId_Input with [IngestSimulate_QueryParams] { - @required - @httpLabel - id: PathPipelineId, - @required - @httpPayload - content: IngestSimulate_BodyParams, -} - -// TODO: Fill in Output Structure -structure IngestSimulate_Output {} diff --git a/model/knn/delete_model/operations.smithy b/model/knn/delete_model/operations.smithy deleted file mode 100644 index 7bc4459f..00000000 --- a/model/knn/delete_model/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/knn/api/#delete-model" -) - -@xOperationGroup("knn.delete_model") -@xVersionAdded("1.0") -@suppress(["HttpMethodSemantics.UnexpectedPayload"]) -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_plugins/_knn/models/{model_id}") -@documentation("Used to delete a particular model in the cluster.") -operation KNNDeleteModel { - input: KNNDeleteModel_Input, - output: KNNDeleteModel_Output -} diff --git a/model/knn/delete_model/structures.smithy b/model/knn/delete_model/structures.smithy deleted file mode 100644 index 2f9fe30e..00000000 --- a/model/knn/delete_model/structures.smithy +++ /dev/null @@ -1,18 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure KNNDeleteModel_Input { - @required - @httpLabel - model_id: PathModelId, -} - -// TODO: Fill in Output Structure -structure KNNDeleteModel_Output {} diff --git a/model/knn/get_model/operations.smithy b/model/knn/get_model/operations.smithy deleted file mode 100644 index 55767868..00000000 --- a/model/knn/get_model/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/knn/api/#get-model" -) - -@xOperationGroup("knn.get_model") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_knn/models/{model_id}") -@documentation("Used to retrieve information about models present in the cluster.") -operation KNNGetModel { - input: KNNGetModel_Input, - output: KNNGetModel_Output -} diff --git a/model/knn/get_model/structures.smithy b/model/knn/get_model/structures.smithy deleted file mode 100644 index ad0bafd4..00000000 --- a/model/knn/get_model/structures.smithy +++ /dev/null @@ -1,18 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure KNNGetModel_Input { - @required - @httpLabel - model_id: PathModelId, -} - -// TODO: Fill in Output Structure -structure KNNGetModel_Output {} diff --git a/model/knn/search_model/operations.smithy b/model/knn/search_model/operations.smithy deleted file mode 100644 index a6becc93..00000000 --- a/model/knn/search_model/operations.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/knn/api/#search-model" -) - -@xOperationGroup("knn.search_models") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_knn/models/_search") -@documentation("Use an OpenSearch query to search for models in the index.") -operation KNNSearchModels_Get { - input: KNNSearchModels_Get_Input, - output: KNNSearchModels_Output -} - -@xOperationGroup("knn.search_models") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_plugins/_knn/models/_search") -@documentation("Use an OpenSearch query to search for models in the index.") -operation KNNSearchModels_Post { - input: KNNSearchModels_Post_Input, - output: KNNSearchModels_Output -} diff --git a/model/knn/search_model/structures.smithy b/model/knn/search_model/structures.smithy deleted file mode 100644 index c21a945f..00000000 --- a/model/knn/search_model/structures.smithy +++ /dev/null @@ -1,167 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure KNNSearchModels_QueryParams { - @httpQuery("analyzer") - analyzer: Analyzer, - - @httpQuery("analyze_wildcard") - @default(false) - analyze_wildcard: AnalyzeWildcard, - - @httpQuery("ccs_minimize_roundtrips") - @default(true) - ccs_minimize_roundtrips: CcsMinimizeRoundtrips, - - @httpQuery("default_operator") - @default("OR") - default_operator: DefaultOperator, - - @httpQuery("df") - df: Df, - - @httpQuery("explain") - @documentation("Specify whether to return detailed information about score computation as part of a hit.") - explain: Explain, - - @httpQuery("stored_fields") - stored_fields: StoredFields, - - @httpQuery("docvalue_fields") - docvalue_fields: DocvalueFields, - - @httpQuery("from") - @default(0) - from: From, - - @httpQuery("ignore_unavailable") - ignore_unavailable: IgnoreUnavailable, - - @httpQuery("ignore_throttled") - ignore_throttled: IgnoreThrottled, - - @httpQuery("allow_no_indices") - allow_no_indices: AllowNoIndices, - - @httpQuery("expand_wildcards") - @default("open") - expand_wildcards: ExpandWildcards, - - @httpQuery("lenient") - lenient: Lenient, - - @httpQuery("preference") - @default("random") - preference: Preference, - - @httpQuery("q") - q: Q, - - @httpQuery("routing") - routing: Routings, - - @httpQuery("scroll") - scroll: Scroll, - - @httpQuery("search_type") - search_type: SearchType, - - @httpQuery("size") - @documentation("Number of hits to return.") - @default(10) - size: Size, - - @httpQuery("sort") - sort: Sort, - - @httpQuery("_source") - _source: Source, - - @httpQuery("_source_excludes") - _source_excludes: SourceExcludes, - - @httpQuery("_source_includes") - _source_includes: SourceIncludes, - - @httpQuery("terminate_after") - terminate_after: TerminateAfter, - - @httpQuery("stats") - stats: Stats, - - @httpQuery("suggest_field") - suggest_field: SuggestField, - - @httpQuery("suggest_mode") - @default("missing") - suggest_mode: SuggestMode, - - @httpQuery("suggest_size") - suggest_size: SuggestSize, - - @httpQuery("suggest_text") - suggest_text: SuggestText, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("track_scores") - track_scores: TrackScores, - - @httpQuery("track_total_hits") - track_total_hits: TrackTotalHits, - - @httpQuery("allow_partial_search_results") - @default(true) - allow_partial_search_results: AllowPartialSearchResults, - - @httpQuery("typed_keys") - typed_keys: TypedKeys, - - @httpQuery("version") - version: WithVersion, - - @httpQuery("seq_no_primary_term") - seq_no_primary_term: SeqNoPrimaryTerm, - - @httpQuery("request_cache") - request_cache: RequestCache, - - @httpQuery("batched_reduce_size") - @default(512) - batched_reduce_size: BatchedReduceSize, - - @httpQuery("max_concurrent_shard_requests") - @documentation("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.") - @default(5) - max_concurrent_shard_requests: MaxConcurrentShardRequests, - - @httpQuery("pre_filter_shard_size") - pre_filter_shard_size: PreFilterShardSize, - - @httpQuery("rest_total_hits_as_int") - @default(false) - rest_total_hits_as_int: RestTotalHitsAsInt, -} - -// TODO: Fill in Body Parameters -structure KNNSearchModels_BodyParams {} - -@input -structure KNNSearchModels_Get_Input with [KNNSearchModels_QueryParams] {} - -@input -structure KNNSearchModels_Post_Input with [KNNSearchModels_QueryParams] { - @httpPayload - content: KNNSearchModels_BodyParams, -} - -// TODO: Fill in Output Structure -structure KNNSearchModels_Output {} diff --git a/model/knn/stats/operations.smithy b/model/knn/stats/operations.smithy deleted file mode 100644 index dd4a3b98..00000000 --- a/model/knn/stats/operations.smithy +++ /dev/null @@ -1,56 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/knn/api/#stats" -) - -@xOperationGroup("knn.stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_knn/stats") -@documentation("Provides information about the current status of the k-NN plugin.") -operation KNNStats { - input: KNNStats_Input, - output: KNNStats_Output -} - -@xOperationGroup("knn.stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_knn/{node_id}/stats") -@documentation("Provides information about the current status of the k-NN plugin.") -operation KNNStats_WithNodeId { - input: KNNStats_WithNodeId_Input, - output: KNNStats_Output -} - -@xOperationGroup("knn.stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_knn/stats/{stat}") -@documentation("Provides information about the current status of the k-NN plugin.") -operation KNNStats_WithStat { - input: KNNStats_WithStat_Input, - output: KNNStats_Output -} - -@xOperationGroup("knn.stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_knn/{node_id}/stats/{stat}") -@documentation("Provides information about the current status of the k-NN plugin.") -operation KNNStats_WithStatNodeId { - input: KNNStats_WithStatNodeId_Input, - output: KNNStats_Output -} diff --git a/model/knn/stats/structures.smithy b/model/knn/stats/structures.smithy deleted file mode 100644 index 340e9f10..00000000 --- a/model/knn/stats/structures.smithy +++ /dev/null @@ -1,46 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure KNNStats_QueryParams { - @httpQuery("timeout") - timeout: Timeout, -} - -@input -structure KNNStats_Input with [KNNStats_QueryParams] { -} - -@input -structure KNNStats_WithNodeId_Input with [KNNStats_QueryParams] { - @required - @httpLabel - node_id: PathNodeId, -} - -@input -structure KNNStats_WithStat_Input with [KNNStats_QueryParams] { - @required - @httpLabel - stat: PathStats, -} - -@input -structure KNNStats_WithStatNodeId_Input with [KNNStats_QueryParams] { - @required - @httpLabel - node_id: PathNodeId, - - @required - @httpLabel - stat: PathStats, -} - -// TODO: Fill in Output Structure -structure KNNStats_Output{} diff --git a/model/knn/train_model/operations.smithy b/model/knn/train_model/operations.smithy deleted file mode 100644 index a6503276..00000000 --- a/model/knn/train_model/operations.smithy +++ /dev/null @@ -1,32 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/knn/api/#train-model" -) - -@xOperationGroup("knn.train_model") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_plugins/_knn/models/_train") -@documentation("Create and train a model that can be used for initializing k-NN native library indexes during indexing.") -operation KNNTrainModel { - input: KNNTrainModel_Input, - output: KNNTrainModel_Output -} - -@xOperationGroup("knn.train_model") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_plugins/_knn/models/{model_id}/_train") -@documentation("Create and train a model that can be used for initializing k-NN native library indexes during indexing.") -operation KNNTrainModel_WithModelId { - input: KNNTrainModel_WithModelId_Input, - output: KNNTrainModel_Output -} diff --git a/model/knn/train_model/structures.smithy b/model/knn/train_model/structures.smithy deleted file mode 100644 index 09666725..00000000 --- a/model/knn/train_model/structures.smithy +++ /dev/null @@ -1,55 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure KNNTrainModel_QueryParams { - @httpQuery("preference") - preference: NodeId, -} - -structure KNNTrainModel_BodyParams { - @required - training_index: String, - - @required - training_field: String, - - @required - dimension: Integer, - - max_training_vector_count: Integer, - - search_size: Integer, - - description: String, - - @required - method: String, -} - -@input -structure KNNTrainModel_Input with [KNNTrainModel_QueryParams] { - @required - @httpPayload - content: KNNTrainModel_BodyParams, -} - -@input -structure KNNTrainModel_WithModelId_Input with [KNNTrainModel_QueryParams] { - @required - @httpPayload - content: KNNTrainModel_BodyParams, - - @required - @httpLabel - model_id: PathModelId, -} - -// TODO: Fill in Output Structure -structure KNNTrainModel_Output {} diff --git a/model/knn/warmup/operations.smithy b/model/knn/warmup/operations.smithy deleted file mode 100644 index 485c56bf..00000000 --- a/model/knn/warmup/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/knn/api/#warmup-operation" -) - -@xOperationGroup("knn.warmup") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_knn/warmup/{index}") -@documentation("Preloads native library files into memory, reducing initial search latency for specified indexes") -operation KNNWarmup { - input: KNNWarmup_Input, - output: KNNWarmup_Output -} diff --git a/model/knn/warmup/structures.smithy b/model/knn/warmup/structures.smithy deleted file mode 100644 index febefdbc..00000000 --- a/model/knn/warmup/structures.smithy +++ /dev/null @@ -1,18 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure KNNWarmup_Input { - @required - @httpLabel - index: PathIndices, -} - -// TODO: Fill in Output Structure -structure KNNWarmup_Output{} diff --git a/model/nodes/hot_threads/operations.smithy b/model/nodes/hot_threads/operations.smithy deleted file mode 100644 index 168a63ec..00000000 --- a/model/nodes/hot_threads/operations.smithy +++ /dev/null @@ -1,124 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/" -) - -@deprecated -@xOperationGroup("nodes.hot_threads") -@xVersionAdded("1.0") -@xDeprecationMessage("The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons") -@xVersionDeprecated("1.0") -@xIgnorable(true) -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cluster/nodes/hot_threads") -@documentation("Returns information about hot threads on each node in the cluster.") -operation NodesHotThreads_DeprecatedDash { - input: NodesHotThreads_DeprecatedDash_Input, - output: NodesHotThreads_Output -} - -@deprecated -@xOperationGroup("nodes.hot_threads") -@xVersionAdded("1.0") -@xDeprecationMessage("The hot threads API accepts `hotthreads` but only `hot_threads` is documented") -@xVersionDeprecated("1.0") -@xIgnorable(true) -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cluster/nodes/hotthreads") -@documentation("Returns information about hot threads on each node in the cluster.") -operation NodesHotThreads_DeprecatedCluster { - input: NodesHotThreads_DeprecatedCluster_Input, - output: NodesHotThreads_Output -} - -@xOperationGroup("nodes.hot_threads") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes/hot_threads") -@documentation("Returns information about hot threads on each node in the cluster.") -operation NodesHotThreads { - input: NodesHotThreads_Input, - output: NodesHotThreads_Output -} - -@deprecated -@xOperationGroup("nodes.hot_threads") -@xVersionAdded("1.0") -@xDeprecationMessage("The hot threads API accepts `hotthreads` but only `hot_threads` is documented") -@xVersionDeprecated("1.0") -@xIgnorable(true) -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes/hotthreads") -@documentation("Returns information about hot threads on each node in the cluster.") -operation NodesHotThreads_Deprecated { - input: NodesHotThreads_Deprecated_Input, - output: NodesHotThreads_Output -} - -@deprecated -@xOperationGroup("nodes.hot_threads") -@xVersionAdded("1.0") -@xDeprecationMessage("The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons") -@xVersionDeprecated("1.0") -@xIgnorable(true) -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cluster/nodes/{node_id}/hot_threads") -@documentation("Returns information about hot threads on each node in the cluster.") -operation NodesHotThreads_WithNodeId_DeprecatedDash { - input: NodesHotThreads_WithNodeId_DeprecatedDash_Input, - output: NodesHotThreads_Output -} - -@deprecated -@xOperationGroup("nodes.hot_threads") -@xVersionAdded("1.0") -@xDeprecationMessage("The hot threads API accepts `hotthreads` but only `hot_threads` is documented") -@xVersionDeprecated("1.0") -@xIgnorable(true) -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_cluster/nodes/{node_id}/hotthreads") -@documentation("Returns information about hot threads on each node in the cluster.") -operation NodesHotThreads_WithNodeId_DeprecatedCluster { - input: NodesHotThreads_WithNodeId_DeprecatedCluster_Input, - output: NodesHotThreads_Output -} - -@xOperationGroup("nodes.hot_threads") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes/{node_id}/hot_threads") -@documentation("Returns information about hot threads on each node in the cluster.") -operation NodesHotThreads_WithNodeId { - input: NodesHotThreads_WithNodeId_Input, - output: NodesHotThreads_Output -} - -@deprecated -@xOperationGroup("nodes.hot_threads") -@xVersionAdded("1.0") -@xDeprecationMessage("The hot threads API accepts `hotthreads` but only `hot_threads` is documented") -@xVersionDeprecated("1.0") -@xIgnorable(true) -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes/{node_id}/hotthreads") -@documentation("Returns information about hot threads on each node in the cluster.") -operation NodesHotThreads_WithNodeId_Deprecated { - input: NodesHotThreads_WithNodeId_Deprecated_Input, - output: NodesHotThreads_Output -} diff --git a/model/nodes/hot_threads/structures.smithy b/model/nodes/hot_threads/structures.smithy deleted file mode 100644 index d0ac5e2a..00000000 --- a/model/nodes/hot_threads/structures.smithy +++ /dev/null @@ -1,81 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure NodesHotThreads_QueryParams { - @httpQuery("interval") - interval: Interval, - - @httpQuery("snapshots") - @default(10) - snapshots: SnapshotsCount, - - @httpQuery("threads") - @default(3) - threads: Threads, - - @httpQuery("ignore_idle_threads") - @default(true) - ignore_idle_threads: IgnoreIdleThreads, - - @httpQuery("type") - @default("cpu") - type: SampleType, - - @httpQuery("timeout") - timeout: Timeout, -} - - -@input -structure NodesHotThreads_DeprecatedDash_Input with [NodesHotThreads_QueryParams] { -} - -@input -structure NodesHotThreads_DeprecatedCluster_Input with [NodesHotThreads_QueryParams] { -} - -@input -structure NodesHotThreads_Input with [NodesHotThreads_QueryParams] { -} - -@input -structure NodesHotThreads_Deprecated_Input with [NodesHotThreads_QueryParams] { -} - -@input -structure NodesHotThreads_WithNodeId_DeprecatedDash_Input with [NodesHotThreads_QueryParams] { - @required - @httpLabel - node_id: PathNodeId, -} - -@input -structure NodesHotThreads_WithNodeId_DeprecatedCluster_Input with [NodesHotThreads_QueryParams] { - @required - @httpLabel - node_id: PathNodeId, -} - -@input -structure NodesHotThreads_WithNodeId_Input with [NodesHotThreads_QueryParams] { - @required - @httpLabel - node_id: PathNodeId, -} - -@input -structure NodesHotThreads_WithNodeId_Deprecated_Input with [NodesHotThreads_QueryParams] { - @required - @httpLabel - node_id: PathNodeId, -} - -// TODO: Fill in Output Structure -structure NodesHotThreads_Output {} diff --git a/model/nodes/info/operations.smithy b/model/nodes/info/operations.smithy deleted file mode 100644 index e8cc3a75..00000000 --- a/model/nodes/info/operations.smithy +++ /dev/null @@ -1,45 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/" -) - -@xOperationGroup("nodes.info") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes") -@documentation("Returns information about nodes in the cluster.") -operation NodesInfo { - input: NodesInfo_Input, - output: NodesInfo_Output -} - -@xOperationGroup("nodes.info") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes/{node_id}") -@documentation("Returns information about nodes in the cluster.") -operation NodesInfo_WithNodeId { - input: NodesInfo_WithNodeId_Input, - output: NodesInfo_Output -} - -@xOperationGroup("nodes.info") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes/{node_id}/{metric}") -@documentation("Returns information about nodes in the cluster.") -operation NodesInfo_WithMetricNodeId { - input: NodesInfo_WithMetricNodeId_Input, - output: NodesInfo_Output -} diff --git a/model/nodes/info/structures.smithy b/model/nodes/info/structures.smithy deleted file mode 100644 index e99775c8..00000000 --- a/model/nodes/info/structures.smithy +++ /dev/null @@ -1,45 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure NodesInfo_QueryParams { - @httpQuery("flat_settings") - @default(false) - flat_settings: FlatSettings, - - @httpQuery("timeout") - timeout: Timeout, -} - - -@input -structure NodesInfo_Input with [NodesInfo_QueryParams] { -} - -@input -structure NodesInfo_WithNodeId_Input with [NodesInfo_QueryParams] { - @required - @httpLabel - @xOverloadedParam("metric") - node_id: PathNodeId, -} - -@input -structure NodesInfo_WithMetricNodeId_Input with [NodesInfo_QueryParams] { - @required - @httpLabel - node_id: PathNodeId, - - @required - @httpLabel - metric: PathNodesInfoMetric, -} - -// TODO: Fill in Output Structure -structure NodesInfo_Output {} diff --git a/model/nodes/reload_secure_settings/operations.smithy b/model/nodes/reload_secure_settings/operations.smithy deleted file mode 100644 index 3f44bb60..00000000 --- a/model/nodes/reload_secure_settings/operations.smithy +++ /dev/null @@ -1,32 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/" -) - -@xOperationGroup("nodes.reload_secure_settings") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_nodes/reload_secure_settings") -@documentation("Reloads secure settings.") -operation NodesReloadSecureSettings { - input: NodesReloadSecureSettings_Input, - output: NodesReloadSecureSettings_Output -} - -@xOperationGroup("nodes.reload_secure_settings") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_nodes/{node_id}/reload_secure_settings") -@documentation("Reloads secure settings.") -operation NodesReloadSecureSettings_WithNodeId { - input: NodesReloadSecureSettings_WithNodeId_Input, - output: NodesReloadSecureSettings_Output -} diff --git a/model/nodes/reload_secure_settings/structures.smithy b/model/nodes/reload_secure_settings/structures.smithy deleted file mode 100644 index 456ea5af..00000000 --- a/model/nodes/reload_secure_settings/structures.smithy +++ /dev/null @@ -1,37 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure NodesReloadSecureSettings_QueryParams { - @httpQuery("timeout") - timeout: Timeout, -} - -// TODO: Fill in Body Parameters -@documentation("An object containing the password for the opensearch keystore") -structure NodesReloadSecureSettings_BodyParams {} - -@input -structure NodesReloadSecureSettings_Input with [NodesReloadSecureSettings_QueryParams] { - @httpPayload - content: NodesReloadSecureSettings_BodyParams, -} - -@input -structure NodesReloadSecureSettings_WithNodeId_Input with [NodesReloadSecureSettings_QueryParams] { - @required - @httpLabel - @documentation("Comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.") - node_id: PathNodeId, - @httpPayload - content: NodesReloadSecureSettings_BodyParams, -} - -// TODO: Fill in Output Structure -structure NodesReloadSecureSettings_Output {} diff --git a/model/nodes/stats/operations.smithy b/model/nodes/stats/operations.smithy deleted file mode 100644 index 892e7fa1..00000000 --- a/model/nodes/stats/operations.smithy +++ /dev/null @@ -1,78 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/" -) - -@xOperationGroup("nodes.stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes/stats") -@documentation("Returns statistical information about nodes in the cluster.") -operation NodesStats { - input: NodesStats_Input, - output: NodesStats_Output -} - -@xOperationGroup("nodes.stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes/stats/{metric}") -@documentation("Returns statistical information about nodes in the cluster.") -operation NodesStats_WithMetric { - input: NodesStats_WithMetric_Input, - output: NodesStats_Output -} - -@xOperationGroup("nodes.stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes/{node_id}/stats") -@documentation("Returns statistical information about nodes in the cluster.") -operation NodesStats_WithNodeId { - input: NodesStats_WithNodeId_Input, - output: NodesStats_Output -} - -@xOperationGroup("nodes.stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes/stats/{metric}/{index_metric}") -@documentation("Returns statistical information about nodes in the cluster.") -operation NodesStats_WithIndexMetricMetric { - input: NodesStats_WithIndexMetricMetric_Input, - output: NodesStats_Output -} - -@xOperationGroup("nodes.stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes/{node_id}/stats/{metric}") -@documentation("Returns statistical information about nodes in the cluster.") -operation NodesStats_WithMetricNodeId { - input: NodesStats_WithMetricNodeId_Input, - output: NodesStats_Output -} - -@xOperationGroup("nodes.stats") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes/{node_id}/stats/{metric}/{index_metric}") -@documentation("Returns statistical information about nodes in the cluster.") -operation NodesStats_WithIndexMetricMetricNodeId { - input: NodesStats_WithIndexMetricMetricNodeId_Input, - output: NodesStats_Output -} diff --git a/model/nodes/stats/structures.smithy b/model/nodes/stats/structures.smithy deleted file mode 100644 index 73d29eaf..00000000 --- a/model/nodes/stats/structures.smithy +++ /dev/null @@ -1,97 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure NodesStats_QueryParams { - @httpQuery("completion_fields") - completion_fields: CompletionFields, - - @httpQuery("fielddata_fields") - fielddata_fields: FielddataFields, - - @httpQuery("fields") - @documentation("Comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards).") - fields: Fields, - - @httpQuery("groups") - groups: Groups, - - @httpQuery("level") - @default("node") - level: NodesStatLevel, - - @httpQuery("types") - types: Types, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("include_segment_file_sizes") - @default(false) - include_segment_file_sizes: IncludeSegmentFileSizes, -} - - -@input -structure NodesStats_Input with [NodesStats_QueryParams] { -} - -@input -structure NodesStats_WithMetric_Input with [NodesStats_QueryParams] { - @required - @httpLabel - metric: PathNodesStatsMetric, -} - -@input -structure NodesStats_WithNodeId_Input with [NodesStats_QueryParams] { - @required - @httpLabel - node_id: PathNodeId, -} - -@input -structure NodesStats_WithIndexMetricMetric_Input with [NodesStats_QueryParams] { - @required - @httpLabel - metric: PathNodesStatsMetric, - - @required - @httpLabel - index_metric: PathIndexMetric, -} - -@input -structure NodesStats_WithMetricNodeId_Input with [NodesStats_QueryParams] { - @required - @httpLabel - metric: PathNodesStatsMetric, - - @required - @httpLabel - node_id: PathNodeId, -} - -@input -structure NodesStats_WithIndexMetricMetricNodeId_Input with [NodesStats_QueryParams] { - @required - @httpLabel - metric: PathNodesStatsMetric, - - @required - @httpLabel - index_metric: PathIndexMetric, - - @required - @httpLabel - node_id: PathNodeId, -} - -// TODO: Fill in Output Structure -structure NodesStats_Output {} diff --git a/model/nodes/usage/operations.smithy b/model/nodes/usage/operations.smithy deleted file mode 100644 index 696e2ba1..00000000 --- a/model/nodes/usage/operations.smithy +++ /dev/null @@ -1,57 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("nodes.usage") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes/usage") -@documentation("Returns low-level information about REST actions usage on nodes.") -operation NodesUsage { - input: NodesUsage_Input, - output: NodesUsage_Output -} - -@xOperationGroup("nodes.usage") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes/usage/{metric}") -@documentation("Returns low-level information about REST actions usage on nodes.") -operation NodesUsage_WithMetric { - input: NodesUsage_WithMetric_Input, - output: NodesUsage_Output -} - -@xOperationGroup("nodes.usage") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes/{node_id}/usage") -@documentation("Returns low-level information about REST actions usage on nodes.") -operation NodesUsage_WithNodeId { - input: NodesUsage_WithNodeId_Input, - output: NodesUsage_Output -} - -@xOperationGroup("nodes.usage") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_nodes/{node_id}/usage/{metric}") -@documentation("Returns low-level information about REST actions usage on nodes.") -operation NodesUsage_WithMetricNodeId { - input: NodesUsage_WithMetricNodeId_Input, - output: NodesUsage_Output -} diff --git a/model/nodes/usage/structures.smithy b/model/nodes/usage/structures.smithy deleted file mode 100644 index ae6a52da..00000000 --- a/model/nodes/usage/structures.smithy +++ /dev/null @@ -1,47 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure NodesUsage_QueryParams { - @httpQuery("timeout") - timeout: Timeout, -} - - -@input -structure NodesUsage_Input with [NodesUsage_QueryParams] { -} - -@input -structure NodesUsage_WithMetric_Input with [NodesUsage_QueryParams] { - @required - @httpLabel - metric: PathNodesUsageMetric, -} - -@input -structure NodesUsage_WithNodeId_Input with [NodesUsage_QueryParams] { - @required - @httpLabel - node_id: PathNodeId, -} - -@input -structure NodesUsage_WithMetricNodeId_Input with [NodesUsage_QueryParams] { - @required - @httpLabel - metric: PathNodesUsageMetric, - - @required - @httpLabel - node_id: PathNodeId, -} - -// TODO: Fill in Output Structure -structure NodesUsage_Output {} diff --git a/model/opensearch.smithy b/model/opensearch.smithy deleted file mode 100644 index 09126b23..00000000 --- a/model/opensearch.smithy +++ /dev/null @@ -1,401 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -use aws.protocols#restJson1 - -@externalDocumentation( - "OpenSearch Documentation": "https://opensearch.org/docs/latest/" -) - -@httpBasicAuth -@restJson1 -service OpenSearch { - version: "2021-11-23", - operations: [ - Bulk_Post, - Bulk_Post_WithIndex, - Bulk_Put, - Bulk_Put_WithIndex, - CatAliases, - CatAliases_WithName, - CatAllocation, - CatAllocation_WithNodeId, - CatClusterManager, - CatCount, - CatCount_WithIndex, - CatFielddata, - CatFielddata_WithFields, - CatHealth, - CatHelp, - CatIndices, - CatIndices_WithIndex, - CatMaster, - CatNodeattrs, - CatNodes, - CatPendingTasks, - CatAllPitSegments, - CatPitSegments, - CatPlugins, - CatRecovery, - CatRecovery_WithIndex, - CatRepositories, - CatSegmentReplication, - CatSegmentReplication_WithIndex, - CatSegments, - CatSegments_WithIndex, - CatShards, - CatShards_WithIndex, - CatSnapshots, - CatSnapshots_WithRepository, - CatTasks, - CatTemplates, - CatTemplates_WithName, - CatThreadPool, - CatThreadPool_WithThreadPoolPatterns, - ChangePassword, - ClearScroll, - ClearScroll_WithScrollId, - ClusterAllocationExplain_Get, - ClusterAllocationExplain_Post, - ClusterDeleteComponentTemplate, - ClusterDeleteDecommissionAwareness, - ClusterDeleteVotingConfigExclusions, - ClusterDeleteWeightedRouting, - ClusterExistsComponentTemplate, - ClusterGetComponentTemplate, - ClusterGetComponentTemplate_WithName, - ClusterGetDecommissionAwareness, - ClusterGetSettings, - ClusterGetWeightedRouting, - ClusterHealth, - ClusterHealth_WithIndex, - ClusterPendingTasks, - ClusterPostVotingConfigExclusions, - ClusterPutComponentTemplate_Post, - ClusterPutComponentTemplate_Put, - ClusterPutDecommissionAwareness, - ClusterPutSettings, - ClusterPutWeightedRouting, - ClusterRemoteInfo, - ClusterReroute, - ClusterState, - ClusterState_WithIndexMetric, - ClusterState_WithMetric, - ClusterStats, - ClusterStats_WithNodeId, - Count_Get, - Count_Get_WithIndex, - Count_Post, - Count_Post_WithIndex, - CreateActionGroup, - CreatePit, - CreateRole, - CreateRoleMapping, - CreateTenant, - CreateUser, - Create_Post, - Create_Put, - CreateSearchPipeline, - DanglingIndicesDeleteDanglingIndex, - DanglingIndicesImportDanglingIndex, - DanglingIndicesListDanglingIndices, - Delete, - DeleteActionGroup, - DeleteAllPits, - DeleteByQuery, - DeleteByQueryRethrottle, - DeleteDistinguishedNames, - DeletePit, - DeleteRole, - DeleteRoleMapping, - DeleteScript, - DeleteTenant, - DeleteUser, - Exists, - ExistsSource, - Explain_Get, - Explain_Post, - FieldCaps_Get, - FieldCaps_Get_WithIndex, - FieldCaps_Post, - FieldCaps_Post_WithIndex, - FlushCache, - Get, - GetAccountDetails, - GetAllPits, - GetActionGroup, - GetActionGroups, - GetAuditConfiguration, - GetCertificates, - GetConfiguration, - GetDistinguishedNames, - GetDistinguishedNamesWithClusterName, - GetScript, - GetScriptContext, - GetScriptLanguages, - GetSource, - GetRole, - GetRoles, - GetRoleMapping, - GetRoleMappings, - GetSearchPipeline, - GetTenant, - GetTenants, - GetUser, - GetUsers, - Index_Post, - Index_Post_WithId, - Index_Put_WithId, - IndicesAddBlock, - IndicesAnalyze_Get, - IndicesAnalyze_Get_WithIndex, - IndicesAnalyze_Post, - IndicesAnalyze_Post_WithIndex, - IndicesClearCache, - IndicesClearCache_WithIndex, - IndicesClone_Post, - IndicesClone_Put, - IndicesClose, - IndicesCreate, - IndicesCreateDataStream, - IndicesDataStreamsStats, - IndicesDataStreamsStats_WithName, - IndicesDelete, - IndicesDeleteAlias, - IndicesDeleteAlias_Plural, - IndicesDeleteDataStream, - IndicesDeleteIndexTemplate, - IndicesDeleteTemplate, - IndicesExists, - IndicesExistsAlias, - IndicesExistsAlias_WithIndex, - IndicesExistsIndexTemplate, - IndicesExistsTemplate, - IndicesFlush_Get, - IndicesFlush_Get_WithIndex, - IndicesFlush_Post, - IndicesFlush_Post_WithIndex, - IndicesForcemerge, - IndicesForcemerge_WithIndex, - IndicesGet, - IndicesGetAlias, - IndicesGetAlias_WithIndex, - IndicesGetAlias_WithIndexName, - IndicesGetAlias_WithName, - IndicesGetDataStream, - IndicesGetDataStream_WithName, - IndicesGetFieldMapping, - IndicesGetFieldMapping_WithIndex, - IndicesGetIndexTemplate, - IndicesGetIndexTemplate_WithName, - IndicesGetMapping, - IndicesGetMapping_WithIndex, - IndicesGetSettings, - IndicesGetSettings_WithIndex, - IndicesGetSettings_WithIndexName, - IndicesGetSettings_WithName, - IndicesGetTemplate, - IndicesGetTemplate_WithName, - IndicesGetUpgrade, - IndicesGetUpgrade_WithIndex, - IndicesOpen, - IndicesPutAlias_Post, - IndicesPutAlias_Post_Plural, - IndicesPutAlias_Put, - IndicesPutAlias_Put_Plural, - IndicesPutIndexTemplate_Post, - IndicesPutIndexTemplate_Put, - IndicesPutMapping_Post, - IndicesPutMapping_Put, - IndicesPutSettings, - IndicesPutSettings_WithIndex, - IndicesPutTemplate_Post, - IndicesPutTemplate_Put, - IndicesRecovery, - IndicesRecovery_WithIndex, - IndicesRefresh_Get, - IndicesRefresh_Get_WithIndex, - IndicesRefresh_Post, - IndicesRefresh_Post_WithIndex, - IndicesResolveIndex, - IndicesRollover, - IndicesRollover_WithNewIndex, - IndicesSegments, - IndicesSegments_WithIndex, - IndicesShardStores, - IndicesShardStores_WithIndex, - IndicesShrink_Post, - IndicesShrink_Put, - IndicesSimulateIndexTemplate, - IndicesSimulateTemplate, - IndicesSimulateTemplate_WithName, - IndicesSplit_Post, - IndicesSplit_Put, - IndicesStats, - IndicesStats_WithIndex, - IndicesStats_WithIndexMetric, - IndicesStats_WithMetric, - IndicesUpdateAliases, - IndicesUpgrade, - IndicesUpgrade_WithIndex, - IndicesValidateQuery_Get, - IndicesValidateQuery_Get_WithIndex, - IndicesValidateQuery_Post, - IndicesValidateQuery_Post_WithIndex, - Info, - IngestDeletePipeline, - IngestGetPipeline, - IngestGetPipeline_WithId, - IngestProcessorGrok, - IngestPutPipeline, - IngestSimulate_Get, - IngestSimulate_Get_WithId, - IngestSimulate_Post, - IngestSimulate_Post_WithId, - KNNDeleteModel, - KNNGetModel, - KNNSearchModels_Get, - KNNSearchModels_Post, - KNNStats, - KNNStats_WithNodeId, - KNNStats_WithStat, - KNNStats_WithStatNodeId, - KNNTrainModel, - KNNTrainModel_WithModelId, - KNNWarmup, - Mget_Get, - Mget_Get_WithIndex, - Mget_Post, - Mget_Post_WithIndex, - MsearchTemplate_Get, - MsearchTemplate_Get_WithIndex, - MsearchTemplate_Post, - MsearchTemplate_Post_WithIndex, - Msearch_Get, - Msearch_Get_WithIndex, - Msearch_Post, - Msearch_Post_WithIndex, - Mtermvectors_Get, - Mtermvectors_Get_WithIndex, - Mtermvectors_Post, - Mtermvectors_Post_WithIndex, - NodesHotThreads, - NodesHotThreads_Deprecated, - NodesHotThreads_DeprecatedCluster, - NodesHotThreads_DeprecatedDash, - NodesHotThreads_WithNodeId, - NodesHotThreads_WithNodeId_Deprecated, - NodesHotThreads_WithNodeId_DeprecatedCluster, - NodesHotThreads_WithNodeId_DeprecatedDash, - NodesInfo, - NodesInfo_WithMetricNodeId, - NodesInfo_WithNodeId, - NodesReloadSecureSettings, - NodesReloadSecureSettings_WithNodeId, - NodesStats, - NodesStats_WithIndexMetricMetric, - NodesStats_WithIndexMetricMetricNodeId, - NodesStats_WithMetric, - NodesStats_WithMetricNodeId, - NodesStats_WithNodeId, - NodesUsage, - NodesUsage_WithMetric, - NodesUsage_WithMetricNodeId, - NodesUsage_WithNodeId, - NotificationsConfigs_Delete_WithPathParams, - NotificationsConfigs_Delete_WithQueryParams - NotificationsConfigs_Get, - NotificationsConfigsItem_Get - NotificationsConfigs_Post, - NotificationsConfigs_Put, - NotificationsFeatures_Get, - NotificationsFeatureTest_Get, - NotificationsFeatureTest_Post, - PatchActionGroup, - PatchActionGroups, - PatchAuditConfiguration, - PatchConfiguration, - PatchDistinguishedNames, - PatchRole, - PatchRoles, - PatchTenant, - PatchTenants, - PatchRoleMapping, - PatchRoleMappings, - PatchUser, - PatchUsers, - Ping, - PutScript_Post, - PutScript_Post_WithContext, - PutScript_Put, - PutScript_Put_WithContext, - RankEval_Get, - RankEval_Get_WithIndex, - RankEval_Post, - RankEval_Post_WithIndex, - Reindex, - ReindexRethrottle, - ReloadHttpCertificates, - ReloadTransportCertificates, - RemoteStoreRestore, - RenderSearchTemplate_Get, - RenderSearchTemplate_Get_WithId, - RenderSearchTemplate_Post, - RenderSearchTemplate_Post_WithId, - ScriptsPainlessExecute_Get, - ScriptsPainlessExecute_Post, - Scroll_Get, - Scroll_Get_WithScrollId, - Scroll_Post, - Scroll_Post_WithScrollId, - SearchShards_Get, - SearchShards_Get_WithIndex, - SearchShards_Post, - SearchShards_Post_WithIndex, - SearchTemplate_Get, - SearchTemplate_Get_WithIndex, - SearchTemplate_Post, - SearchTemplate_Post_WithIndex, - Search_Get, - Search_Get_WithIndex, - Search_Post, - Search_Post_WithIndex, - SecurityHealth, - SnapshotCleanupRepository, - SnapshotClone, - SnapshotCreateRepository_Post, - SnapshotCreateRepository_Put, - SnapshotCreate_Post, - SnapshotCreate_Put, - SnapshotDelete, - SnapshotDeleteRepository, - SnapshotGet, - SnapshotGetRepository, - SnapshotGetRepository_WithRepository, - SnapshotRestore, - SnapshotStatus, - SnapshotStatus_WithRepository, - SnapshotStatus_WithRepositorySnapshot, - SnapshotVerifyRepository, - TasksCancel, - TasksCancel_WithTaskId, - TasksGet, - TasksList, - Termvectors_Get, - Termvectors_Get_WithId, - Termvectors_Post, - Termvectors_Post_WithId, - Update, - UpdateAuditConfiguration, - UpdateByQuery, - UpdateByQueryRethrottle, - UpdateConfiguration, - UpdateDistinguishedNames, - ] -} diff --git a/model/remote_store/restore/operations.smithy b/model/remote_store/restore/operations.smithy deleted file mode 100644 index 05d11052..00000000 --- a/model/remote_store/restore/operations.smithy +++ /dev/null @@ -1,43 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/opensearch/remote/#restoring-from-a-backup" -) - -@xOperationGroup("remote_store.restore") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_remotestore/_restore") -@documentation("Restores from remote store.") -operation RemoteStoreRestore { - input: RemoteStoreRestore_Input, - output: RemoteStoreRestore_Output -} - -apply RemoteStoreRestore @examples([ - { - title: "Examples for Post Remote Storage Restore Operation.", - input: { - content: { - indices: ["books"] - } - }, - output: { - remote_store: { - indices: ["books"], - shards: { - total: 1, - failed: 0, - successful: 1 - } - } - } - } -]) diff --git a/model/remote_store/restore/structures.smithy b/model/remote_store/restore/structures.smithy deleted file mode 100644 index 832bde32..00000000 --- a/model/remote_store/restore/structures.smithy +++ /dev/null @@ -1,51 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure RemoteStoreRestore_QueryParams { - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("wait_for_completion") - @default(false) - wait_for_completion: WaitForCompletionFalse, -} - -@documentation("Comma-separated list of index IDs") -structure RemoteStoreRestore_BodyParams { - @required - indices: IndexNames -} - -@input -structure RemoteStoreRestore_Input with [RemoteStoreRestore_QueryParams] { - @required - @httpPayload - content: RemoteStoreRestore_BodyParams, -} - -@unstable -structure RemoteStoreRestore_Output { - accepted: Boolean, - remote_store: RemoteStoreRestoreInfo -} - -@unstable -structure RemoteStoreRestoreInfo { - snapshot: String, - indices: IndexNames, - shards: RemoteStoreRestoreShardsInfo -} - -@unstable -structure RemoteStoreRestoreShardsInfo { - total: Integer, - failed: Integer, - successful: Integer -} diff --git a/model/search_pipeline/create/operations.smithy b/model/search_pipeline/create/operations.smithy deleted file mode 100644 index 13d7c576..00000000 --- a/model/search_pipeline/create/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/search-pipelines/creating-search-pipeline/" -) - -@xOperationGroup("search_pipeline.create") -@xVersionAdded("2.9") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_search/pipeline/{pipeline}") -@documentation("Creates or replaces the specified search pipeline.") -operation CreateSearchPipeline { - input: CreateSearchPipeline_Input, - output: CreateSearchPipeline_Output -} diff --git a/model/search_pipeline/create/structures.smithy b/model/search_pipeline/create/structures.smithy deleted file mode 100644 index 69c89c77..00000000 --- a/model/search_pipeline/create/structures.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - - -@input -structure CreateSearchPipeline_Input{ - @required - @httpLabel - pipeline: String - @required - @httpPayload - content: SearchPipelineStructure -} - -@output -structure CreateSearchPipeline_Output { - acknowledged: Boolean -} diff --git a/model/search_pipeline/get/operations.smithy b/model/search_pipeline/get/operations.smithy deleted file mode 100644 index 5029c140..00000000 --- a/model/search_pipeline/get/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/search-plugins/search-pipelines/index/" -) - -@xOperationGroup("search_pipeline.get") -@xVersionAdded("2.9") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_search/pipeline") -@documentation("Retrieves information about search pipelines.") -operation GetSearchPipelines { - input: GetSearchPipelines_Input, - output: GetSearchPipelines_Output -} - -@xOperationGroup("search_pipeline.get") -@xVersionAdded("2.9") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_search/pipeline/{pipeline}") -@documentation("Retrieves information about a specified search pipeline.") -operation GetSearchPipeline { - input: GetSearchPipeline_Input, - output: GetSearchPipeline_Output -} diff --git a/model/search_pipeline/get/structures.smithy b/model/search_pipeline/get/structures.smithy deleted file mode 100644 index ab90164c..00000000 --- a/model/search_pipeline/get/structures.smithy +++ /dev/null @@ -1,31 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure GetSearchPipelines_Input { -} - -@output -structure GetSearchPipelines_Output { - @httpPayload - content: SearchPipelineMap -} - -@input -structure GetSearchPipeline_Input { - @required - @httpLabel - pipeline: String, -} - -@output -structure GetSearchPipeline_Output { - @httpPayload - content: SearchPipelineMap -} diff --git a/model/search_pipeline/search_pipeline.smithy b/model/search_pipeline/search_pipeline.smithy deleted file mode 100644 index 7cfa4568..00000000 --- a/model/search_pipeline/search_pipeline.smithy +++ /dev/null @@ -1,203 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -map SearchPipelineMap { - key: String - value: SearchPipelineStructure -} - -structure SearchPipelineStructure { - version: Integer - request_processors: RequestProcessorList - response_processors: ResponseProcessorList - phase_results_processors: PhaseResultsProcessorList -} - -// === Common Properties === - -@mixin -structure ProcessorBase { - tag: String - description: String -} - -@mixin -structure IgnoreableProcessorBase with [ProcessorBase] { - ignore_failure: Boolean -} - -// === Request Processors === - -list RequestProcessorList { - member: RequestProcessor -} - -union RequestProcessor { - filter_query: FilterQueryRequestProcessor - neural_query_enricher: NeuralQueryEnricherRequestProcessor - script: SearchScriptRequestProcessor - oversample: OversampleRequestProcessor -} - -structure FilterQueryRequestProcessor with [IgnoreableProcessorBase] { - query: UserDefinedObjectStructure -} - -structure NeuralQueryEnricherRequestProcessor with [ProcessorBase] { - default_model_id: String - neural_field_default_id: NeuralFieldMap -} - -map NeuralFieldMap { - key: String - value: String -} - -structure SearchScriptRequestProcessor with [IgnoreableProcessorBase] { - @required - source: String - - lang: String -} - -structure OversampleRequestProcessor with [IgnoreableProcessorBase] { - @required - sample_factor: Float - - content_prefix: String -} - -// === Response Processors === - -list ResponseProcessorList { - member: RequestProcessor -} - -union ResponseProcessor { - personalize_search_ranking: PersonalizeSearchRankingResponseProcessor - retrieval_augmented_generation: RetrievalAugmentedGenerationResponseProcessor - rename_field: RenameFieldResponseProcessor - rerank: RerankResponseProcessor - collapse: CollapseResponseProcessor - truncate_hits: TruncateHitsResponseProcessor -} - -structure PersonalizeSearchRankingResponseProcessor with [IgnoreableProcessorBase] { - @required - campaign_arn: String - - @required - recipe: String - - @required - weight: Float - - item_id_field: String - - iam_role_arn: String -} - -structure RetrievalAugmentedGenerationResponseProcessor with [ProcessorBase] { - @required - model_id: String - - @required - context_field_list: ContextFieldList - - system_prompt: String - - user_instructions: String -} - -list ContextFieldList { - member: String -} - -structure RenameFieldResponseProcessor with [IgnoreableProcessorBase] { - @required - field: String - - @required - target_field: String -} - -structure RerankResponseProcessor with [IgnoreableProcessorBase] { - ml_opensearch: MLOpenSearchReranker - context: RerankContext -} - -structure MLOpenSearchReranker { - @required - model_id: String -} - -structure RerankContext { - @required - document_fields: DocumentFieldList -} - -list DocumentFieldList { - member: String -} - -structure CollapseResponseProcessor with [IgnoreableProcessorBase] { - @required - field: String - - context_prefix: String -} - -structure TruncateHitsResponseProcessor with [IgnoreableProcessorBase] { - target_size: Integer - context_prefix: String -} - -// === Phase Results Processors === - -list PhaseResultsProcessorList { - member: PhaseResultsProcessor -} - -union PhaseResultsProcessor { - @jsonName("normalization-processor") - normalization_processor: NormalizationPhaseResultsProcessor -} - -structure NormalizationPhaseResultsProcessor with [IgnoreableProcessorBase] { - normalization: ScoreNormalization - combination: ScoreCombination -} - -structure ScoreNormalization { - technique: ScoreNormalizationTechnique -} - -enum ScoreNormalizationTechnique { - MIN_MAX = "min_max" - L2 = "l2" -} - -structure ScoreCombination { - technique: ScoreCombinationTechnique - parameters: ScoreWeights -} - -enum ScoreCombinationTechnique { - ARITHMETIC_MEAN = "arithmetic_mean" - GEOMETRIC_MEAN = "geometric_mean" - HARMONIC_MEAN = "harmonic_mean" -} - -structure ScoreCombinationParameters { - weights: ScoreWeights -} - -list ScoreWeights { - member: Float -} diff --git a/model/security/account.smithy b/model/security/account.smithy deleted file mode 100644 index 1f1282e3..00000000 --- a/model/security/account.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -structure AccountDetails { - user_name: String, - is_reserved: Boolean, - is_hidden: Boolean, - is_internal_user: Boolean, - user_requested_tenant: String, - backend_roles: BackendRolesList, - custom_attribute_names: CustomAttributeNamesList, - tenants: UserTenants, - roles: UserRolesList -} - -list CustomAttributeNamesList { - member: String -} - -structure UserTenants { - global_tenant: Boolean, - admin_tenant: Boolean, - admin: Boolean -} - -list UserRolesList { - member: String -} diff --git a/model/security/action_group.smithy b/model/security/action_group.smithy deleted file mode 100644 index fbaf44a5..00000000 --- a/model/security/action_group.smithy +++ /dev/null @@ -1,26 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -map ActionGroupsMap { - key: String, - value: Action_Group -} - -structure Action_Group { - reserved: Boolean, - hidden: Boolean, - allowed_actions: AllowedActions, - type: String, - description: String, - static: Boolean -} - -list AllowedActions { - member: String -} diff --git a/model/security/audit_config.smithy b/model/security/audit_config.smithy deleted file mode 100644 index f94d7b65..00000000 --- a/model/security/audit_config.smithy +++ /dev/null @@ -1,73 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -structure AuditConfigWithReadOnly { - _readonly: AuditConfigReadOnlyList, - config: AuditConfig -} - -list AuditConfigReadOnlyList { - member: String -} - -structure AuditConfig { - compliance: ComplianceConfig - enabled: Boolean - audit: AuditLogsConfig -} - -structure ComplianceConfig { - enabled: Boolean - write_log_diffs: Boolean - read_watched_fields: Document - read_ignore_users: IgnoreUsersList - write_watched_indices: WriteWatchedIndices - write_ignore_users: WriteIgnoreUsers - read_metadata_only: Boolean - write_metadata_only: Boolean - external_config: Boolean - internal_config: Boolean -} - -structure AuditLogsConfig { - ignore_users: IgnoreUsersList - ignore_requests: IgnoreRequests - disabled_rest_categories: DisabledRestCategories - disabled_transport_categories: DisabledTransportCategories - log_request_body: Boolean - resolve_indices: Boolean - resolve_bulk_requests: Boolean - exclude_sensitive_headers: Boolean - enable_transport: Boolean - enable_rest: Boolean -} - -list IgnoreUsersList{ - member: String -} - -list IgnoreRequests{ - member: String -} - -list DisabledRestCategories{ - member: String -} - -list DisabledTransportCategories{ - member: String -} - -list WriteWatchedIndices{ - member: String -} - -list WriteIgnoreUsers{ - member: String -} diff --git a/model/security/certificate.smithy b/model/security/certificate.smithy deleted file mode 100644 index c6077a96..00000000 --- a/model/security/certificate.smithy +++ /dev/null @@ -1,20 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -list CertificatesList { - member: CertificatesDetail -} - -structure CertificatesDetail { - issuer_dn: String, - subject_dn: String, - san: String, - not_before: String, - not_after: String -} diff --git a/model/security/change_password/operations.smithy b/model/security/change_password/operations.smithy deleted file mode 100644 index d8d20c99..00000000 --- a/model/security/change_password/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#change-password" -) - -@xOperationGroup("security.change_password") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_plugins/_security/api/account") -@documentation("Changes the password for the current user.") -operation ChangePassword{ - input: ChangePassword_Input, - output: ChangePassword_Output -} diff --git a/model/security/change_password/structures.smithy b/model/security/change_password/structures.smithy deleted file mode 100644 index e0dbe460..00000000 --- a/model/security/change_password/structures.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure ChangePassword_Input{ - @required - @documentation("The current password") - current_password: String - @required - @documentation("The new password to set") - password: String -} - -@output -structure ChangePassword_Output{ - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/configuration.smithy b/model/security/configuration.smithy deleted file mode 100644 index 5d2fbf2b..00000000 --- a/model/security/configuration.smithy +++ /dev/null @@ -1,28 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -structure DynamicConfig { - dynamic: DynamicOptions -} - -structure DynamicOptions { - filteredAliasMode: String, - disableRestAuth: Boolean, - disableIntertransportAuth: Boolean, - respectRequestIndicesOptions: Boolean, - kibana: Document, - http: Document, - authc: Document, - authz: Document, - authFailureListeners: Document, - doNotFailOnForbidden: Boolean, - multiRolespanEnabled: Boolean, - hostsResolverMode: String, - doNotFailOnForbiddenEmpty: Boolean -} diff --git a/model/security/create_action_group/operations.smithy b/model/security/create_action_group/operations.smithy deleted file mode 100644 index b1c2c506..00000000 --- a/model/security/create_action_group/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#create-action-group" -) - -@xOperationGroup("security.create_action_group") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_plugins/_security/api/actiongroups/{action_group}") -@documentation("Creates or replaces the specified action group.") -operation CreateActionGroup { - input: CreateActionGroup_Input, - output: CreateActionGroup_Output -} diff --git a/model/security/create_action_group/structures.smithy b/model/security/create_action_group/structures.smithy deleted file mode 100644 index 39f8092d..00000000 --- a/model/security/create_action_group/structures.smithy +++ /dev/null @@ -1,25 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure CreateActionGroup_Input { - @required - @httpLabel - @documentation("The name of the action group to create or replace") - action_group: String - @required - @httpPayload - content: Action_Group -} - -@output -structure CreateActionGroup_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/create_role/operations.smithy b/model/security/create_role/operations.smithy deleted file mode 100644 index 6298f4e6..00000000 --- a/model/security/create_role/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#create-role" -) - -@xOperationGroup("security.create_role") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_plugins/_security/api/roles/{role}") -@documentation("Creates or replaces the specified role.") -operation CreateRole { - input: CreateRole_Input, - output: CreateRole_Output -} diff --git a/model/security/create_role/structures.smithy b/model/security/create_role/structures.smithy deleted file mode 100644 index c286f540..00000000 --- a/model/security/create_role/structures.smithy +++ /dev/null @@ -1,25 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - - -@input -structure CreateRole_Input{ - @required - @httpLabel - role: String - @required - @httpPayload - content: Role -} - -@output -structure CreateRole_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/create_role_mapping/operations.smithy b/model/security/create_role_mapping/operations.smithy deleted file mode 100644 index 2641d377..00000000 --- a/model/security/create_role_mapping/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping" -) - -@xOperationGroup("security.create_role_mapping") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_plugins/_security/api/rolesmapping/{role}") -@documentation("Creates or replaces the specified role mapping.") -operation CreateRoleMapping { - input: CreateRoleMapping_Input, - output: CreateRoleMapping_Output -} diff --git a/model/security/create_role_mapping/structures.smithy b/model/security/create_role_mapping/structures.smithy deleted file mode 100644 index 2359dd3c..00000000 --- a/model/security/create_role_mapping/structures.smithy +++ /dev/null @@ -1,25 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - - -@input -structure CreateRoleMapping_Input{ - @required - @httpLabel - role: String - @required - @httpPayload - content: RoleMapping -} - -@output -structure CreateRoleMapping_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/create_tenant/operations.smithy b/model/security/create_tenant/operations.smithy deleted file mode 100644 index cf92264f..00000000 --- a/model/security/create_tenant/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/2.7/security/access-control/api/#create-tenant" -) - -@xOperationGroup("security.create_tenant") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_plugins/_security/api/tenants/{tenant}") -@documentation("Creates or replaces the specified tenant.") -operation CreateTenant { - input: CreateTenant_Input, - output: CreateTenant_Output -} diff --git a/model/security/create_tenant/structures.smithy b/model/security/create_tenant/structures.smithy deleted file mode 100644 index 727705c6..00000000 --- a/model/security/create_tenant/structures.smithy +++ /dev/null @@ -1,28 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure CreateTenant_Input { - @required - @httpLabel - tenant: String - @required - @httpPayload - content: CreateTenantParams -} - -@output -structure CreateTenant_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} - -structure CreateTenantParams{ - description: String -} diff --git a/model/security/create_user/operations.smithy b/model/security/create_user/operations.smithy deleted file mode 100644 index 15ebcb1a..00000000 --- a/model/security/create_user/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#create-user" -) - -@xOperationGroup("security.create_user") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_plugins/_security/api/internalusers/{username}") -@documentation("Creates or replaces the specified user.") -operation CreateUser { - input: CreateUser_Input, - output: CreateUser_Output -} diff --git a/model/security/create_user/structures.smithy b/model/security/create_user/structures.smithy deleted file mode 100644 index fb2e8d73..00000000 --- a/model/security/create_user/structures.smithy +++ /dev/null @@ -1,25 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - - -@input -structure CreateUser_Input { - @required - @httpLabel - username: String - @required - @httpPayload - user: User -} - -@output -structure CreateUser_Output { - status: SecurityOperationStatus - message: SecurityOperationMessage -} diff --git a/model/security/delete_action_group/operations.smithy b/model/security/delete_action_group/operations.smithy deleted file mode 100644 index 1cc50e01..00000000 --- a/model/security/delete_action_group/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group" -) - -@xOperationGroup("security.delete_action_group") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict", "HttpMethodSemantics.UnexpectedPayload"]) -@http(method: "DELETE", uri: "/_plugins/_security/api/actiongroups/{action_group}") -@documentation("Delete a specified action group.") -operation DeleteActionGroup { - input: DeleteActionGroup_Input, - output: DeleteActionGroup_Output -} diff --git a/model/security/delete_action_group/structures.smithy b/model/security/delete_action_group/structures.smithy deleted file mode 100644 index 0d4749d2..00000000 --- a/model/security/delete_action_group/structures.smithy +++ /dev/null @@ -1,22 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure DeleteActionGroup_Input{ - @required - @httpLabel - @documentation("Action group to delete.") - action_group: String -} - -@output -structure DeleteActionGroup_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/delete_distinguished_names/operations.smithy b/model/security/delete_distinguished_names/operations.smithy deleted file mode 100644 index e5164052..00000000 --- a/model/security/delete_distinguished_names/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names" -) - -@xOperationGroup("security.delete_distinguished_names") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_plugins/_security/api/nodesdn/{cluster_name}") -@documentation("Deletes all distinguished names in the specified cluster’s or node’s allow list.") -operation DeleteDistinguishedNames { - input: DeleteDistinguishedNames_Input, - output: DeleteDistinguishedNames_Output -} diff --git a/model/security/delete_distinguished_names/structures.smithy b/model/security/delete_distinguished_names/structures.smithy deleted file mode 100644 index ee16b557..00000000 --- a/model/security/delete_distinguished_names/structures.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure DeleteDistinguishedNames_Input { - @required - @httpLabel - cluster_name: String -} - -@output -structure DeleteDistinguishedNames_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/delete_role/operations.smithy b/model/security/delete_role/operations.smithy deleted file mode 100644 index e037206f..00000000 --- a/model/security/delete_role/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#delete-role" -) - -@xOperationGroup("security.delete_role") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_plugins/_security/api/roles/{role}") -@documentation("Delete the specified role.") -operation DeleteRole { - input: DeleteRole_Input, - output: DeleteRole_Output -} diff --git a/model/security/delete_role/structures.smithy b/model/security/delete_role/structures.smithy deleted file mode 100644 index c36a2bc8..00000000 --- a/model/security/delete_role/structures.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure DeleteRole_Input{ - @required - @httpLabel - role: String -} - -@output -structure DeleteRole_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/delete_role_mapping/operations.smithy b/model/security/delete_role_mapping/operations.smithy deleted file mode 100644 index 20f94edb..00000000 --- a/model/security/delete_role_mapping/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping" -) - -@xOperationGroup("security.delete_role_mapping") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_plugins/_security/api/rolesmapping/{role}") -@documentation("Deletes the specified role mapping.") -operation DeleteRoleMapping { - input: DeleteRoleMapping_Input, - output: DeleteRoleMapping_Output -} diff --git a/model/security/delete_role_mapping/structures.smithy b/model/security/delete_role_mapping/structures.smithy deleted file mode 100644 index cc9f3100..00000000 --- a/model/security/delete_role_mapping/structures.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure DeleteRoleMapping_Input{ - @required - @httpLabel - role: String -} - -@output -structure DeleteRoleMapping_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/delete_tenant/operations.smithy b/model/security/delete_tenant/operations.smithy deleted file mode 100644 index 21127cdf..00000000 --- a/model/security/delete_tenant/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group" -) - -@xOperationGroup("security.delete_tenant") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict", "HttpMethodSemantics.UnexpectedPayload"]) -@http(method: "DELETE", uri: "/_plugins/_security/api/tenants/{tenant}") -@documentation("Delete the specified tenant.") -operation DeleteTenant { - input: DeleteTenant_Input, - output: DeleteTenant_Output -} diff --git a/model/security/delete_tenant/structures.smithy b/model/security/delete_tenant/structures.smithy deleted file mode 100644 index ca0bae9c..00000000 --- a/model/security/delete_tenant/structures.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure DeleteTenant_Input{ - @required - @httpLabel - tenant: String -} - -@output -structure DeleteTenant_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/delete_user/operations.smithy b/model/security/delete_user/operations.smithy deleted file mode 100644 index 2fc3e1a4..00000000 --- a/model/security/delete_user/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#delete-user" -) - -@xOperationGroup("security.delete_user") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_plugins/_security/api/internalusers/{username}") -@documentation("Delete the specified user.") -operation DeleteUser { - input: DeleteUser_Input, - output: DeleteUser_Output -} diff --git a/model/security/delete_user/structures.smithy b/model/security/delete_user/structures.smithy deleted file mode 100644 index f258af93..00000000 --- a/model/security/delete_user/structures.smithy +++ /dev/null @@ -1,22 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - - -@input -structure DeleteUser_Input { - @required - @httpLabel - username: String -} - -@output -structure DeleteUser_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/distinguished_name.smithy b/model/security/distinguished_name.smithy deleted file mode 100644 index 07fe5657..00000000 --- a/model/security/distinguished_name.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -map DistinguishedNamesMap { - key: String, - value: DistinguishedNames -} - -structure DistinguishedNames { - nodes_dn: NodesDn -} - -list NodesDn { - member: String -} diff --git a/model/security/flush_cache/operations.smithy b/model/security/flush_cache/operations.smithy deleted file mode 100644 index 60c30ba5..00000000 --- a/model/security/flush_cache/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/2.7/security/access-control/api/#flush-cache" -) - -@xOperationGroup("security.flush_cache") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@idempotent -@http(method: "DELETE", uri: "/_plugins/_security/api/cache") -@documentation("Flushes the Security plugin user, authentication, and authorization cache.") -operation FlushCache { - input: FlushCache_Input, - output: FlushCache_Output -} diff --git a/model/security/flush_cache/structures.smithy b/model/security/flush_cache/structures.smithy deleted file mode 100644 index 92e05447..00000000 --- a/model/security/flush_cache/structures.smithy +++ /dev/null @@ -1,17 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure FlushCache_Input {} - -@output -structure FlushCache_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/get_account_details/operations.smithy b/model/security/get_account_details/operations.smithy deleted file mode 100644 index 430276a9..00000000 --- a/model/security/get_account_details/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#get-account-details" -) - -@xOperationGroup("security.get_account_details") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_security/api/account") -@documentation("Returns account details for the current user.") -operation GetAccountDetails{ - input: GetAccountDetails_Input, - output: GetAccountDetails_Output -} diff --git a/model/security/get_account_details/structures.smithy b/model/security/get_account_details/structures.smithy deleted file mode 100644 index 35987099..00000000 --- a/model/security/get_account_details/structures.smithy +++ /dev/null @@ -1,17 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure GetAccountDetails_Input{} - -@output -structure GetAccountDetails_Output { - @httpPayload - content: AccountDetails -} diff --git a/model/security/get_action_group/operations.smithy b/model/security/get_action_group/operations.smithy deleted file mode 100644 index b1a9641b..00000000 --- a/model/security/get_action_group/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#get-action-group" -) - -@xOperationGroup("security.get_action_group") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict", "HttpMethodSemantics.UnexpectedPayload"]) -@http(method: "GET", uri: "/_plugins/_security/api/actiongroups/{action_group}") -@documentation("Retrieves one action group.") -operation GetActionGroup { - input: GetActionGroup_Input, - output: GetActionGroup_Output -} diff --git a/model/security/get_action_group/structures.smithy b/model/security/get_action_group/structures.smithy deleted file mode 100644 index bc5a1fca..00000000 --- a/model/security/get_action_group/structures.smithy +++ /dev/null @@ -1,22 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure GetActionGroup_Input{ - @required - @httpLabel - @documentation("Action group to retrieve.") - action_group: String -} - -@output -structure GetActionGroup_Output { - @httpPayload - content: ActionGroupsMap -} diff --git a/model/security/get_action_groups/operations.smithy b/model/security/get_action_groups/operations.smithy deleted file mode 100644 index 605eca62..00000000 --- a/model/security/get_action_groups/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#get-action-groups" -) - -@xOperationGroup("security.get_action_groups") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_security/api/actiongroups") -@documentation("Retrieves all action groups.") -operation GetActionGroups { - input: GetActionGroups_Input, - output: GetActionGroups_Output -} diff --git a/model/security/get_action_groups/structures.smithy b/model/security/get_action_groups/structures.smithy deleted file mode 100644 index 9834ea73..00000000 --- a/model/security/get_action_groups/structures.smithy +++ /dev/null @@ -1,17 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure GetActionGroups_Input {} - -@output -structure GetActionGroups_Output { - @httpPayload - content: ActionGroupsMap -} diff --git a/model/security/get_audit_configuration/operations.smithy b/model/security/get_audit_configuration/operations.smithy deleted file mode 100644 index 64d6d2d2..00000000 --- a/model/security/get_audit_configuration/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#audit-logs" -) - -@xOperationGroup("security.get_audit_configuration") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_security/api/audit") -@documentation("Retrieves the audit configuration.") -operation GetAuditConfiguration { - input: GetAuditConfiguration_Input, - output: GetAuditConfiguration_Output -} diff --git a/model/security/get_audit_configuration/structures.smithy b/model/security/get_audit_configuration/structures.smithy deleted file mode 100644 index 6bdff688..00000000 --- a/model/security/get_audit_configuration/structures.smithy +++ /dev/null @@ -1,18 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure GetAuditConfiguration_Input{ -} - -@output -structure GetAuditConfiguration_Output { - @httpPayload - content: AuditConfigWithReadOnly -} diff --git a/model/security/get_certificates/operations.smithy b/model/security/get_certificates/operations.smithy deleted file mode 100644 index 4a81e75a..00000000 --- a/model/security/get_certificates/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#get-certificates" -) - -@xOperationGroup("security.get_certificates") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_security/api/ssl/certs") -@documentation("Retrieves the cluster’s security certificates.") -operation GetCertificates { - input: GetCertificates_Input, - output: GetCertificates_Output -} diff --git a/model/security/get_certificates/structures.smithy b/model/security/get_certificates/structures.smithy deleted file mode 100644 index b8c09add..00000000 --- a/model/security/get_certificates/structures.smithy +++ /dev/null @@ -1,17 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure GetCertificates_Input {} - -@output -structure GetCertificates_Output { - http_certificates_list: CertificatesList, - transport_certificates_list: CertificatesList -} diff --git a/model/security/get_configuration/operations.smithy b/model/security/get_configuration/operations.smithy deleted file mode 100644 index aa67e915..00000000 --- a/model/security/get_configuration/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/2.7/security/access-control/api/#get-configuration" -) - -@xOperationGroup("security.get_configuration") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict", "HttpMethodSemantics.UnexpectedPayload"]) -@http(method: "GET", uri: "/_plugins/_security/api/securityconfig") -@documentation("Returns the current Security plugin configuration in JSON format.") -operation GetConfiguration { - input: GetConfiguration_Input, - output: GetConfiguration_Output -} diff --git a/model/security/get_configuration/structures.smithy b/model/security/get_configuration/structures.smithy deleted file mode 100644 index e06a8b36..00000000 --- a/model/security/get_configuration/structures.smithy +++ /dev/null @@ -1,18 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure GetConfiguration_Input{ -} - -@output -structure GetConfiguration_Output { - @httpPayload - content: DynamicConfig -} diff --git a/model/security/get_distinguished_names/operations.smithy b/model/security/get_distinguished_names/operations.smithy deleted file mode 100644 index be5b337b..00000000 --- a/model/security/get_distinguished_names/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names" -) - -@xOperationGroup("security.get_distinguished_names") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_security/api/nodesdn") -@documentation("Retrieves all distinguished names in the allow list.") -operation GetDistinguishedNames { - input: GetDistinguishedNames_Input, - output: GetDistinguishedNames_Output -} - -@xOperationGroup("security.get_distinguished_names") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict", "HttpMethodSemantics.UnexpectedPayload"]) -@http(method: "GET", uri: "/_plugins/_security/api/nodesdn/{cluster_name}") -@documentation("Retrieve distinguished names of a specified cluster.") -operation GetDistinguishedNamesWithClusterName { - input: GetDistinguishedNamesWithClusterName_Input, - output: GetDistinguishedNamesWithClusterName_Output -} diff --git a/model/security/get_distinguished_names/structures.smithy b/model/security/get_distinguished_names/structures.smithy deleted file mode 100644 index b5e1f5e5..00000000 --- a/model/security/get_distinguished_names/structures.smithy +++ /dev/null @@ -1,30 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure GetDistinguishedNames_Input {} - -@input -structure GetDistinguishedNamesWithClusterName_Input{ - @required - @httpLabel - cluster_name: String -} - -@output -structure GetDistinguishedNames_Output { - @httpPayload - content: DistinguishedNamesMap -} - -@output -structure GetDistinguishedNamesWithClusterName_Output { - @httpPayload - content: DistinguishedNamesMap -} diff --git a/model/security/get_role/operations.smithy b/model/security/get_role/operations.smithy deleted file mode 100644 index 61944a04..00000000 --- a/model/security/get_role/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#get-role" -) - -@xOperationGroup("security.get_role") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict", "HttpMethodSemantics.UnexpectedPayload"]) -@http(method: "GET", uri: "/_plugins/_security/api/roles/{role}") -@documentation("Retrieves one role.") -operation GetRole { - input: GetRole_Input, - output: GetRole_Output -} diff --git a/model/security/get_role/structures.smithy b/model/security/get_role/structures.smithy deleted file mode 100644 index c39953f1..00000000 --- a/model/security/get_role/structures.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure GetRole_Input{ - @required - @httpLabel - role: String -} - -@output -structure GetRole_Output { - @httpPayload - content: RolesMap -} diff --git a/model/security/get_role_mapping/operations.smithy b/model/security/get_role_mapping/operations.smithy deleted file mode 100644 index bff917c2..00000000 --- a/model/security/get_role_mapping/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping" -) - -@xOperationGroup("security.get_role_mapping") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict", "HttpMethodSemantics.UnexpectedPayload"]) -@http(method: "GET", uri: "/_plugins/_security/api/rolesmapping/{role}") -@documentation("Retrieves one role mapping.") -operation GetRoleMapping { - input: GetRoleMapping_Input, - output: GetRoleMapping_Output -} diff --git a/model/security/get_role_mapping/structures.smithy b/model/security/get_role_mapping/structures.smithy deleted file mode 100644 index bb3000db..00000000 --- a/model/security/get_role_mapping/structures.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure GetRoleMapping_Input{ - @required - @httpLabel - role: String -} - -@output -structure GetRoleMapping_Output { - @httpPayload - content: RoleMappings -} diff --git a/model/security/get_role_mappings/operations.smithy b/model/security/get_role_mappings/operations.smithy deleted file mode 100644 index cfb5832e..00000000 --- a/model/security/get_role_mappings/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#get-role-mappings" -) - -@xOperationGroup("security.get_role_mappings") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_security/api/rolesmapping") -@documentation("Retrieves all role mappings.") -operation GetRoleMappings { - input: GetRoleMappings_Input, - output: GetRoleMappings_Output -} diff --git a/model/security/get_role_mappings/structures.smithy b/model/security/get_role_mappings/structures.smithy deleted file mode 100644 index e040589f..00000000 --- a/model/security/get_role_mappings/structures.smithy +++ /dev/null @@ -1,17 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure GetRoleMappings_Input {} - -@output -structure GetRoleMappings_Output { - @httpPayload - content: RoleMappings -} diff --git a/model/security/get_roles/operations.smithy b/model/security/get_roles/operations.smithy deleted file mode 100644 index 21f6e858..00000000 --- a/model/security/get_roles/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#get-roles" -) - -@xOperationGroup("security.get_roles") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_security/api/roles/") -@documentation("Retrieves all roles.") -operation GetRoles { - input: GetRoles_Input, - output: GetRoles_Output -} diff --git a/model/security/get_roles/structures.smithy b/model/security/get_roles/structures.smithy deleted file mode 100644 index b7ba78cd..00000000 --- a/model/security/get_roles/structures.smithy +++ /dev/null @@ -1,17 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure GetRoles_Input {} - -@output -structure GetRoles_Output { - @httpPayload - content: RolesMap -} diff --git a/model/security/get_tenant/operations.smithy b/model/security/get_tenant/operations.smithy deleted file mode 100644 index ca84a96e..00000000 --- a/model/security/get_tenant/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/2.7/security/access-control/api/#get-tenant" -) - -@xOperationGroup("security.get_tenant") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict", "HttpMethodSemantics.UnexpectedPayload"]) -@http(method: "GET", uri: "/_plugins/_security/api/tenants/{tenant}") -@documentation("Retrieves one tenant.") -operation GetTenant { - input: GetTenant_Input, - output: GetTenant_Output -} diff --git a/model/security/get_tenant/structures.smithy b/model/security/get_tenant/structures.smithy deleted file mode 100644 index 6a12fd2e..00000000 --- a/model/security/get_tenant/structures.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure GetTenant_Input{ - @required - @httpLabel - tenant: String -} - -@output -structure GetTenant_Output { - @httpPayload - content: TenantsMap -} diff --git a/model/security/get_tenants/operations.smithy b/model/security/get_tenants/operations.smithy deleted file mode 100644 index e3224da2..00000000 --- a/model/security/get_tenants/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/2.7/security/access-control/api/#get-tenants" -) - -@xOperationGroup("security.get_tenants") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_security/api/tenants/") -@documentation("Retrieves all tenants.") -operation GetTenants { - input: GetTenants_Input, - output: GetTenants_Output -} diff --git a/model/security/get_tenants/structures.smithy b/model/security/get_tenants/structures.smithy deleted file mode 100644 index e073974c..00000000 --- a/model/security/get_tenants/structures.smithy +++ /dev/null @@ -1,17 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure GetTenants_Input {} - -@output -structure GetTenants_Output { - @httpPayload - content: TenantsMap -} diff --git a/model/security/get_user/operations.smithy b/model/security/get_user/operations.smithy deleted file mode 100644 index 6ec179ef..00000000 --- a/model/security/get_user/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#get-user" -) - -@xOperationGroup("security.get_user") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict", "HttpMethodSemantics.UnexpectedPayload"]) -@http(method: "GET", uri: "/_plugins/_security/api/internalusers/{username}") -@documentation("Retrieve one internal user.") -operation GetUser { - input: GetUser_Input, - output: GetUser_Output -} diff --git a/model/security/get_user/structures.smithy b/model/security/get_user/structures.smithy deleted file mode 100644 index 0e839acb..00000000 --- a/model/security/get_user/structures.smithy +++ /dev/null @@ -1,22 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - - -@input -structure GetUser_Input{ - @required - @httpLabel - username: String -} - -@output -structure GetUser_Output { - @httpPayload - content: UsersMap -} diff --git a/model/security/get_users/operations.smithy b/model/security/get_users/operations.smithy deleted file mode 100644 index d98ecdf8..00000000 --- a/model/security/get_users/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#get-users" -) - -@xOperationGroup("security.get_users") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_security/api/internalusers") -@documentation("Retrieve all internal users.") -operation GetUsers { - input: GetUsers_Input, - output: GetUsers_Output -} diff --git a/model/security/get_users/structures.smithy b/model/security/get_users/structures.smithy deleted file mode 100644 index 8deb4f8d..00000000 --- a/model/security/get_users/structures.smithy +++ /dev/null @@ -1,17 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure GetUsers_Input {} - -@output -structure GetUsers_Output { - @httpPayload - content: UsersMap -} diff --git a/model/security/health/operations.smithy b/model/security/health/operations.smithy deleted file mode 100644 index 1df7213a..00000000 --- a/model/security/health/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#health-check" -) - -@xOperationGroup("security.health") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_plugins/_security/health") -@documentation("Checks to see if the Security plugin is up and running.") -operation SecurityHealth { - input: SecurityHealth_Input, - output: SecurityHealth_Output -} diff --git a/model/security/health/structures.smithy b/model/security/health/structures.smithy deleted file mode 100644 index e896fe23..00000000 --- a/model/security/health/structures.smithy +++ /dev/null @@ -1,18 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure SecurityHealth_Input { -} - -structure SecurityHealth_Output { - message: String - mode: String - status: String -} diff --git a/model/security/patch.smithy b/model/security/patch.smithy deleted file mode 100644 index f7ffd68a..00000000 --- a/model/security/patch.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -list PatchOperationList { - member: PatchOperation -} - -structure PatchOperation { - @documentation("The operation to perform. Possible values: remove,add, replace, move, copy, test.") - @required - op: String,@documentation("The path to the resource.") - @required - path: String,@documentation("The new values used for the update.") - value: Document -} diff --git a/model/security/patch_action_group/operations.smithy b/model/security/patch_action_group/operations.smithy deleted file mode 100644 index 5e204ed7..00000000 --- a/model/security/patch_action_group/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#patch-action-group" -) - -@xOperationGroup("security.patch_action_group") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PATCH", uri: "/_plugins/_security/api/actiongroups/{action_group}") -@documentation("Updates individual attributes of an action group.") -operation PatchActionGroup { - input: PatchActionGroup_Input, - output: PatchActionGroup_Output -} diff --git a/model/security/patch_action_group/structures.smithy b/model/security/patch_action_group/structures.smithy deleted file mode 100644 index 42a3b0e2..00000000 --- a/model/security/patch_action_group/structures.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure PatchActionGroup_Input { - @required - @httpLabel - action_group: String - @required - @httpPayload - content: PatchOperationList -} - -@output -structure PatchActionGroup_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/patch_action_groups/operations.smithy b/model/security/patch_action_groups/operations.smithy deleted file mode 100644 index 6a835865..00000000 --- a/model/security/patch_action_groups/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#patch-action-groups" -) - -@xOperationGroup("security.patch_action_groups") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PATCH", uri: "/_plugins/_security/api/actiongroups") -@documentation("Creates, updates, or deletes multiple action groups in a single call.") -operation PatchActionGroups { - input: PatchActionGroups_Input, - output: PatchActionGroups_Output -} diff --git a/model/security/patch_action_groups/structures.smithy b/model/security/patch_action_groups/structures.smithy deleted file mode 100644 index 3414feb5..00000000 --- a/model/security/patch_action_groups/structures.smithy +++ /dev/null @@ -1,20 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure PatchActionGroups_Input { - @required - @httpPayload - content: PatchOperationList -} -@output -structure PatchActionGroups_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/patch_audit_configuration/operations.smithy b/model/security/patch_audit_configuration/operations.smithy deleted file mode 100644 index 6a05eb8e..00000000 --- a/model/security/patch_audit_configuration/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#audit-logs" -) - -@xOperationGroup("security.patch_audit_configuration") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PATCH", uri: "/_plugins/_security/api/audit") -@documentation("A PATCH call is used to update specified fields in the audit configuration.") -operation PatchAuditConfiguration { - input: PatchAuditConfiguration_Input, - output: PatchAuditConfiguration_Output -} diff --git a/model/security/patch_audit_configuration/structures.smithy b/model/security/patch_audit_configuration/structures.smithy deleted file mode 100644 index 804ba3ae..00000000 --- a/model/security/patch_audit_configuration/structures.smithy +++ /dev/null @@ -1,19 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure PatchAuditConfiguration_Input { - @required - @httpPayload - content: PatchOperationList -} - -@output -structure PatchAuditConfiguration_Output { -} diff --git a/model/security/patch_configuration/operations.smithy b/model/security/patch_configuration/operations.smithy deleted file mode 100644 index 3548f23a..00000000 --- a/model/security/patch_configuration/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/2.7/security/access-control/api/#patch-configuration" -) - -@xOperationGroup("security.patch_configuration") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PATCH", uri: "/_plugins/_security/api/securityconfig") -@documentation("A PATCH call is used to update the existing configuration using the REST API.") -operation PatchConfiguration { - input: PatchConfiguration_Input, - output: PatchConfiguration_Output -} diff --git a/model/security/patch_configuration/structures.smithy b/model/security/patch_configuration/structures.smithy deleted file mode 100644 index a2164d7a..00000000 --- a/model/security/patch_configuration/structures.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure PatchConfiguration_Input { - @required - @httpPayload - content: PatchOperationList -} - -@output -structure PatchConfiguration_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/patch_distinguished_names/operations.smithy b/model/security/patch_distinguished_names/operations.smithy deleted file mode 100644 index b5cb0b1c..00000000 --- a/model/security/patch_distinguished_names/operations.smithy +++ /dev/null @@ -1,24 +0,0 @@ - -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#update-all-distinguished-names" -) - -@xOperationGroup("security.patch_distinguished_names") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PATCH", uri: "/_plugins/_security/api/nodesdn") -@documentation("Bulk update of distinguished names.") -operation PatchDistinguishedNames { - input: PatchDistinguishedNames_Input, - output: PatchDistinguishedNames_Output -} diff --git a/model/security/patch_distinguished_names/structures.smithy b/model/security/patch_distinguished_names/structures.smithy deleted file mode 100644 index 05031ea1..00000000 --- a/model/security/patch_distinguished_names/structures.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure PatchDistinguishedNames_Input { - @required - @httpPayload - content: PatchOperationList -} - -@output -structure PatchDistinguishedNames_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/patch_role/operations.smithy b/model/security/patch_role/operations.smithy deleted file mode 100644 index e63cefb2..00000000 --- a/model/security/patch_role/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#patch-role" -) - -@xOperationGroup("security.patch_role") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PATCH", uri: "/_plugins/_security/api/roles/{role}") -@documentation("Updates individual attributes of a role.") -operation PatchRole { - input: PatchRole_Input, - output: PatchRole_Output -} diff --git a/model/security/patch_role/structures.smithy b/model/security/patch_role/structures.smithy deleted file mode 100644 index ece87332..00000000 --- a/model/security/patch_role/structures.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure PatchRole_Input{ - @required - @httpLabel - role: String - @required - @httpPayload - content: PatchOperationList -} - -@output -structure PatchRole_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/patch_role_mapping/operations.smithy b/model/security/patch_role_mapping/operations.smithy deleted file mode 100644 index 0e9197a8..00000000 --- a/model/security/patch_role_mapping/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mapping" -) - -@xOperationGroup("security.patch_role_mapping") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PATCH", uri: "/_plugins/_security/api/rolesmapping/{role}") -@documentation("Updates individual attributes of a role mapping.") -operation PatchRoleMapping { - input: PatchRoleMapping_Input, - output: PatchRoleMapping_Output -} diff --git a/model/security/patch_role_mapping/structures.smithy b/model/security/patch_role_mapping/structures.smithy deleted file mode 100644 index c0d3f4ba..00000000 --- a/model/security/patch_role_mapping/structures.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure PatchRoleMapping_Input{ - @required - @httpLabel - role: String - @required - @httpPayload - content: PatchOperationList -} - -@output -structure PatchRoleMapping_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/patch_role_mappings/operations.smithy b/model/security/patch_role_mappings/operations.smithy deleted file mode 100644 index ee6faf4e..00000000 --- a/model/security/patch_role_mappings/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mappings" -) - -@xOperationGroup("security.patch_role_mappings") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PATCH", uri: "/_plugins/_security/api/rolesmapping") -@documentation("Creates or updates multiple role mappings in a single call.") -operation PatchRoleMappings { - input: PatchRoleMappings_Input, - output: PatchRoleMappings_Output -} diff --git a/model/security/patch_role_mappings/structures.smithy b/model/security/patch_role_mappings/structures.smithy deleted file mode 100644 index d6e1093a..00000000 --- a/model/security/patch_role_mappings/structures.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure PatchRoleMappings_Input { - @required - @httpPayload - content: PatchOperationList -} - -@output -structure PatchRoleMappings_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/patch_roles/operations.smithy b/model/security/patch_roles/operations.smithy deleted file mode 100644 index 42a32a4a..00000000 --- a/model/security/patch_roles/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#patch-roles" -) - -@xOperationGroup("security.patch_roles") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PATCH", uri: "/_plugins/_security/api/roles") -@documentation("Creates, updates, or deletes multiple roles in a single call.") -operation PatchRoles { - input: PatchRoles_Input, - output: PatchRoles_Output -} diff --git a/model/security/patch_roles/structures.smithy b/model/security/patch_roles/structures.smithy deleted file mode 100644 index 45368c19..00000000 --- a/model/security/patch_roles/structures.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure PatchRoles_Input { - @required - @httpPayload - content: PatchOperationList -} - -@output -structure PatchRoles_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/patch_tenant/operations.smithy b/model/security/patch_tenant/operations.smithy deleted file mode 100644 index 5e3713b9..00000000 --- a/model/security/patch_tenant/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/2.7/security/access-control/api/#patch-tenant" -) - -@xOperationGroup("security.patch_tenant") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PATCH", uri: "/_plugins/_security/api/tenants/{tenant}") -@documentation("Add, delete, or modify a single tenant.") -operation PatchTenant { - input: PatchTenant_Input, - output: PatchTenant_Output -} diff --git a/model/security/patch_tenant/structures.smithy b/model/security/patch_tenant/structures.smithy deleted file mode 100644 index 2fa4d882..00000000 --- a/model/security/patch_tenant/structures.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure PatchTenant_Input { - @required - @httpLabel - tenant: String - @required - @httpPayload - content: PatchOperationList -} - -@output -structure PatchTenant_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/patch_tenants/operations.smithy b/model/security/patch_tenants/operations.smithy deleted file mode 100644 index fe4fa997..00000000 --- a/model/security/patch_tenants/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/2.7/security/access-control/api/#patch-tenants" -) - -@xOperationGroup("security.patch_tenants") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PATCH", uri: "/_plugins/_security/api/tenants/") -@documentation("Add, delete, or modify multiple tenants in a single call.") -operation PatchTenants { - input: PatchTenants_Input, - output: PatchTenants_Output -} diff --git a/model/security/patch_tenants/structures.smithy b/model/security/patch_tenants/structures.smithy deleted file mode 100644 index c5517c82..00000000 --- a/model/security/patch_tenants/structures.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure PatchTenants_Input{ - @required - @httpPayload - content: PatchOperationList -} - -@output -structure PatchTenants_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/patch_user/operations.smithy b/model/security/patch_user/operations.smithy deleted file mode 100644 index 7c7f216f..00000000 --- a/model/security/patch_user/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#patch-user" -) - -@xOperationGroup("security.patch_user") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PATCH", uri: "/_plugins/_security/api/internalusers/{username}") -@documentation("Updates individual attributes of an internal user.") -operation PatchUser { - input: PatchUser_Input, - output: PatchUser_Output -} diff --git a/model/security/patch_user/structures.smithy b/model/security/patch_user/structures.smithy deleted file mode 100644 index d015c80f..00000000 --- a/model/security/patch_user/structures.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure PatchUser_Input { - @required - @httpLabel - username: String - @required - @httpPayload - content: PatchOperationList -} - -@output -structure PatchUser_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/patch_users/operations.smithy b/model/security/patch_users/operations.smithy deleted file mode 100644 index 8fb41749..00000000 --- a/model/security/patch_users/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#patch-users" -) - -@xOperationGroup("security.patch_users") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PATCH", uri: "/_plugins/_security/api/internalusers") -@documentation("Creates, updates, or deletes multiple internal users in a single call.") -operation PatchUsers { - input: PatchUsers_Input, - output: PatchUsers_Output -} diff --git a/model/security/patch_users/structures.smithy b/model/security/patch_users/structures.smithy deleted file mode 100644 index be5a1ae8..00000000 --- a/model/security/patch_users/structures.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure PatchUsers_Input{ - @required - @httpPayload - content: PatchOperationList -} - -@output -structure PatchUsers_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/reload_http_certificates/operations.smithy b/model/security/reload_http_certificates/operations.smithy deleted file mode 100644 index da4e564d..00000000 --- a/model/security/reload_http_certificates/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates" -) - -@xOperationGroup("security.reload_http_certificates") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict", "HttpMethodSemantics.UnexpectedPayload"]) -@http(method: "PUT", uri: "/_plugins/_security/api/ssl/http/reloadcerts") -@documentation("Reload HTTP layer communication certificates.") -operation ReloadHttpCertificates { - input: ReloadHttpCertificates_Input, - output: ReloadHttpCertificates_Output -} diff --git a/model/security/reload_http_certificates/structures.smithy b/model/security/reload_http_certificates/structures.smithy deleted file mode 100644 index d6d9e9e9..00000000 --- a/model/security/reload_http_certificates/structures.smithy +++ /dev/null @@ -1,17 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure ReloadHttpCertificates_Input {} - -@output -structure ReloadHttpCertificates_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/reload_transport_certificates/operations.smithy b/model/security/reload_transport_certificates/operations.smithy deleted file mode 100644 index 94007743..00000000 --- a/model/security/reload_transport_certificates/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates" -) - -@xOperationGroup("security.reload_transport_certificates") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_plugins/_security/api/ssl/transport/reloadcerts") -@documentation("Reload transport layer communication certificates.") -operation ReloadTransportCertificates { - input: ReloadTransportCertificates_Input, - output: ReloadTransportCertificates_Output -} diff --git a/model/security/reload_transport_certificates/structures.smithy b/model/security/reload_transport_certificates/structures.smithy deleted file mode 100644 index 7edd1840..00000000 --- a/model/security/reload_transport_certificates/structures.smithy +++ /dev/null @@ -1,17 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure ReloadTransportCertificates_Input {} - -@output -structure ReloadTransportCertificates_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/role.smithy b/model/security/role.smithy deleted file mode 100644 index 951a0da4..00000000 --- a/model/security/role.smithy +++ /dev/null @@ -1,68 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -map RolesMap { - key: String - value: Role -} - -structure Role { - reserved: Boolean - hidden: Boolean - description: String - cluster_permissions: ClusterPermission - index_permissions: IndexPermissionList - tenant_permissions: TenantPermissionList - static: Boolean -} - -list ClusterPermission { - member: String -} - -structure IndexPermission { - index_patterns: IndexPatterns - dls: String - fls: Fls - masked_fields: MaskedFields - allowed_actions: AllowedActions -} - -list IndexPermissionList { - member: IndexPermission -} - -structure TenantPermission { - tenant_patterns: TenantPatterns - allowed_actions: AllowedActions -} - -list TenantPermissionList { - member: TenantPermission -} - -list TenantPatterns { - member: String -} - -list IndexPatterns { - member: String -} - -list Fls { - member: String -} - -list MaskedFields { - member: String -} - -list AllowedActions { - member: String -} diff --git a/model/security/role_mapping.smithy b/model/security/role_mapping.smithy deleted file mode 100644 index 6ee75c93..00000000 --- a/model/security/role_mapping.smithy +++ /dev/null @@ -1,39 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -map RoleMappings { - key: String, - value: RoleMapping -} - -structure RoleMapping{ - hosts: Hosts - users: Users - reserved: Boolean - hidden: Boolean - backend_roles: BackendRoles - and_backend_roles: AndBackendRoles - description: String -} - -list Hosts{ - member: String -} - -list Users{ - member: String -} - -list BackendRoles{ - member: String -} - -list AndBackendRoles{ - member: String -} diff --git a/model/security/security.smithy b/model/security/security.smithy deleted file mode 100644 index d62fa7e3..00000000 --- a/model/security/security.smithy +++ /dev/null @@ -1,14 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@documentation("Security Operation Message") -string SecurityOperationMessage - -@documentation("Security Operation Status") -string SecurityOperationStatus diff --git a/model/security/tenant.smithy b/model/security/tenant.smithy deleted file mode 100644 index 59b9881a..00000000 --- a/model/security/tenant.smithy +++ /dev/null @@ -1,20 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -structure Tenant { - reserved: Boolean, - hidden: Boolean, - description: String, - static: Boolean -} - -map TenantsMap { - key: String, - value: Tenant -} diff --git a/model/security/update_audit_configuration/operations.smithy b/model/security/update_audit_configuration/operations.smithy deleted file mode 100644 index 49a22e61..00000000 --- a/model/security/update_audit_configuration/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#audit-logs" -) - -@xOperationGroup("security.update_audit_configuration") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_plugins/_security/api/audit/config") -@documentation("Updates the audit configuration.") -operation UpdateAuditConfiguration { - input: UpdateAuditConfiguration_Input, - output: UpdateAuditConfiguration_Output -} diff --git a/model/security/update_audit_configuration/structures.smithy b/model/security/update_audit_configuration/structures.smithy deleted file mode 100644 index ba122bc2..00000000 --- a/model/security/update_audit_configuration/structures.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure UpdateAuditConfiguration_Input{ - @required - @httpPayload - content: AuditConfig -} - -@output -structure UpdateAuditConfiguration_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/update_configuration/operations.smithy b/model/security/update_configuration/operations.smithy deleted file mode 100644 index 74bf85d6..00000000 --- a/model/security/update_configuration/operations.smithy +++ /dev/null @@ -1,24 +0,0 @@ - -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/2.7/security/access-control/api/#update-configuration" -) - -@xOperationGroup("security.update_configuration") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_plugins/_security/api/securityconfig/config") -@documentation("Adds or updates the existing configuration using the REST API.") -operation UpdateConfiguration { - input: UpdateConfiguration_Input, - output: UpdateConfiguration_Output -} diff --git a/model/security/update_configuration/structures.smithy b/model/security/update_configuration/structures.smithy deleted file mode 100644 index 6ba096e2..00000000 --- a/model/security/update_configuration/structures.smithy +++ /dev/null @@ -1,21 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure UpdateConfiguration_Input{ - @required - @httpPayload - content: DynamicConfig -} - -@output -structure UpdateConfiguration_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/update_distinguished_names/operations.smithy b/model/security/update_distinguished_names/operations.smithy deleted file mode 100644 index dbe8bbc5..00000000 --- a/model/security/update_distinguished_names/operations.smithy +++ /dev/null @@ -1,24 +0,0 @@ - -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names" -) - -@xOperationGroup("security.update_distinguished_names") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_plugins/_security/api/nodesdn/{cluster_name}") -@documentation("Adds or updates the specified distinguished names in the cluster’s or node’s allow list.") -operation UpdateDistinguishedNames { - input: UpdateDistinguishedNames_Input, - output: UpdateDistinguishedNames_Output -} diff --git a/model/security/update_distinguished_names/structures.smithy b/model/security/update_distinguished_names/structures.smithy deleted file mode 100644 index 740ba4e3..00000000 --- a/model/security/update_distinguished_names/structures.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@input -structure UpdateDistinguishedNames_Input { - @required - @httpLabel - cluster_name: String - @httpPayload - content: DistinguishedNames -} - -@output -structure UpdateDistinguishedNames_Output { - status: SecurityOperationStatus, - message: SecurityOperationMessage -} diff --git a/model/security/user.smithy b/model/security/user.smithy deleted file mode 100644 index a7c121f7..00000000 --- a/model/security/user.smithy +++ /dev/null @@ -1,37 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -map UsersMap { - key: String, - value: User -} - -structure User { - hash: String, - reserved: Boolean, - hidden: Boolean, - backend_roles: BackendRolesList, - attributes: UserAttributes, - description: String, - opendistro_security_roles: OpendistroSecurityRolesList, - static: Boolean -} - -list BackendRolesList { - member: String -} - -map UserAttributes { - key: String, - value: String -} - -list OpendistroSecurityRolesList { - member: String -} diff --git a/model/snapshot/cleanup_repository/operations.smithy b/model/snapshot/cleanup_repository/operations.smithy deleted file mode 100644 index 964f8620..00000000 --- a/model/snapshot/cleanup_repository/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("snapshot.cleanup_repository") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_snapshot/{repository}/_cleanup") -@documentation("Removes stale data from repository.") -operation SnapshotCleanupRepository { - input: SnapshotCleanupRepository_Input, - output: SnapshotCleanupRepository_Output -} diff --git a/model/snapshot/cleanup_repository/structures.smithy b/model/snapshot/cleanup_repository/structures.smithy deleted file mode 100644 index fcd2b435..00000000 --- a/model/snapshot/cleanup_repository/structures.smithy +++ /dev/null @@ -1,31 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure SnapshotCleanupRepository_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("timeout") - timeout: Timeout, -} - - -@input -structure SnapshotCleanupRepository_Input with [SnapshotCleanupRepository_QueryParams] { - @required - @httpLabel - repository: PathRepository, -} - -// TODO: Fill in Output Structure -structure SnapshotCleanupRepository_Output {} diff --git a/model/snapshot/clone/operations.smithy b/model/snapshot/clone/operations.smithy deleted file mode 100644 index 74c49f8f..00000000 --- a/model/snapshot/clone/operations.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("snapshot.clone") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}") -@documentation("Clones indices from one snapshot into another snapshot in the same repository.") -operation SnapshotClone { - input: SnapshotClone_Input, - output: SnapshotClone_Output -} diff --git a/model/snapshot/clone/structures.smithy b/model/snapshot/clone/structures.smithy deleted file mode 100644 index 038135ec..00000000 --- a/model/snapshot/clone/structures.smithy +++ /dev/null @@ -1,42 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure SnapshotClone_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - -// TODO: Fill in Body Parameters -@documentation("The snapshot clone definition") -structure SnapshotClone_BodyParams {} - -@input -structure SnapshotClone_Input with [SnapshotClone_QueryParams] { - @required - @httpLabel - repository: PathRepository, - - @required - @httpLabel - snapshot: PathSnapshot, - - @required - @httpLabel - target_snapshot: PathTargetSnapshot, - @required - @httpPayload - content: SnapshotClone_BodyParams, -} - -// TODO: Fill in Output Structure -structure SnapshotClone_Output {} diff --git a/model/snapshot/create/operations.smithy b/model/snapshot/create/operations.smithy deleted file mode 100644 index b321eeb5..00000000 --- a/model/snapshot/create/operations.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/" -) - -@xOperationGroup("snapshot.create") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_snapshot/{repository}/{snapshot}") -@documentation("Creates a snapshot in a repository.") -operation SnapshotCreate_Put { - input: SnapshotCreate_Put_Input, - output: SnapshotCreate_Output -} - -@xOperationGroup("snapshot.create") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_snapshot/{repository}/{snapshot}") -@documentation("Creates a snapshot in a repository.") -operation SnapshotCreate_Post { - input: SnapshotCreate_Post_Input, - output: SnapshotCreate_Output -} diff --git a/model/snapshot/create/structures.smithy b/model/snapshot/create/structures.smithy deleted file mode 100644 index d041eeee..00000000 --- a/model/snapshot/create/structures.smithy +++ /dev/null @@ -1,54 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure SnapshotCreate_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("wait_for_completion") - @default(false) - wait_for_completion: WaitForCompletionFalse, -} - -// TODO: Fill in Body Parameters -@documentation("The snapshot definition") -structure SnapshotCreate_BodyParams {} - -@input -structure SnapshotCreate_Put_Input with [SnapshotCreate_QueryParams] { - @required - @httpLabel - repository: PathRepository, - - @required - @httpLabel - snapshot: PathSnapshot, - @httpPayload - content: SnapshotCreate_BodyParams, -} - -@input -structure SnapshotCreate_Post_Input with [SnapshotCreate_QueryParams] { - @required - @httpLabel - repository: PathRepository, - - @required - @httpLabel - snapshot: PathSnapshot, - @httpPayload - content: SnapshotCreate_BodyParams, -} - -// TODO: Fill in Output Structure -structure SnapshotCreate_Output {} diff --git a/model/snapshot/create_repository/operations.smithy b/model/snapshot/create_repository/operations.smithy deleted file mode 100644 index 49608ee5..00000000 --- a/model/snapshot/create_repository/operations.smithy +++ /dev/null @@ -1,33 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/" -) - -@xOperationGroup("snapshot.create_repository") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "PUT", uri: "/_snapshot/{repository}") -@documentation("Creates a repository.") -operation SnapshotCreateRepository_Put { - input: SnapshotCreateRepository_Put_Input, - output: SnapshotCreateRepository_Output -} - -@xOperationGroup("snapshot.create_repository") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_snapshot/{repository}") -@documentation("Creates a repository.") -operation SnapshotCreateRepository_Post { - input: SnapshotCreateRepository_Post_Input, - output: SnapshotCreateRepository_Output -} diff --git a/model/snapshot/create_repository/structures.smithy b/model/snapshot/create_repository/structures.smithy deleted file mode 100644 index 45a63050..00000000 --- a/model/snapshot/create_repository/structures.smithy +++ /dev/null @@ -1,50 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure SnapshotCreateRepository_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("timeout") - timeout: Timeout, - - @httpQuery("verify") - verify: Verify, -} - -// TODO: Fill in Body Parameters -@documentation("The repository definition") -structure SnapshotCreateRepository_BodyParams {} - -@input -structure SnapshotCreateRepository_Put_Input with [SnapshotCreateRepository_QueryParams] { - @required - @httpLabel - repository: PathRepository, - @required - @httpPayload - content: SnapshotCreateRepository_BodyParams, -} - -@input -structure SnapshotCreateRepository_Post_Input with [SnapshotCreateRepository_QueryParams] { - @required - @httpLabel - repository: PathRepository, - @required - @httpPayload - content: SnapshotCreateRepository_BodyParams, -} - -// TODO: Fill in Output Structure -structure SnapshotCreateRepository_Output {} diff --git a/model/snapshot/delete/operations.smithy b/model/snapshot/delete/operations.smithy deleted file mode 100644 index c0e4e58f..00000000 --- a/model/snapshot/delete/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/" -) - -@xOperationGroup("snapshot.delete") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_snapshot/{repository}/{snapshot}") -@documentation("Deletes a snapshot.") -operation SnapshotDelete { - input: SnapshotDelete_Input, - output: SnapshotDelete_Output -} diff --git a/model/snapshot/delete/structures.smithy b/model/snapshot/delete/structures.smithy deleted file mode 100644 index 5f938fc7..00000000 --- a/model/snapshot/delete/structures.smithy +++ /dev/null @@ -1,32 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure SnapshotDelete_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, -} - - -@input -structure SnapshotDelete_Input with [SnapshotDelete_QueryParams] { - @required - @httpLabel - repository: PathRepository, - - @required - @httpLabel - snapshot: PathSnapshot, -} - -// TODO: Fill in Output Structure -structure SnapshotDelete_Output {} diff --git a/model/snapshot/delete_repository/operations.smithy b/model/snapshot/delete_repository/operations.smithy deleted file mode 100644 index b709dbf2..00000000 --- a/model/snapshot/delete_repository/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/" -) - -@xOperationGroup("snapshot.delete_repository") -@xVersionAdded("1.0") -@idempotent -@suppress(["HttpUriConflict"]) -@http(method: "DELETE", uri: "/_snapshot/{repository}") -@documentation("Deletes a repository.") -operation SnapshotDeleteRepository { - input: SnapshotDeleteRepository_Input, - output: SnapshotDeleteRepository_Output -} diff --git a/model/snapshot/delete_repository/structures.smithy b/model/snapshot/delete_repository/structures.smithy deleted file mode 100644 index 1d7c1371..00000000 --- a/model/snapshot/delete_repository/structures.smithy +++ /dev/null @@ -1,32 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure SnapshotDeleteRepository_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("timeout") - timeout: Timeout, -} - - -@input -structure SnapshotDeleteRepository_Input with [SnapshotDeleteRepository_QueryParams] { - @required - @httpLabel - @documentation("Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported.") - repository: PathRepositories, -} - -// TODO: Fill in Output Structure -structure SnapshotDeleteRepository_Output {} diff --git a/model/snapshot/get/operations.smithy b/model/snapshot/get/operations.smithy deleted file mode 100644 index a6a0fea3..00000000 --- a/model/snapshot/get/operations.smithy +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -// TODO: Fill in API Reference URL -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest" -) - -@xOperationGroup("snapshot.get") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_snapshot/{repository}/{snapshot}") -@documentation("Returns information about a snapshot.") -operation SnapshotGet { - input: SnapshotGet_Input, - output: SnapshotGet_Output -} diff --git a/model/snapshot/get/structures.smithy b/model/snapshot/get/structures.smithy deleted file mode 100644 index 3508aa7f..00000000 --- a/model/snapshot/get/structures.smithy +++ /dev/null @@ -1,40 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure SnapshotGet_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("ignore_unavailable") - @default(false) - ignore_unavailable: DfExplainSnapshot, - - @httpQuery("verbose") - @documentation("Whether to show verbose snapshot info or only show the basic info found in the repository index blob.") - verbose: Verbose, -} - - -@input -structure SnapshotGet_Input with [SnapshotGet_QueryParams] { - @required - @httpLabel - repository: PathRepository, - - @required - @httpLabel - snapshot: PathSnapshots, -} - -// TODO: Fill in Output Structure -structure SnapshotGet_Output {} diff --git a/model/snapshot/get_repository/operations.smithy b/model/snapshot/get_repository/operations.smithy deleted file mode 100644 index a133f155..00000000 --- a/model/snapshot/get_repository/operations.smithy +++ /dev/null @@ -1,34 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/" -) - -@xOperationGroup("snapshot.get_repository") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_snapshot") -@documentation("Returns information about a repository.") -operation SnapshotGetRepository { - input: SnapshotGetRepository_Input, - output: SnapshotGetRepository_Output -} - -@xOperationGroup("snapshot.get_repository") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_snapshot/{repository}") -@documentation("Returns information about a repository.") -operation SnapshotGetRepository_WithRepository { - input: SnapshotGetRepository_WithRepository_Input, - output: SnapshotGetRepository_Output -} diff --git a/model/snapshot/get_repository/structures.smithy b/model/snapshot/get_repository/structures.smithy deleted file mode 100644 index 94aa93cf..00000000 --- a/model/snapshot/get_repository/structures.smithy +++ /dev/null @@ -1,36 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure SnapshotGetRepository_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("local") - @default(false) - local: Local, -} - - -@input -structure SnapshotGetRepository_Input with [SnapshotGetRepository_QueryParams] { -} - -@input -structure SnapshotGetRepository_WithRepository_Input with [SnapshotGetRepository_QueryParams] { - @required - @httpLabel - repository: PathRepositories, -} - -// TODO: Fill in Output Structure -structure SnapshotGetRepository_Output {} diff --git a/model/snapshot/restore/operations.smithy b/model/snapshot/restore/operations.smithy deleted file mode 100644 index 00c935bf..00000000 --- a/model/snapshot/restore/operations.smithy +++ /dev/null @@ -1,22 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot/" -) - -@xOperationGroup("snapshot.restore") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_snapshot/{repository}/{snapshot}/_restore") -@documentation("Restores a snapshot.") -operation SnapshotRestore { - input: SnapshotRestore_Input, - output: SnapshotRestore_Output -} diff --git a/model/snapshot/restore/structures.smithy b/model/snapshot/restore/structures.smithy deleted file mode 100644 index f61e314f..00000000 --- a/model/snapshot/restore/structures.smithy +++ /dev/null @@ -1,41 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure SnapshotRestore_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("wait_for_completion") - @default(false) - wait_for_completion: WaitForCompletionFalse, -} - -// TODO: Fill in Body Parameters -@documentation("Details of what to restore") -structure SnapshotRestore_BodyParams {} - -@input -structure SnapshotRestore_Input with [SnapshotRestore_QueryParams] { - @required - @httpLabel - repository: PathRepository, - - @required - @httpLabel - snapshot: PathSnapshot, - @httpPayload - content: SnapshotRestore_BodyParams, -} - -// TODO: Fill in Output Structure -structure SnapshotRestore_Output {} diff --git a/model/snapshot/status/operations.smithy b/model/snapshot/status/operations.smithy deleted file mode 100644 index 445248da..00000000 --- a/model/snapshot/status/operations.smithy +++ /dev/null @@ -1,45 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/" -) - -@xOperationGroup("snapshot.status") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_snapshot/_status") -@documentation("Returns information about the status of a snapshot.") -operation SnapshotStatus { - input: SnapshotStatus_Input, - output: SnapshotStatus_Output -} - -@xOperationGroup("snapshot.status") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_snapshot/{repository}/_status") -@documentation("Returns information about the status of a snapshot.") -operation SnapshotStatus_WithRepository { - input: SnapshotStatus_WithRepository_Input, - output: SnapshotStatus_Output -} - -@xOperationGroup("snapshot.status") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_snapshot/{repository}/{snapshot}/_status") -@documentation("Returns information about the status of a snapshot.") -operation SnapshotStatus_WithRepositorySnapshot { - input: SnapshotStatus_WithRepositorySnapshot_Input, - output: SnapshotStatus_Output -} diff --git a/model/snapshot/status/structures.smithy b/model/snapshot/status/structures.smithy deleted file mode 100644 index 8d9cd6d6..00000000 --- a/model/snapshot/status/structures.smithy +++ /dev/null @@ -1,47 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure SnapshotStatus_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("ignore_unavailable") - @default(false) - ignore_unavailable: DfExplainSnapshot, -} - - -@input -structure SnapshotStatus_Input with [SnapshotStatus_QueryParams] { -} - -@input -structure SnapshotStatus_WithRepository_Input with [SnapshotStatus_QueryParams] { - @required - @httpLabel - repository: PathRepository, -} - -@input -structure SnapshotStatus_WithRepositorySnapshot_Input with [SnapshotStatus_QueryParams] { - @required - @httpLabel - repository: PathRepository, - - @required - @httpLabel - snapshot: PathSnapshots, -} - -// TODO: Fill in Output Structure -structure SnapshotStatus_Output {} diff --git a/model/snapshot/verify_repository/operations.smithy b/model/snapshot/verify_repository/operations.smithy deleted file mode 100644 index 201facaf..00000000 --- a/model/snapshot/verify_repository/operations.smithy +++ /dev/null @@ -1,22 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/" -) - -@xOperationGroup("snapshot.verify_repository") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_snapshot/{repository}/_verify") -@documentation("Verifies a repository.") -operation SnapshotVerifyRepository { - input: SnapshotVerifyRepository_Input, - output: SnapshotVerifyRepository_Output -} diff --git a/model/snapshot/verify_repository/structures.smithy b/model/snapshot/verify_repository/structures.smithy deleted file mode 100644 index f236e3ab..00000000 --- a/model/snapshot/verify_repository/structures.smithy +++ /dev/null @@ -1,31 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure SnapshotVerifyRepository_QueryParams { - @httpQuery("master_timeout") - master_timeout: MasterTimeout, - - @httpQuery("cluster_manager_timeout") - cluster_manager_timeout: ClusterManagerTimeout, - - @httpQuery("timeout") - timeout: Timeout, -} - - -@input -structure SnapshotVerifyRepository_Input with [SnapshotVerifyRepository_QueryParams] { - @required - @httpLabel - repository: PathRepository, -} - -// TODO: Fill in Output Structure -structure SnapshotVerifyRepository_Output {} diff --git a/model/specification_extensions.smithy b/model/specification_extensions.smithy deleted file mode 100644 index 4920f4c7..00000000 --- a/model/specification_extensions.smithy +++ /dev/null @@ -1,53 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -use smithy.openapi#specificationExtension - -@trait -@specificationExtension(as: "x-data-type") -enum xDataType { - ARRAY = "array", - TIME = "time" -} - -@trait -@specificationExtension(as: "x-enum-options") -list xEnumOptions { - member: String -} - -@trait -@specificationExtension(as: "x-deprecation-message") -string xDeprecationMessage - -@trait -@specificationExtension(as: "x-version-deprecated") -string xVersionDeprecated - -@trait -@specificationExtension(as: "x-operation-group") -string xOperationGroup - -@trait -@specificationExtension(as: "x-version-added") -string xVersionAdded - -@trait -@specificationExtension(as: "x-serialize") -enum xSerialize { - BULK = "bulk" -} - -@trait -@specificationExtension(as: "x-overloaded-param") -string xOverloadedParam - -@trait -@specificationExtension(as: "x-ignorable") -boolean xIgnorable diff --git a/model/tasks/cancel/operations.smithy b/model/tasks/cancel/operations.smithy deleted file mode 100644 index 2c3f1760..00000000 --- a/model/tasks/cancel/operations.smithy +++ /dev/null @@ -1,32 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling" -) - -@xOperationGroup("tasks.cancel") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_tasks/_cancel") -@documentation("Cancels a task, if it can be cancelled through an API.") -operation TasksCancel { - input: TasksCancel_Input, - output: TasksCancel_Output -} - -@xOperationGroup("tasks.cancel") -@xVersionAdded("1.0") -@suppress(["HttpUriConflict"]) -@http(method: "POST", uri: "/_tasks/{task_id}/_cancel") -@documentation("Cancels a task, if it can be cancelled through an API.") -operation TasksCancel_WithTaskId { - input: TasksCancel_WithTaskId_Input, - output: TasksCancel_Output -} diff --git a/model/tasks/cancel/structures.smithy b/model/tasks/cancel/structures.smithy deleted file mode 100644 index a126a1ca..00000000 --- a/model/tasks/cancel/structures.smithy +++ /dev/null @@ -1,42 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure TasksCancel_QueryParams { - @httpQuery("nodes") - nodes: Nodes, - - @httpQuery("actions") - @documentation("Comma-separated list of actions that should be cancelled. Leave empty to cancel all.") - actions: Actions, - - @httpQuery("parent_task_id") - @documentation("Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all.") - parent_task_id: ParentTaskId, - - @httpQuery("wait_for_completion") - @default(false) - wait_for_completion: WaitForCompletionFalse, -} - - -@input -structure TasksCancel_Input with [TasksCancel_QueryParams] { -} - -@input -structure TasksCancel_WithTaskId_Input with [TasksCancel_QueryParams] { - @required - @httpLabel - @documentation("Cancel the task with specified task id (node_id:task_number).") - task_id: PathTaskId, -} - -// TODO: Fill in Output Structure -structure TasksCancel_Output {} diff --git a/model/tasks/get/operations.smithy b/model/tasks/get/operations.smithy deleted file mode 100644 index d52ddfff..00000000 --- a/model/tasks/get/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/tasks/" -) - -@xOperationGroup("tasks.get") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_tasks/{task_id}") -@documentation("Returns information about a task.") -operation TasksGet { - input: TasksGet_Input, - output: TasksGet_Output -} diff --git a/model/tasks/get/structures.smithy b/model/tasks/get/structures.smithy deleted file mode 100644 index 54261272..00000000 --- a/model/tasks/get/structures.smithy +++ /dev/null @@ -1,30 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure TasksGet_QueryParams { - @httpQuery("wait_for_completion") - @default(false) - wait_for_completion: WaitForCompletionFalse, - - @httpQuery("timeout") - timeout: Timeout, -} - - -@input -structure TasksGet_Input with [TasksGet_QueryParams] { - @required - @httpLabel - @documentation("Return the task with specified id (node_id:task_number).") - task_id: PathTaskId, -} - -// TODO: Fill in Output Structure -structure TasksGet_Output {} diff --git a/model/tasks/list/operations.smithy b/model/tasks/list/operations.smithy deleted file mode 100644 index 719142e1..00000000 --- a/model/tasks/list/operations.smithy +++ /dev/null @@ -1,23 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@externalDocumentation( - "API Reference": "https://opensearch.org/docs/latest/api-reference/tasks/" -) - -@xOperationGroup("tasks.list") -@xVersionAdded("1.0") -@readonly -@suppress(["HttpUriConflict"]) -@http(method: "GET", uri: "/_tasks") -@documentation("Returns a list of tasks.") -operation TasksList { - input: TasksList_Input, - output: TasksList_Output -} diff --git a/model/tasks/list/structures.smithy b/model/tasks/list/structures.smithy deleted file mode 100644 index 7ae43732..00000000 --- a/model/tasks/list/structures.smithy +++ /dev/null @@ -1,46 +0,0 @@ -// SPDX-License-Identifier: Apache-2.0 -// -// The OpenSearch Contributors require contributions made to -// this file be licensed under the Apache-2.0 license or a -// compatible open source license. - -$version: "2" -namespace OpenSearch - -@mixin -structure TasksList_QueryParams { - @httpQuery("nodes") - nodes: Nodes, - - @httpQuery("actions") - @documentation("Comma-separated list of actions that should be returned. Leave empty to return all.") - actions: Actions, - - @httpQuery("detailed") - @documentation("Return detailed task information.") - @default(false) - detailed: Detailed, - - @httpQuery("parent_task_id") - @documentation("Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.") - parent_task_id: ParentTaskId, - - @httpQuery("wait_for_completion") - @default(false) - wait_for_completion: WaitForCompletionFalse, - - @httpQuery("group_by") - @default("nodes") - group_by: GroupBy, - - @httpQuery("timeout") - timeout: Timeout, -} - - -@input -structure TasksList_Input with [TasksList_QueryParams] { -} - -// TODO: Fill in Output Structure -structure TasksList_Output {} diff --git a/settings.gradle.kts b/settings.gradle.kts deleted file mode 100644 index d934a5de..00000000 --- a/settings.gradle.kts +++ /dev/null @@ -1 +0,0 @@ -rootProject.name = "opensearch-api-specification" diff --git a/smithy-build.json b/smithy-build.json deleted file mode 100644 index 34abf16a..00000000 --- a/smithy-build.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "version": "1.0", - "projections": { - "full": { - "plugins": { - "openapi": { - "service": "OpenSearch#OpenSearch", - "protocol": "aws.protocols#restJson1", - "tags": true, - "useIntegerType": true - } - } - } - } -} diff --git a/spec/OpenSearch.openapi.yaml b/spec/OpenSearch.openapi.yaml new file mode 100644 index 00000000..aa652e14 --- /dev/null +++ b/spec/OpenSearch.openapi.yaml @@ -0,0 +1,498 @@ +openapi: 3.1.0 +info: + title: OpenSearch API + description: OpenSearch API + version: 1.0.0 +paths: + /: + $ref: 'namespaces/_core.yaml#/paths/~1' + /_bulk: + $ref: 'namespaces/_core.yaml#/paths/~1_bulk' + /_count: + $ref: 'namespaces/_core.yaml#/paths/~1_count' + /_delete_by_query/{task_id}/_rethrottle: + $ref: 'namespaces/_core.yaml#/paths/~1_delete_by_query~1{task_id}~1_rethrottle' + /_field_caps: + $ref: 'namespaces/_core.yaml#/paths/~1_field_caps' + /_mget: + $ref: 'namespaces/_core.yaml#/paths/~1_mget' + /_msearch: + $ref: 'namespaces/_core.yaml#/paths/~1_msearch' + /_msearch/template: + $ref: 'namespaces/_core.yaml#/paths/~1_msearch~1template' + /_mtermvectors: + $ref: 'namespaces/_core.yaml#/paths/~1_mtermvectors' + /_rank_eval: + $ref: 'namespaces/_core.yaml#/paths/~1_rank_eval' + /_reindex: + $ref: 'namespaces/_core.yaml#/paths/~1_reindex' + /_reindex/{task_id}/_rethrottle: + $ref: 'namespaces/_core.yaml#/paths/~1_reindex~1{task_id}~1_rethrottle' + /_render/template: + $ref: 'namespaces/_core.yaml#/paths/~1_render~1template' + /_render/template/{id}: + $ref: 'namespaces/_core.yaml#/paths/~1_render~1template~1{id}' + /_script_context: + $ref: 'namespaces/_core.yaml#/paths/~1_script_context' + /_script_language: + $ref: 'namespaces/_core.yaml#/paths/~1_script_language' + /_scripts/painless/_execute: + $ref: 'namespaces/_core.yaml#/paths/~1_scripts~1painless~1_execute' + /_scripts/{id}: + $ref: 'namespaces/_core.yaml#/paths/~1_scripts~1{id}' + /_scripts/{id}/{context}: + $ref: 'namespaces/_core.yaml#/paths/~1_scripts~1{id}~1{context}' + /_search: + $ref: 'namespaces/_core.yaml#/paths/~1_search' + /_search/point_in_time: + $ref: 'namespaces/_core.yaml#/paths/~1_search~1point_in_time' + /_search/point_in_time/_all: + $ref: 'namespaces/_core.yaml#/paths/~1_search~1point_in_time~1_all' + /_search/scroll: + $ref: 'namespaces/_core.yaml#/paths/~1_search~1scroll' + /_search/scroll/{scroll_id}: + $ref: 'namespaces/_core.yaml#/paths/~1_search~1scroll~1{scroll_id}' + /_search/template: + $ref: 'namespaces/_core.yaml#/paths/~1_search~1template' + /_search_shards: + $ref: 'namespaces/_core.yaml#/paths/~1_search_shards' + /_update_by_query/{task_id}/_rethrottle: + $ref: 'namespaces/_core.yaml#/paths/~1_update_by_query~1{task_id}~1_rethrottle' + /{index}/_bulk: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_bulk' + /{index}/_count: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_count' + /{index}/_create/{id}: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_create~1{id}' + /{index}/_delete_by_query: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_delete_by_query' + /{index}/_doc: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_doc' + /{index}/_doc/{id}: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_doc~1{id}' + /{index}/_explain/{id}: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_explain~1{id}' + /{index}/_field_caps: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_field_caps' + /{index}/_mget: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_mget' + /{index}/_msearch: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_msearch' + /{index}/_msearch/template: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_msearch~1template' + /{index}/_mtermvectors: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_mtermvectors' + /{index}/_rank_eval: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_rank_eval' + /{index}/_search: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_search' + /{index}/_search/point_in_time: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_search~1point_in_time' + /{index}/_search/template: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_search~1template' + /{index}/_search_shards: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_search_shards' + /{index}/_source/{id}: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_source~1{id}' + /{index}/_termvectors: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_termvectors' + /{index}/_termvectors/{id}: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_termvectors~1{id}' + /{index}/_update/{id}: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_update~1{id}' + /{index}/_update_by_query: + $ref: 'namespaces/_core.yaml#/paths/~1{index}~1_update_by_query' + /_alias: + $ref: 'namespaces/indices.yaml#/paths/~1_alias' + /_alias/{name}: + $ref: 'namespaces/indices.yaml#/paths/~1_alias~1{name}' + /_aliases: + $ref: 'namespaces/indices.yaml#/paths/~1_aliases' + /_analyze: + $ref: 'namespaces/indices.yaml#/paths/~1_analyze' + /_cache/clear: + $ref: 'namespaces/indices.yaml#/paths/~1_cache~1clear' + /_data_stream: + $ref: 'namespaces/indices.yaml#/paths/~1_data_stream' + /_data_stream/_stats: + $ref: 'namespaces/indices.yaml#/paths/~1_data_stream~1_stats' + /_data_stream/{name}: + $ref: 'namespaces/indices.yaml#/paths/~1_data_stream~1{name}' + /_data_stream/{name}/_stats: + $ref: 'namespaces/indices.yaml#/paths/~1_data_stream~1{name}~1_stats' + /_flush: + $ref: 'namespaces/indices.yaml#/paths/~1_flush' + /_forcemerge: + $ref: 'namespaces/indices.yaml#/paths/~1_forcemerge' + /_index_template: + $ref: 'namespaces/indices.yaml#/paths/~1_index_template' + /_index_template/_simulate: + $ref: 'namespaces/indices.yaml#/paths/~1_index_template~1_simulate' + /_index_template/_simulate/{name}: + $ref: 'namespaces/indices.yaml#/paths/~1_index_template~1_simulate~1{name}' + /_index_template/_simulate_index/{name}: + $ref: 'namespaces/indices.yaml#/paths/~1_index_template~1_simulate_index~1{name}' + /_index_template/{name}: + $ref: 'namespaces/indices.yaml#/paths/~1_index_template~1{name}' + /_mapping: + $ref: 'namespaces/indices.yaml#/paths/~1_mapping' + /_mapping/field/{fields}: + $ref: 'namespaces/indices.yaml#/paths/~1_mapping~1field~1{fields}' + /_recovery: + $ref: 'namespaces/indices.yaml#/paths/~1_recovery' + /_refresh: + $ref: 'namespaces/indices.yaml#/paths/~1_refresh' + /_resolve/index/{name}: + $ref: 'namespaces/indices.yaml#/paths/~1_resolve~1index~1{name}' + /_segments: + $ref: 'namespaces/indices.yaml#/paths/~1_segments' + /_settings: + $ref: 'namespaces/indices.yaml#/paths/~1_settings' + /_settings/{name}: + $ref: 'namespaces/indices.yaml#/paths/~1_settings~1{name}' + /_shard_stores: + $ref: 'namespaces/indices.yaml#/paths/~1_shard_stores' + /_stats: + $ref: 'namespaces/indices.yaml#/paths/~1_stats' + /_stats/{metric}: + $ref: 'namespaces/indices.yaml#/paths/~1_stats~1{metric}' + /_template: + $ref: 'namespaces/indices.yaml#/paths/~1_template' + /_template/{name}: + $ref: 'namespaces/indices.yaml#/paths/~1_template~1{name}' + /_upgrade: + $ref: 'namespaces/indices.yaml#/paths/~1_upgrade' + /_validate/query: + $ref: 'namespaces/indices.yaml#/paths/~1_validate~1query' + /{alias}/_rollover: + $ref: 'namespaces/indices.yaml#/paths/~1{alias}~1_rollover' + /{alias}/_rollover/{new_index}: + $ref: 'namespaces/indices.yaml#/paths/~1{alias}~1_rollover~1{new_index}' + /{index}: + $ref: 'namespaces/indices.yaml#/paths/~1{index}' + /{index}/_alias: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_alias' + /{index}/_alias/{name}: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_alias~1{name}' + /{index}/_aliases/{name}: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_aliases~1{name}' + /{index}/_analyze: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_analyze' + /{index}/_block/{block}: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_block~1{block}' + /{index}/_cache/clear: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_cache~1clear' + /{index}/_clone/{target}: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_clone~1{target}' + /{index}/_close: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_close' + /{index}/_flush: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_flush' + /{index}/_forcemerge: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_forcemerge' + /{index}/_mapping: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_mapping' + /{index}/_mapping/field/{fields}: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_mapping~1field~1{fields}' + /{index}/_open: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_open' + /{index}/_recovery: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_recovery' + /{index}/_refresh: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_refresh' + /{index}/_segments: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_segments' + /{index}/_settings: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_settings' + /{index}/_settings/{name}: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_settings~1{name}' + /{index}/_shard_stores: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_shard_stores' + /{index}/_shrink/{target}: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_shrink~1{target}' + /{index}/_split/{target}: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_split~1{target}' + /{index}/_stats: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_stats' + /{index}/_stats/{metric}: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_stats~1{metric}' + /{index}/_upgrade: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_upgrade' + /{index}/_validate/query: + $ref: 'namespaces/indices.yaml#/paths/~1{index}~1_validate~1query' + /_cat: + $ref: 'namespaces/cat.yaml#/paths/~1_cat' + /_cat/aliases: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1aliases' + /_cat/aliases/{name}: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1aliases~1{name}' + /_cat/allocation: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1allocation' + /_cat/allocation/{node_id}: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1allocation~1{node_id}' + /_cat/cluster_manager: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1cluster_manager' + /_cat/count: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1count' + /_cat/count/{index}: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1count~1{index}' + /_cat/fielddata: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1fielddata' + /_cat/fielddata/{fields}: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1fielddata~1{fields}' + /_cat/health: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1health' + /_cat/indices: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1indices' + /_cat/indices/{index}: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1indices~1{index}' + /_cat/master: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1master' + /_cat/nodeattrs: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1nodeattrs' + /_cat/nodes: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1nodes' + /_cat/pending_tasks: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1pending_tasks' + /_cat/pit_segments: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1pit_segments' + /_cat/pit_segments/_all: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1pit_segments~1_all' + /_cat/plugins: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1plugins' + /_cat/recovery: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1recovery' + /_cat/recovery/{index}: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1recovery~1{index}' + /_cat/repositories: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1repositories' + /_cat/segment_replication: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1segment_replication' + /_cat/segment_replication/{index}: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1segment_replication~1{index}' + /_cat/segments: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1segments' + /_cat/segments/{index}: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1segments~1{index}' + /_cat/shards: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1shards' + /_cat/shards/{index}: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1shards~1{index}' + /_cat/snapshots: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1snapshots' + /_cat/snapshots/{repository}: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1snapshots~1{repository}' + /_cat/tasks: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1tasks' + /_cat/templates: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1templates' + /_cat/templates/{name}: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1templates~1{name}' + /_cat/thread_pool: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1thread_pool' + /_cat/thread_pool/{thread_pool_patterns}: + $ref: 'namespaces/cat.yaml#/paths/~1_cat~1thread_pool~1{thread_pool_patterns}' + /_cluster/allocation/explain: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1allocation~1explain' + /_cluster/decommission/awareness: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1decommission~1awareness' + /_cluster/decommission/awareness/{awareness_attribute_name}/_status: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1decommission~1awareness~1{awareness_attribute_name}~1_status' + /_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1decommission~1awareness~1{awareness_attribute_name}~1{awareness_attribute_value}' + /_cluster/health: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1health' + /_cluster/health/{index}: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1health~1{index}' + /_cluster/pending_tasks: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1pending_tasks' + /_cluster/reroute: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1reroute' + /_cluster/routing/awareness/weights: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1routing~1awareness~1weights' + /_cluster/routing/awareness/{attribute}/weights: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1routing~1awareness~1{attribute}~1weights' + /_cluster/settings: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1settings' + /_cluster/state: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1state' + /_cluster/state/{metric}: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1state~1{metric}' + /_cluster/state/{metric}/{index}: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1state~1{metric}~1{index}' + /_cluster/stats: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1stats' + /_cluster/stats/nodes/{node_id}: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1stats~1nodes~1{node_id}' + /_cluster/voting_config_exclusions: + $ref: 'namespaces/cluster.yaml#/paths/~1_cluster~1voting_config_exclusions' + /_component_template: + $ref: 'namespaces/cluster.yaml#/paths/~1_component_template' + /_component_template/{name}: + $ref: 'namespaces/cluster.yaml#/paths/~1_component_template~1{name}' + /_remote/info: + $ref: 'namespaces/cluster.yaml#/paths/~1_remote~1info' + /_cluster/nodes/hot_threads: + $ref: 'namespaces/nodes.yaml#/paths/~1_cluster~1nodes~1hot_threads' + /_cluster/nodes/hotthreads: + $ref: 'namespaces/nodes.yaml#/paths/~1_cluster~1nodes~1hotthreads' + /_cluster/nodes/{node_id}/hot_threads: + $ref: 'namespaces/nodes.yaml#/paths/~1_cluster~1nodes~1{node_id}~1hot_threads' + /_cluster/nodes/{node_id}/hotthreads: + $ref: 'namespaces/nodes.yaml#/paths/~1_cluster~1nodes~1{node_id}~1hotthreads' + /_nodes: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes' + /_nodes/hot_threads: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1hot_threads' + /_nodes/hotthreads: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1hotthreads' + /_nodes/reload_secure_settings: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1reload_secure_settings' + /_nodes/stats: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1stats' + /_nodes/stats/{metric}: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1stats~1{metric}' + /_nodes/stats/{metric}/{index_metric}: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1stats~1{metric}~1{index_metric}' + /_nodes/usage: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1usage' + /_nodes/usage/{metric}: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1usage~1{metric}' + /_nodes/{node_id}: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1{node_id}' + /_nodes/{node_id}/hot_threads: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1{node_id}~1hot_threads' + /_nodes/{node_id}/hotthreads: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1{node_id}~1hotthreads' + /_nodes/{node_id}/reload_secure_settings: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1{node_id}~1reload_secure_settings' + /_nodes/{node_id}/stats: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1{node_id}~1stats' + /_nodes/{node_id}/stats/{metric}: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1{node_id}~1stats~1{metric}' + /_nodes/{node_id}/stats/{metric}/{index_metric}: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1{node_id}~1stats~1{metric}~1{index_metric}' + /_nodes/{node_id}/usage: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1{node_id}~1usage' + /_nodes/{node_id}/usage/{metric}: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1{node_id}~1usage~1{metric}' + /_nodes/{node_id}/{metric}: + $ref: 'namespaces/nodes.yaml#/paths/~1_nodes~1{node_id}~1{metric}' + /_dangling: + $ref: 'namespaces/dangling_indices.yaml#/paths/~1_dangling' + /_dangling/{index_uuid}: + $ref: 'namespaces/dangling_indices.yaml#/paths/~1_dangling~1{index_uuid}' + /_ingest/pipeline: + $ref: 'namespaces/ingest.yaml#/paths/~1_ingest~1pipeline' + /_ingest/pipeline/_simulate: + $ref: 'namespaces/ingest.yaml#/paths/~1_ingest~1pipeline~1_simulate' + /_ingest/pipeline/{id}: + $ref: 'namespaces/ingest.yaml#/paths/~1_ingest~1pipeline~1{id}' + /_ingest/pipeline/{id}/_simulate: + $ref: 'namespaces/ingest.yaml#/paths/~1_ingest~1pipeline~1{id}~1_simulate' + /_ingest/processor/grok: + $ref: 'namespaces/ingest.yaml#/paths/~1_ingest~1processor~1grok' + /_plugins/_knn/models/_search: + $ref: 'namespaces/knn.yaml#/paths/~1_plugins~1_knn~1models~1_search' + /_plugins/_knn/models/_train: + $ref: 'namespaces/knn.yaml#/paths/~1_plugins~1_knn~1models~1_train' + /_plugins/_knn/models/{model_id}: + $ref: 'namespaces/knn.yaml#/paths/~1_plugins~1_knn~1models~1{model_id}' + /_plugins/_knn/models/{model_id}/_train: + $ref: 'namespaces/knn.yaml#/paths/~1_plugins~1_knn~1models~1{model_id}~1_train' + /_plugins/_knn/stats: + $ref: 'namespaces/knn.yaml#/paths/~1_plugins~1_knn~1stats' + /_plugins/_knn/stats/{stat}: + $ref: 'namespaces/knn.yaml#/paths/~1_plugins~1_knn~1stats~1{stat}' + /_plugins/_knn/warmup/{index}: + $ref: 'namespaces/knn.yaml#/paths/~1_plugins~1_knn~1warmup~1{index}' + /_plugins/_knn/{node_id}/stats: + $ref: 'namespaces/knn.yaml#/paths/~1_plugins~1_knn~1{node_id}~1stats' + /_plugins/_knn/{node_id}/stats/{stat}: + $ref: 'namespaces/knn.yaml#/paths/~1_plugins~1_knn~1{node_id}~1stats~1{stat}' + /_plugins/_notifications/configs: + $ref: 'namespaces/notifications.yaml#/paths/~1_plugins~1_notifications~1configs' + /_plugins/_notifications/configs/{config_id}: + $ref: 'namespaces/notifications.yaml#/paths/~1_plugins~1_notifications~1configs~1{config_id}' + /_plugins/_notifications/feature/test/{config_id}: + $ref: 'namespaces/notifications.yaml#/paths/~1_plugins~1_notifications~1feature~1test~1{config_id}' + /_plugins/_notifications/features: + $ref: 'namespaces/notifications.yaml#/paths/~1_plugins~1_notifications~1features' + /_plugins/_security/api/account: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1account' + /_plugins/_security/api/actiongroups: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1actiongroups' + /_plugins/_security/api/actiongroups/{action_group}: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1actiongroups~1{action_group}' + /_plugins/_security/api/audit: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1audit' + /_plugins/_security/api/audit/config: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1audit~1config' + /_plugins/_security/api/cache: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1cache' + /_plugins/_security/api/internalusers: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1internalusers' + /_plugins/_security/api/internalusers/{username}: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1internalusers~1{username}' + /_plugins/_security/api/nodesdn: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1nodesdn' + /_plugins/_security/api/nodesdn/{cluster_name}: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1nodesdn~1{cluster_name}' + /_plugins/_security/api/roles: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1roles' + /_plugins/_security/api/roles/: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1roles~1' + /_plugins/_security/api/roles/{role}: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1roles~1{role}' + /_plugins/_security/api/rolesmapping: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1rolesmapping' + /_plugins/_security/api/rolesmapping/{role}: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1rolesmapping~1{role}' + /_plugins/_security/api/securityconfig: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1securityconfig' + /_plugins/_security/api/securityconfig/config: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1securityconfig~1config' + /_plugins/_security/api/ssl/certs: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1ssl~1certs' + /_plugins/_security/api/ssl/http/reloadcerts: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1ssl~1http~1reloadcerts' + /_plugins/_security/api/ssl/transport/reloadcerts: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1ssl~1transport~1reloadcerts' + /_plugins/_security/api/tenants/: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1tenants~1' + /_plugins/_security/api/tenants/{tenant}: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1api~1tenants~1{tenant}' + /_plugins/_security/health: + $ref: 'namespaces/security.yaml#/paths/~1_plugins~1_security~1health' + /_remotestore/_restore: + $ref: 'namespaces/remote_store.yaml#/paths/~1_remotestore~1_restore' + /_search/pipeline/{pipeline}: + $ref: 'namespaces/search_pipeline.yaml#/paths/~1_search~1pipeline~1{pipeline}' + /_snapshot: + $ref: 'namespaces/snapshot.yaml#/paths/~1_snapshot' + /_snapshot/_status: + $ref: 'namespaces/snapshot.yaml#/paths/~1_snapshot~1_status' + /_snapshot/{repository}: + $ref: 'namespaces/snapshot.yaml#/paths/~1_snapshot~1{repository}' + /_snapshot/{repository}/_cleanup: + $ref: 'namespaces/snapshot.yaml#/paths/~1_snapshot~1{repository}~1_cleanup' + /_snapshot/{repository}/_status: + $ref: 'namespaces/snapshot.yaml#/paths/~1_snapshot~1{repository}~1_status' + /_snapshot/{repository}/_verify: + $ref: 'namespaces/snapshot.yaml#/paths/~1_snapshot~1{repository}~1_verify' + /_snapshot/{repository}/{snapshot}: + $ref: 'namespaces/snapshot.yaml#/paths/~1_snapshot~1{repository}~1{snapshot}' + /_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}: + $ref: 'namespaces/snapshot.yaml#/paths/~1_snapshot~1{repository}~1{snapshot}~1_clone~1{target_snapshot}' + /_snapshot/{repository}/{snapshot}/_restore: + $ref: 'namespaces/snapshot.yaml#/paths/~1_snapshot~1{repository}~1{snapshot}~1_restore' + /_snapshot/{repository}/{snapshot}/_status: + $ref: 'namespaces/snapshot.yaml#/paths/~1_snapshot~1{repository}~1{snapshot}~1_status' + /_tasks: + $ref: 'namespaces/tasks.yaml#/paths/~1_tasks' + /_tasks/_cancel: + $ref: 'namespaces/tasks.yaml#/paths/~1_tasks~1_cancel' + /_tasks/{task_id}: + $ref: 'namespaces/tasks.yaml#/paths/~1_tasks~1{task_id}' + /_tasks/{task_id}/_cancel: + $ref: 'namespaces/tasks.yaml#/paths/~1_tasks~1{task_id}~1_cancel' diff --git a/spec/namespaces/_core.yaml b/spec/namespaces/_core.yaml new file mode 100644 index 00000000..987962d9 --- /dev/null +++ b/spec/namespaces/_core.yaml @@ -0,0 +1,6240 @@ +openapi: 3.1.0 +info: + title: OpenSearch _core API + description: OpenSearch _core API + version: 1.0.0 +paths: + /: + get: + operationId: info.0 + x-operation-group: info + x-version-added: '1.0' + description: Returns basic information about the cluster. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: [] + responses: + '200': + $ref: '#/components/responses/info@200' + head: + operationId: ping.0 + x-operation-group: ping + x-version-added: '1.0' + description: Returns whether the cluster is running. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: [] + responses: + '200': + $ref: '#/components/responses/ping@200' + /_bulk: + post: + operationId: bulk.0 + x-operation-group: bulk + x-version-added: '1.0' + description: Allows to perform multiple index/update/delete operations in a single request. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/bulk/ + parameters: + - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' + - $ref: '#/components/parameters/bulk::query.refresh' + - $ref: '#/components/parameters/bulk::query.routing' + - $ref: '#/components/parameters/bulk::query.timeout' + - $ref: '#/components/parameters/bulk::query.type' + - $ref: '#/components/parameters/bulk::query._source' + - $ref: '#/components/parameters/bulk::query._source_excludes' + - $ref: '#/components/parameters/bulk::query._source_includes' + - $ref: '#/components/parameters/bulk::query.pipeline' + - $ref: '#/components/parameters/bulk::query.require_alias' + requestBody: + $ref: '#/components/requestBodies/bulk' + responses: + '200': + $ref: '#/components/responses/bulk@200' + put: + operationId: bulk.1 + x-operation-group: bulk + x-version-added: '1.0' + description: Allows to perform multiple index/update/delete operations in a single request. + parameters: + - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' + - $ref: '#/components/parameters/bulk::query.refresh' + - $ref: '#/components/parameters/bulk::query.routing' + - $ref: '#/components/parameters/bulk::query.timeout' + - $ref: '#/components/parameters/bulk::query.type' + - $ref: '#/components/parameters/bulk::query._source' + - $ref: '#/components/parameters/bulk::query._source_excludes' + - $ref: '#/components/parameters/bulk::query._source_includes' + - $ref: '#/components/parameters/bulk::query.pipeline' + - $ref: '#/components/parameters/bulk::query.require_alias' + requestBody: + $ref: '#/components/requestBodies/bulk' + responses: + '200': + $ref: '#/components/responses/bulk@200' + /_count: + get: + operationId: count.0 + x-operation-group: count + x-version-added: '1.0' + description: Returns number of documents matching a query. + parameters: + - $ref: '#/components/parameters/count::query.ignore_unavailable' + - $ref: '#/components/parameters/count::query.ignore_throttled' + - $ref: '#/components/parameters/count::query.allow_no_indices' + - $ref: '#/components/parameters/count::query.expand_wildcards' + - $ref: '#/components/parameters/count::query.min_score' + - $ref: '#/components/parameters/count::query.preference' + - $ref: '#/components/parameters/count::query.routing' + - $ref: '#/components/parameters/count::query.q' + - $ref: '#/components/parameters/count::query.analyzer' + - $ref: '#/components/parameters/count::query.analyze_wildcard' + - $ref: '#/components/parameters/count::query.default_operator' + - $ref: '#/components/parameters/count::query.df' + - $ref: '#/components/parameters/count::query.lenient' + - $ref: '#/components/parameters/count::query.terminate_after' + requestBody: + $ref: '#/components/requestBodies/count' + responses: + '200': + $ref: '#/components/responses/count@200' + post: + operationId: count.1 + x-operation-group: count + x-version-added: '1.0' + description: Returns number of documents matching a query. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/count/ + parameters: + - $ref: '#/components/parameters/count::query.ignore_unavailable' + - $ref: '#/components/parameters/count::query.ignore_throttled' + - $ref: '#/components/parameters/count::query.allow_no_indices' + - $ref: '#/components/parameters/count::query.expand_wildcards' + - $ref: '#/components/parameters/count::query.min_score' + - $ref: '#/components/parameters/count::query.preference' + - $ref: '#/components/parameters/count::query.routing' + - $ref: '#/components/parameters/count::query.q' + - $ref: '#/components/parameters/count::query.analyzer' + - $ref: '#/components/parameters/count::query.analyze_wildcard' + - $ref: '#/components/parameters/count::query.default_operator' + - $ref: '#/components/parameters/count::query.df' + - $ref: '#/components/parameters/count::query.lenient' + - $ref: '#/components/parameters/count::query.terminate_after' + requestBody: + $ref: '#/components/requestBodies/count' + responses: + '200': + $ref: '#/components/responses/count@200' + /_delete_by_query/{task_id}/_rethrottle: + post: + operationId: delete_by_query_rethrottle.0 + x-operation-group: delete_by_query_rethrottle + x-version-added: '1.0' + description: Changes the number of requests per second for a particular Delete By Query operation. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/delete_by_query_rethrottle::path.task_id' + - $ref: '#/components/parameters/delete_by_query_rethrottle::query.requests_per_second' + responses: + '200': + $ref: '#/components/responses/delete_by_query_rethrottle@200' + /_field_caps: + get: + operationId: field_caps.0 + x-operation-group: field_caps + x-version-added: '1.0' + description: Returns the information about the capabilities of fields among multiple indices. + externalDocs: + url: https://opensearch.org/docs/latest/field-types/supported-field-types/alias/#using-aliases-in-field-capabilities-api-operations + parameters: + - $ref: '#/components/parameters/field_caps::query.fields' + - $ref: '#/components/parameters/field_caps::query.ignore_unavailable' + - $ref: '#/components/parameters/field_caps::query.allow_no_indices' + - $ref: '#/components/parameters/field_caps::query.expand_wildcards' + - $ref: '#/components/parameters/field_caps::query.include_unmapped' + requestBody: + $ref: '#/components/requestBodies/field_caps' + responses: + '200': + $ref: '#/components/responses/field_caps@200' + post: + operationId: field_caps.1 + x-operation-group: field_caps + x-version-added: '1.0' + description: Returns the information about the capabilities of fields among multiple indices. + parameters: + - $ref: '#/components/parameters/field_caps::query.fields' + - $ref: '#/components/parameters/field_caps::query.ignore_unavailable' + - $ref: '#/components/parameters/field_caps::query.allow_no_indices' + - $ref: '#/components/parameters/field_caps::query.expand_wildcards' + - $ref: '#/components/parameters/field_caps::query.include_unmapped' + requestBody: + $ref: '#/components/requestBodies/field_caps' + responses: + '200': + $ref: '#/components/responses/field_caps@200' + /_mget: + get: + operationId: mget.0 + x-operation-group: mget + x-version-added: '1.0' + description: Allows to get multiple documents in one request. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/multi-get/ + parameters: + - $ref: '#/components/parameters/mget::query.stored_fields' + - $ref: '#/components/parameters/mget::query.preference' + - $ref: '#/components/parameters/mget::query.realtime' + - $ref: '#/components/parameters/mget::query.refresh' + - $ref: '#/components/parameters/mget::query.routing' + - $ref: '#/components/parameters/mget::query._source' + - $ref: '#/components/parameters/mget::query._source_excludes' + - $ref: '#/components/parameters/mget::query._source_includes' + requestBody: + $ref: '#/components/requestBodies/mget' + responses: + '200': + $ref: '#/components/responses/mget@200' + post: + operationId: mget.1 + x-operation-group: mget + x-version-added: '1.0' + description: Allows to get multiple documents in one request. + parameters: + - $ref: '#/components/parameters/mget::query.stored_fields' + - $ref: '#/components/parameters/mget::query.preference' + - $ref: '#/components/parameters/mget::query.realtime' + - $ref: '#/components/parameters/mget::query.refresh' + - $ref: '#/components/parameters/mget::query.routing' + - $ref: '#/components/parameters/mget::query._source' + - $ref: '#/components/parameters/mget::query._source_excludes' + - $ref: '#/components/parameters/mget::query._source_includes' + requestBody: + $ref: '#/components/requestBodies/mget' + responses: + '200': + $ref: '#/components/responses/mget@200' + /_msearch: + get: + operationId: msearch.0 + x-operation-group: msearch + x-version-added: '1.0' + description: Allows to execute several search operations in one request. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/multi-search/ + parameters: + - $ref: '#/components/parameters/msearch::query.search_type' + - $ref: '#/components/parameters/msearch::query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch::query.typed_keys' + - $ref: '#/components/parameters/msearch::query.pre_filter_shard_size' + - $ref: '#/components/parameters/msearch::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/msearch::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/msearch' + responses: + '200': + $ref: '#/components/responses/msearch@200' + post: + operationId: msearch.1 + x-operation-group: msearch + x-version-added: '1.0' + description: Allows to execute several search operations in one request. + parameters: + - $ref: '#/components/parameters/msearch::query.search_type' + - $ref: '#/components/parameters/msearch::query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch::query.typed_keys' + - $ref: '#/components/parameters/msearch::query.pre_filter_shard_size' + - $ref: '#/components/parameters/msearch::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/msearch::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/msearch' + responses: + '200': + $ref: '#/components/responses/msearch@200' + /_msearch/template: + get: + operationId: msearch_template.0 + x-operation-group: msearch_template + x-version-added: '1.0' + description: Allows to execute several search template operations in one request. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/search-template/ + parameters: + - $ref: '#/components/parameters/msearch_template::query.search_type' + - $ref: '#/components/parameters/msearch_template::query.typed_keys' + - $ref: '#/components/parameters/msearch_template::query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch_template::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch_template::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/msearch_template' + responses: + '200': + $ref: '#/components/responses/msearch_template@200' + post: + operationId: msearch_template.1 + x-operation-group: msearch_template + x-version-added: '1.0' + description: Allows to execute several search template operations in one request. + parameters: + - $ref: '#/components/parameters/msearch_template::query.search_type' + - $ref: '#/components/parameters/msearch_template::query.typed_keys' + - $ref: '#/components/parameters/msearch_template::query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch_template::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch_template::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/msearch_template' + responses: + '200': + $ref: '#/components/responses/msearch_template@200' + /_mtermvectors: + get: + operationId: mtermvectors.0 + x-operation-group: mtermvectors + x-version-added: '1.0' + description: Returns multiple termvectors in one request. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/mtermvectors::query.ids' + - $ref: '#/components/parameters/mtermvectors::query.term_statistics' + - $ref: '#/components/parameters/mtermvectors::query.field_statistics' + - $ref: '#/components/parameters/mtermvectors::query.fields' + - $ref: '#/components/parameters/mtermvectors::query.offsets' + - $ref: '#/components/parameters/mtermvectors::query.positions' + - $ref: '#/components/parameters/mtermvectors::query.payloads' + - $ref: '#/components/parameters/mtermvectors::query.preference' + - $ref: '#/components/parameters/mtermvectors::query.routing' + - $ref: '#/components/parameters/mtermvectors::query.realtime' + - $ref: '#/components/parameters/mtermvectors::query.version' + - $ref: '#/components/parameters/mtermvectors::query.version_type' + requestBody: + $ref: '#/components/requestBodies/mtermvectors' + responses: + '200': + $ref: '#/components/responses/mtermvectors@200' + post: + operationId: mtermvectors.1 + x-operation-group: mtermvectors + x-version-added: '1.0' + description: Returns multiple termvectors in one request. + parameters: + - $ref: '#/components/parameters/mtermvectors::query.ids' + - $ref: '#/components/parameters/mtermvectors::query.term_statistics' + - $ref: '#/components/parameters/mtermvectors::query.field_statistics' + - $ref: '#/components/parameters/mtermvectors::query.fields' + - $ref: '#/components/parameters/mtermvectors::query.offsets' + - $ref: '#/components/parameters/mtermvectors::query.positions' + - $ref: '#/components/parameters/mtermvectors::query.payloads' + - $ref: '#/components/parameters/mtermvectors::query.preference' + - $ref: '#/components/parameters/mtermvectors::query.routing' + - $ref: '#/components/parameters/mtermvectors::query.realtime' + - $ref: '#/components/parameters/mtermvectors::query.version' + - $ref: '#/components/parameters/mtermvectors::query.version_type' + requestBody: + $ref: '#/components/requestBodies/mtermvectors' + responses: + '200': + $ref: '#/components/responses/mtermvectors@200' + /_rank_eval: + get: + operationId: rank_eval.0 + x-operation-group: rank_eval + x-version-added: '1.0' + description: Allows to evaluate the quality of ranked search results over a set of typical search queries. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/rank-eval/ + parameters: + - $ref: '#/components/parameters/rank_eval::query.ignore_unavailable' + - $ref: '#/components/parameters/rank_eval::query.allow_no_indices' + - $ref: '#/components/parameters/rank_eval::query.expand_wildcards' + - $ref: '#/components/parameters/rank_eval::query.search_type' + requestBody: + $ref: '#/components/requestBodies/rank_eval' + responses: + '200': + $ref: '#/components/responses/rank_eval@200' + post: + operationId: rank_eval.1 + x-operation-group: rank_eval + x-version-added: '1.0' + description: Allows to evaluate the quality of ranked search results over a set of typical search queries. + parameters: + - $ref: '#/components/parameters/rank_eval::query.ignore_unavailable' + - $ref: '#/components/parameters/rank_eval::query.allow_no_indices' + - $ref: '#/components/parameters/rank_eval::query.expand_wildcards' + - $ref: '#/components/parameters/rank_eval::query.search_type' + requestBody: + $ref: '#/components/requestBodies/rank_eval' + responses: + '200': + $ref: '#/components/responses/rank_eval@200' + /_reindex: + post: + operationId: reindex.0 + x-operation-group: reindex + x-version-added: '1.0' + description: |- + Allows to copy documents from one index to another, optionally filtering the source + documents by a query, changing the destination index settings, or fetching the + documents from a remote cluster. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/reindex-data/ + parameters: + - $ref: '#/components/parameters/reindex::query.refresh' + - $ref: '#/components/parameters/reindex::query.timeout' + - $ref: '#/components/parameters/reindex::query.wait_for_active_shards' + - $ref: '#/components/parameters/reindex::query.wait_for_completion' + - $ref: '#/components/parameters/reindex::query.requests_per_second' + - $ref: '#/components/parameters/reindex::query.scroll' + - $ref: '#/components/parameters/reindex::query.slices' + - $ref: '#/components/parameters/reindex::query.max_docs' + requestBody: + $ref: '#/components/requestBodies/reindex' + responses: + '200': + $ref: '#/components/responses/reindex@200' + /_reindex/{task_id}/_rethrottle: + post: + operationId: reindex_rethrottle.0 + x-operation-group: reindex_rethrottle + x-version-added: '1.0' + description: Changes the number of requests per second for a particular Reindex operation. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/reindex_rethrottle::path.task_id' + - $ref: '#/components/parameters/reindex_rethrottle::query.requests_per_second' + responses: + '200': + $ref: '#/components/responses/reindex_rethrottle@200' + /_render/template: + get: + operationId: render_search_template.0 + x-operation-group: render_search_template + x-version-added: '1.0' + description: Allows to use the Mustache language to pre-render a search definition. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/search-template/ + parameters: [] + requestBody: + $ref: '#/components/requestBodies/render_search_template' + responses: + '200': + $ref: '#/components/responses/render_search_template@200' + post: + operationId: render_search_template.1 + x-operation-group: render_search_template + x-version-added: '1.0' + description: Allows to use the Mustache language to pre-render a search definition. + parameters: [] + requestBody: + $ref: '#/components/requestBodies/render_search_template' + responses: + '200': + $ref: '#/components/responses/render_search_template@200' + /_render/template/{id}: + get: + operationId: render_search_template.2 + x-operation-group: render_search_template + x-version-added: '1.0' + description: Allows to use the Mustache language to pre-render a search definition. + parameters: + - $ref: '#/components/parameters/render_search_template::path.id' + requestBody: + $ref: '#/components/requestBodies/render_search_template' + responses: + '200': + $ref: '#/components/responses/render_search_template@200' + post: + operationId: render_search_template.3 + x-operation-group: render_search_template + x-version-added: '1.0' + description: Allows to use the Mustache language to pre-render a search definition. + parameters: + - $ref: '#/components/parameters/render_search_template::path.id' + requestBody: + $ref: '#/components/requestBodies/render_search_template' + responses: + '200': + $ref: '#/components/responses/render_search_template@200' + /_script_context: + get: + operationId: get_script_context.0 + x-operation-group: get_script_context + x-version-added: '1.0' + description: Returns all script contexts. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/script-apis/get-script-contexts/ + parameters: [] + responses: + '200': + $ref: '#/components/responses/get_script_context@200' + /_script_language: + get: + operationId: get_script_languages.0 + x-operation-group: get_script_languages + x-version-added: '1.0' + description: Returns available script types, languages and contexts. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/script-apis/get-script-language/ + parameters: [] + responses: + '200': + $ref: '#/components/responses/get_script_languages@200' + /_scripts/painless/_execute: + get: + operationId: scripts_painless_execute.0 + x-operation-group: scripts_painless_execute + x-version-added: '1.0' + description: Allows an arbitrary script to be executed and a result to be returned. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/script-apis/exec-script/ + parameters: [] + requestBody: + $ref: '#/components/requestBodies/scripts_painless_execute' + responses: + '200': + $ref: '#/components/responses/scripts_painless_execute@200' + post: + operationId: scripts_painless_execute.1 + x-operation-group: scripts_painless_execute + x-version-added: '1.0' + description: Allows an arbitrary script to be executed and a result to be returned. + parameters: [] + requestBody: + $ref: '#/components/requestBodies/scripts_painless_execute' + responses: + '200': + $ref: '#/components/responses/scripts_painless_execute@200' + /_scripts/{id}: + delete: + operationId: delete_script.0 + x-operation-group: delete_script + x-version-added: '1.0' + description: Deletes a script. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/script-apis/delete-script/ + parameters: + - $ref: '#/components/parameters/delete_script::path.id' + - $ref: '#/components/parameters/delete_script::query.timeout' + - $ref: '#/components/parameters/delete_script::query.master_timeout' + - $ref: '#/components/parameters/delete_script::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/delete_script@200' + get: + operationId: get_script.0 + x-operation-group: get_script + x-version-added: '1.0' + description: Returns a script. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/script-apis/get-stored-script/ + parameters: + - $ref: '#/components/parameters/get_script::path.id' + - $ref: '#/components/parameters/get_script::query.master_timeout' + - $ref: '#/components/parameters/get_script::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/get_script@200' + post: + operationId: put_script.0 + x-operation-group: put_script + x-version-added: '1.0' + description: Creates or updates a script. + parameters: + - $ref: '#/components/parameters/put_script::path.id' + - $ref: '#/components/parameters/put_script::query.timeout' + - $ref: '#/components/parameters/put_script::query.master_timeout' + - $ref: '#/components/parameters/put_script::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/put_script' + responses: + '200': + $ref: '#/components/responses/put_script@200' + put: + operationId: put_script.1 + x-operation-group: put_script + x-version-added: '1.0' + description: Creates or updates a script. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/script-apis/create-stored-script/ + parameters: + - $ref: '#/components/parameters/put_script::path.id' + - $ref: '#/components/parameters/put_script::query.timeout' + - $ref: '#/components/parameters/put_script::query.master_timeout' + - $ref: '#/components/parameters/put_script::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/put_script' + responses: + '200': + $ref: '#/components/responses/put_script@200' + /_scripts/{id}/{context}: + post: + operationId: put_script.2 + x-operation-group: put_script + x-version-added: '1.0' + description: Creates or updates a script. + parameters: + - $ref: '#/components/parameters/put_script::path.id' + - $ref: '#/components/parameters/put_script::path.context' + - $ref: '#/components/parameters/put_script::query.timeout' + - $ref: '#/components/parameters/put_script::query.master_timeout' + - $ref: '#/components/parameters/put_script::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/put_script' + responses: + '200': + $ref: '#/components/responses/put_script@200' + put: + operationId: put_script.3 + x-operation-group: put_script + x-version-added: '1.0' + description: Creates or updates a script. + parameters: + - $ref: '#/components/parameters/put_script::path.id' + - $ref: '#/components/parameters/put_script::path.context' + - $ref: '#/components/parameters/put_script::query.timeout' + - $ref: '#/components/parameters/put_script::query.master_timeout' + - $ref: '#/components/parameters/put_script::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/put_script' + responses: + '200': + $ref: '#/components/responses/put_script@200' + /_search: + get: + operationId: search.0 + x-operation-group: search + x-version-added: '1.0' + description: Returns results matching a query. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/search/ + parameters: + - $ref: '#/components/parameters/search::query.analyzer' + - $ref: '#/components/parameters/search::query.analyze_wildcard' + - $ref: '#/components/parameters/search::query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/search::query.default_operator' + - $ref: '#/components/parameters/search::query.df' + - $ref: '#/components/parameters/search::query.explain' + - $ref: '#/components/parameters/search::query.stored_fields' + - $ref: '#/components/parameters/search::query.docvalue_fields' + - $ref: '#/components/parameters/search::query.from' + - $ref: '#/components/parameters/search::query.ignore_unavailable' + - $ref: '#/components/parameters/search::query.ignore_throttled' + - $ref: '#/components/parameters/search::query.allow_no_indices' + - $ref: '#/components/parameters/search::query.expand_wildcards' + - $ref: '#/components/parameters/search::query.lenient' + - $ref: '#/components/parameters/search::query.preference' + - $ref: '#/components/parameters/search::query.q' + - $ref: '#/components/parameters/search::query.routing' + - $ref: '#/components/parameters/search::query.scroll' + - $ref: '#/components/parameters/search::query.search_type' + - $ref: '#/components/parameters/search::query.size' + - $ref: '#/components/parameters/search::query.sort' + - $ref: '#/components/parameters/search::query._source' + - $ref: '#/components/parameters/search::query._source_excludes' + - $ref: '#/components/parameters/search::query._source_includes' + - $ref: '#/components/parameters/search::query.terminate_after' + - $ref: '#/components/parameters/search::query.stats' + - $ref: '#/components/parameters/search::query.suggest_field' + - $ref: '#/components/parameters/search::query.suggest_mode' + - $ref: '#/components/parameters/search::query.suggest_size' + - $ref: '#/components/parameters/search::query.suggest_text' + - $ref: '#/components/parameters/search::query.timeout' + - $ref: '#/components/parameters/search::query.track_scores' + - $ref: '#/components/parameters/search::query.track_total_hits' + - $ref: '#/components/parameters/search::query.allow_partial_search_results' + - $ref: '#/components/parameters/search::query.typed_keys' + - $ref: '#/components/parameters/search::query.version' + - $ref: '#/components/parameters/search::query.seq_no_primary_term' + - $ref: '#/components/parameters/search::query.request_cache' + - $ref: '#/components/parameters/search::query.batched_reduce_size' + - $ref: '#/components/parameters/search::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/search::query.pre_filter_shard_size' + - $ref: '#/components/parameters/search::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search::query.search_pipeline' + - $ref: '#/components/parameters/search::query.include_named_queries_score' + requestBody: + $ref: '#/components/requestBodies/search' + responses: + '200': + $ref: '#/components/responses/search@200' + post: + operationId: search.1 + x-operation-group: search + x-version-added: '1.0' + description: Returns results matching a query. + parameters: + - $ref: '#/components/parameters/search::query.analyzer' + - $ref: '#/components/parameters/search::query.analyze_wildcard' + - $ref: '#/components/parameters/search::query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/search::query.default_operator' + - $ref: '#/components/parameters/search::query.df' + - $ref: '#/components/parameters/search::query.explain' + - $ref: '#/components/parameters/search::query.stored_fields' + - $ref: '#/components/parameters/search::query.docvalue_fields' + - $ref: '#/components/parameters/search::query.from' + - $ref: '#/components/parameters/search::query.ignore_unavailable' + - $ref: '#/components/parameters/search::query.ignore_throttled' + - $ref: '#/components/parameters/search::query.allow_no_indices' + - $ref: '#/components/parameters/search::query.expand_wildcards' + - $ref: '#/components/parameters/search::query.lenient' + - $ref: '#/components/parameters/search::query.preference' + - $ref: '#/components/parameters/search::query.q' + - $ref: '#/components/parameters/search::query.routing' + - $ref: '#/components/parameters/search::query.scroll' + - $ref: '#/components/parameters/search::query.search_type' + - $ref: '#/components/parameters/search::query.size' + - $ref: '#/components/parameters/search::query.sort' + - $ref: '#/components/parameters/search::query._source' + - $ref: '#/components/parameters/search::query._source_excludes' + - $ref: '#/components/parameters/search::query._source_includes' + - $ref: '#/components/parameters/search::query.terminate_after' + - $ref: '#/components/parameters/search::query.stats' + - $ref: '#/components/parameters/search::query.suggest_field' + - $ref: '#/components/parameters/search::query.suggest_mode' + - $ref: '#/components/parameters/search::query.suggest_size' + - $ref: '#/components/parameters/search::query.suggest_text' + - $ref: '#/components/parameters/search::query.timeout' + - $ref: '#/components/parameters/search::query.track_scores' + - $ref: '#/components/parameters/search::query.track_total_hits' + - $ref: '#/components/parameters/search::query.allow_partial_search_results' + - $ref: '#/components/parameters/search::query.typed_keys' + - $ref: '#/components/parameters/search::query.version' + - $ref: '#/components/parameters/search::query.seq_no_primary_term' + - $ref: '#/components/parameters/search::query.request_cache' + - $ref: '#/components/parameters/search::query.batched_reduce_size' + - $ref: '#/components/parameters/search::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/search::query.pre_filter_shard_size' + - $ref: '#/components/parameters/search::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search::query.search_pipeline' + - $ref: '#/components/parameters/search::query.include_named_queries_score' + requestBody: + $ref: '#/components/requestBodies/search' + responses: + '200': + $ref: '#/components/responses/search@200' + /_search/point_in_time: + delete: + operationId: delete_pit.0 + x-operation-group: delete_pit + x-version-added: '2.4' + description: Deletes one or more point in time searches based on the IDs passed. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits + requestBody: + $ref: '#/components/requestBodies/delete_pit' + responses: + '200': + $ref: '#/components/responses/delete_pit@200' + /_search/point_in_time/_all: + delete: + operationId: delete_all_pits.0 + x-operation-group: delete_all_pits + x-version-added: '2.4' + description: Deletes all active point in time searches. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#delete-pits + responses: + '200': + $ref: '#/components/responses/delete_all_pits@200' + get: + operationId: get_all_pits.0 + x-operation-group: get_all_pits + x-version-added: '2.4' + description: Lists all active point in time searches. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#list-all-pits + responses: + '200': + $ref: '#/components/responses/get_all_pits@200' + /_search/scroll: + delete: + operationId: clear_scroll.0 + x-operation-group: clear_scroll + x-version-added: '1.0' + description: Explicitly clears the search context for a scroll. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/scroll/ + parameters: [] + requestBody: + $ref: '#/components/requestBodies/clear_scroll' + responses: + '200': + $ref: '#/components/responses/clear_scroll@200' + get: + operationId: scroll.0 + x-operation-group: scroll + x-version-added: '1.0' + description: Allows to retrieve a large numbers of results from a single search request. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/scroll/#path-and-http-methods + parameters: + - $ref: '#/components/parameters/scroll::query.scroll' + - $ref: '#/components/parameters/scroll::query.scroll_id' + - $ref: '#/components/parameters/scroll::query.rest_total_hits_as_int' + requestBody: + $ref: '#/components/requestBodies/scroll' + responses: + '200': + $ref: '#/components/responses/scroll@200' + post: + operationId: scroll.1 + x-operation-group: scroll + x-version-added: '1.0' + description: Allows to retrieve a large numbers of results from a single search request. + parameters: + - $ref: '#/components/parameters/scroll::query.scroll' + - $ref: '#/components/parameters/scroll::query.scroll_id' + - $ref: '#/components/parameters/scroll::query.rest_total_hits_as_int' + requestBody: + $ref: '#/components/requestBodies/scroll' + responses: + '200': + $ref: '#/components/responses/scroll@200' + /_search/scroll/{scroll_id}: + delete: + operationId: clear_scroll.1 + x-operation-group: clear_scroll + deprecated: true + x-deprecation-message: A scroll id can be quite large and should be specified as part of the body + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Explicitly clears the search context for a scroll. + parameters: + - $ref: '#/components/parameters/clear_scroll::path.scroll_id' + requestBody: + $ref: '#/components/requestBodies/clear_scroll' + responses: + '200': + $ref: '#/components/responses/clear_scroll@200' + get: + operationId: scroll.2 + x-operation-group: scroll + deprecated: true + x-deprecation-message: A scroll id can be quite large and should be specified as part of the body + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Allows to retrieve a large numbers of results from a single search request. + parameters: + - $ref: '#/components/parameters/scroll::path.scroll_id' + - $ref: '#/components/parameters/scroll::query.scroll' + - $ref: '#/components/parameters/scroll::query.scroll_id' + - $ref: '#/components/parameters/scroll::query.rest_total_hits_as_int' + requestBody: + $ref: '#/components/requestBodies/scroll' + responses: + '200': + $ref: '#/components/responses/scroll@200' + post: + operationId: scroll.3 + x-operation-group: scroll + deprecated: true + x-deprecation-message: A scroll id can be quite large and should be specified as part of the body + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Allows to retrieve a large numbers of results from a single search request. + parameters: + - $ref: '#/components/parameters/scroll::path.scroll_id' + - $ref: '#/components/parameters/scroll::query.scroll' + - $ref: '#/components/parameters/scroll::query.scroll_id' + - $ref: '#/components/parameters/scroll::query.rest_total_hits_as_int' + requestBody: + $ref: '#/components/requestBodies/scroll' + responses: + '200': + $ref: '#/components/responses/scroll@200' + /_search/template: + get: + operationId: search_template.0 + x-operation-group: search_template + x-version-added: '1.0' + description: Allows to use the Mustache language to pre-render a search definition. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/search-template/ + parameters: + - $ref: '#/components/parameters/search_template::query.ignore_unavailable' + - $ref: '#/components/parameters/search_template::query.ignore_throttled' + - $ref: '#/components/parameters/search_template::query.allow_no_indices' + - $ref: '#/components/parameters/search_template::query.expand_wildcards' + - $ref: '#/components/parameters/search_template::query.preference' + - $ref: '#/components/parameters/search_template::query.routing' + - $ref: '#/components/parameters/search_template::query.scroll' + - $ref: '#/components/parameters/search_template::query.search_type' + - $ref: '#/components/parameters/search_template::query.explain' + - $ref: '#/components/parameters/search_template::query.profile' + - $ref: '#/components/parameters/search_template::query.typed_keys' + - $ref: '#/components/parameters/search_template::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search_template::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/search_template' + responses: + '200': + $ref: '#/components/responses/search_template@200' + post: + operationId: search_template.1 + x-operation-group: search_template + x-version-added: '1.0' + description: Allows to use the Mustache language to pre-render a search definition. + parameters: + - $ref: '#/components/parameters/search_template::query.ignore_unavailable' + - $ref: '#/components/parameters/search_template::query.ignore_throttled' + - $ref: '#/components/parameters/search_template::query.allow_no_indices' + - $ref: '#/components/parameters/search_template::query.expand_wildcards' + - $ref: '#/components/parameters/search_template::query.preference' + - $ref: '#/components/parameters/search_template::query.routing' + - $ref: '#/components/parameters/search_template::query.scroll' + - $ref: '#/components/parameters/search_template::query.search_type' + - $ref: '#/components/parameters/search_template::query.explain' + - $ref: '#/components/parameters/search_template::query.profile' + - $ref: '#/components/parameters/search_template::query.typed_keys' + - $ref: '#/components/parameters/search_template::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search_template::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/search_template' + responses: + '200': + $ref: '#/components/responses/search_template@200' + /_search_shards: + get: + operationId: search_shards.0 + x-operation-group: search_shards + x-version-added: '1.0' + description: Returns information about the indices and shards that a search request would be executed against. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/search_shards::query.preference' + - $ref: '#/components/parameters/search_shards::query.routing' + - $ref: '#/components/parameters/search_shards::query.local' + - $ref: '#/components/parameters/search_shards::query.ignore_unavailable' + - $ref: '#/components/parameters/search_shards::query.allow_no_indices' + - $ref: '#/components/parameters/search_shards::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/search_shards@200' + post: + operationId: search_shards.1 + x-operation-group: search_shards + x-version-added: '1.0' + description: Returns information about the indices and shards that a search request would be executed against. + parameters: + - $ref: '#/components/parameters/search_shards::query.preference' + - $ref: '#/components/parameters/search_shards::query.routing' + - $ref: '#/components/parameters/search_shards::query.local' + - $ref: '#/components/parameters/search_shards::query.ignore_unavailable' + - $ref: '#/components/parameters/search_shards::query.allow_no_indices' + - $ref: '#/components/parameters/search_shards::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/search_shards@200' + /_update_by_query/{task_id}/_rethrottle: + post: + operationId: update_by_query_rethrottle.0 + x-operation-group: update_by_query_rethrottle + x-version-added: '1.0' + description: Changes the number of requests per second for a particular Update By Query operation. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/update_by_query_rethrottle::path.task_id' + - $ref: '#/components/parameters/update_by_query_rethrottle::query.requests_per_second' + responses: + '200': + $ref: '#/components/responses/update_by_query_rethrottle@200' + /{index}/_bulk: + post: + operationId: bulk.2 + x-operation-group: bulk + x-version-added: '1.0' + description: Allows to perform multiple index/update/delete operations in a single request. + parameters: + - $ref: '#/components/parameters/bulk::path.index' + - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' + - $ref: '#/components/parameters/bulk::query.refresh' + - $ref: '#/components/parameters/bulk::query.routing' + - $ref: '#/components/parameters/bulk::query.timeout' + - $ref: '#/components/parameters/bulk::query.type' + - $ref: '#/components/parameters/bulk::query._source' + - $ref: '#/components/parameters/bulk::query._source_excludes' + - $ref: '#/components/parameters/bulk::query._source_includes' + - $ref: '#/components/parameters/bulk::query.pipeline' + - $ref: '#/components/parameters/bulk::query.require_alias' + requestBody: + $ref: '#/components/requestBodies/bulk' + responses: + '200': + $ref: '#/components/responses/bulk@200' + put: + operationId: bulk.3 + x-operation-group: bulk + x-version-added: '1.0' + description: Allows to perform multiple index/update/delete operations in a single request. + parameters: + - $ref: '#/components/parameters/bulk::path.index' + - $ref: '#/components/parameters/bulk::query.wait_for_active_shards' + - $ref: '#/components/parameters/bulk::query.refresh' + - $ref: '#/components/parameters/bulk::query.routing' + - $ref: '#/components/parameters/bulk::query.timeout' + - $ref: '#/components/parameters/bulk::query.type' + - $ref: '#/components/parameters/bulk::query._source' + - $ref: '#/components/parameters/bulk::query._source_excludes' + - $ref: '#/components/parameters/bulk::query._source_includes' + - $ref: '#/components/parameters/bulk::query.pipeline' + - $ref: '#/components/parameters/bulk::query.require_alias' + requestBody: + $ref: '#/components/requestBodies/bulk' + responses: + '200': + $ref: '#/components/responses/bulk@200' + /{index}/_count: + get: + operationId: count.2 + x-operation-group: count + x-version-added: '1.0' + description: Returns number of documents matching a query. + parameters: + - $ref: '#/components/parameters/count::path.index' + - $ref: '#/components/parameters/count::query.ignore_unavailable' + - $ref: '#/components/parameters/count::query.ignore_throttled' + - $ref: '#/components/parameters/count::query.allow_no_indices' + - $ref: '#/components/parameters/count::query.expand_wildcards' + - $ref: '#/components/parameters/count::query.min_score' + - $ref: '#/components/parameters/count::query.preference' + - $ref: '#/components/parameters/count::query.routing' + - $ref: '#/components/parameters/count::query.q' + - $ref: '#/components/parameters/count::query.analyzer' + - $ref: '#/components/parameters/count::query.analyze_wildcard' + - $ref: '#/components/parameters/count::query.default_operator' + - $ref: '#/components/parameters/count::query.df' + - $ref: '#/components/parameters/count::query.lenient' + - $ref: '#/components/parameters/count::query.terminate_after' + requestBody: + $ref: '#/components/requestBodies/count' + responses: + '200': + $ref: '#/components/responses/count@200' + post: + operationId: count.3 + x-operation-group: count + x-version-added: '1.0' + description: Returns number of documents matching a query. + parameters: + - $ref: '#/components/parameters/count::path.index' + - $ref: '#/components/parameters/count::query.ignore_unavailable' + - $ref: '#/components/parameters/count::query.ignore_throttled' + - $ref: '#/components/parameters/count::query.allow_no_indices' + - $ref: '#/components/parameters/count::query.expand_wildcards' + - $ref: '#/components/parameters/count::query.min_score' + - $ref: '#/components/parameters/count::query.preference' + - $ref: '#/components/parameters/count::query.routing' + - $ref: '#/components/parameters/count::query.q' + - $ref: '#/components/parameters/count::query.analyzer' + - $ref: '#/components/parameters/count::query.analyze_wildcard' + - $ref: '#/components/parameters/count::query.default_operator' + - $ref: '#/components/parameters/count::query.df' + - $ref: '#/components/parameters/count::query.lenient' + - $ref: '#/components/parameters/count::query.terminate_after' + requestBody: + $ref: '#/components/requestBodies/count' + responses: + '200': + $ref: '#/components/responses/count@200' + /{index}/_create/{id}: + post: + operationId: create.0 + x-operation-group: create + x-version-added: '1.0' + description: |- + Creates a new document in the index. + + Returns a 409 response when a document with a same ID already exists in the index. + parameters: + - $ref: '#/components/parameters/create::path.id' + - $ref: '#/components/parameters/create::path.index' + - $ref: '#/components/parameters/create::query.wait_for_active_shards' + - $ref: '#/components/parameters/create::query.refresh' + - $ref: '#/components/parameters/create::query.routing' + - $ref: '#/components/parameters/create::query.timeout' + - $ref: '#/components/parameters/create::query.version' + - $ref: '#/components/parameters/create::query.version_type' + - $ref: '#/components/parameters/create::query.pipeline' + requestBody: + $ref: '#/components/requestBodies/create' + responses: + '200': + $ref: '#/components/responses/create@200' + put: + operationId: create.1 + x-operation-group: create + x-version-added: '1.0' + description: |- + Creates a new document in the index. + + Returns a 409 response when a document with a same ID already exists in the index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ + parameters: + - $ref: '#/components/parameters/create::path.id' + - $ref: '#/components/parameters/create::path.index' + - $ref: '#/components/parameters/create::query.wait_for_active_shards' + - $ref: '#/components/parameters/create::query.refresh' + - $ref: '#/components/parameters/create::query.routing' + - $ref: '#/components/parameters/create::query.timeout' + - $ref: '#/components/parameters/create::query.version' + - $ref: '#/components/parameters/create::query.version_type' + - $ref: '#/components/parameters/create::query.pipeline' + requestBody: + $ref: '#/components/requestBodies/create' + responses: + '200': + $ref: '#/components/responses/create@200' + /{index}/_delete_by_query: + post: + operationId: delete_by_query.0 + x-operation-group: delete_by_query + x-version-added: '1.0' + description: Deletes documents matching the provided query. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/delete-by-query/ + parameters: + - $ref: '#/components/parameters/delete_by_query::path.index' + - $ref: '#/components/parameters/delete_by_query::query.analyzer' + - $ref: '#/components/parameters/delete_by_query::query.analyze_wildcard' + - $ref: '#/components/parameters/delete_by_query::query.default_operator' + - $ref: '#/components/parameters/delete_by_query::query.df' + - $ref: '#/components/parameters/delete_by_query::query.from' + - $ref: '#/components/parameters/delete_by_query::query.ignore_unavailable' + - $ref: '#/components/parameters/delete_by_query::query.allow_no_indices' + - $ref: '#/components/parameters/delete_by_query::query.conflicts' + - $ref: '#/components/parameters/delete_by_query::query.expand_wildcards' + - $ref: '#/components/parameters/delete_by_query::query.lenient' + - $ref: '#/components/parameters/delete_by_query::query.preference' + - $ref: '#/components/parameters/delete_by_query::query.q' + - $ref: '#/components/parameters/delete_by_query::query.routing' + - $ref: '#/components/parameters/delete_by_query::query.scroll' + - $ref: '#/components/parameters/delete_by_query::query.search_type' + - $ref: '#/components/parameters/delete_by_query::query.search_timeout' + - $ref: '#/components/parameters/delete_by_query::query.size' + - $ref: '#/components/parameters/delete_by_query::query.max_docs' + - $ref: '#/components/parameters/delete_by_query::query.sort' + - $ref: '#/components/parameters/delete_by_query::query._source' + - $ref: '#/components/parameters/delete_by_query::query._source_excludes' + - $ref: '#/components/parameters/delete_by_query::query._source_includes' + - $ref: '#/components/parameters/delete_by_query::query.terminate_after' + - $ref: '#/components/parameters/delete_by_query::query.stats' + - $ref: '#/components/parameters/delete_by_query::query.version' + - $ref: '#/components/parameters/delete_by_query::query.request_cache' + - $ref: '#/components/parameters/delete_by_query::query.refresh' + - $ref: '#/components/parameters/delete_by_query::query.timeout' + - $ref: '#/components/parameters/delete_by_query::query.wait_for_active_shards' + - $ref: '#/components/parameters/delete_by_query::query.scroll_size' + - $ref: '#/components/parameters/delete_by_query::query.wait_for_completion' + - $ref: '#/components/parameters/delete_by_query::query.requests_per_second' + - $ref: '#/components/parameters/delete_by_query::query.slices' + requestBody: + $ref: '#/components/requestBodies/delete_by_query' + responses: + '200': + $ref: '#/components/responses/delete_by_query@200' + /{index}/_doc: + post: + operationId: index.0 + x-operation-group: index + x-version-added: '1.0' + description: Creates or updates a document in an index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/index-document/ + parameters: + - $ref: '#/components/parameters/index::path.index' + - $ref: '#/components/parameters/index::query.wait_for_active_shards' + - $ref: '#/components/parameters/index::query.op_type' + - $ref: '#/components/parameters/index::query.refresh' + - $ref: '#/components/parameters/index::query.routing' + - $ref: '#/components/parameters/index::query.timeout' + - $ref: '#/components/parameters/index::query.version' + - $ref: '#/components/parameters/index::query.version_type' + - $ref: '#/components/parameters/index::query.if_seq_no' + - $ref: '#/components/parameters/index::query.if_primary_term' + - $ref: '#/components/parameters/index::query.pipeline' + - $ref: '#/components/parameters/index::query.require_alias' + requestBody: + $ref: '#/components/requestBodies/index' + responses: + '200': + $ref: '#/components/responses/index@200' + /{index}/_doc/{id}: + delete: + operationId: delete.0 + x-operation-group: delete + x-version-added: '1.0' + description: Removes a document from the index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/delete-document/ + parameters: + - $ref: '#/components/parameters/delete::path.id' + - $ref: '#/components/parameters/delete::path.index' + - $ref: '#/components/parameters/delete::query.wait_for_active_shards' + - $ref: '#/components/parameters/delete::query.refresh' + - $ref: '#/components/parameters/delete::query.routing' + - $ref: '#/components/parameters/delete::query.timeout' + - $ref: '#/components/parameters/delete::query.if_seq_no' + - $ref: '#/components/parameters/delete::query.if_primary_term' + - $ref: '#/components/parameters/delete::query.version' + - $ref: '#/components/parameters/delete::query.version_type' + responses: + '200': + $ref: '#/components/responses/delete@200' + get: + operationId: get.0 + x-operation-group: get + x-version-added: '1.0' + description: Returns a document. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ + parameters: + - $ref: '#/components/parameters/get::path.id' + - $ref: '#/components/parameters/get::path.index' + - $ref: '#/components/parameters/get::query.stored_fields' + - $ref: '#/components/parameters/get::query.preference' + - $ref: '#/components/parameters/get::query.realtime' + - $ref: '#/components/parameters/get::query.refresh' + - $ref: '#/components/parameters/get::query.routing' + - $ref: '#/components/parameters/get::query._source' + - $ref: '#/components/parameters/get::query._source_excludes' + - $ref: '#/components/parameters/get::query._source_includes' + - $ref: '#/components/parameters/get::query.version' + - $ref: '#/components/parameters/get::query.version_type' + responses: + '200': + $ref: '#/components/responses/get@200' + head: + operationId: exists.0 + x-operation-group: exists + x-version-added: '1.0' + description: Returns information about whether a document exists in an index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ + parameters: + - $ref: '#/components/parameters/exists::path.id' + - $ref: '#/components/parameters/exists::path.index' + - $ref: '#/components/parameters/exists::query.stored_fields' + - $ref: '#/components/parameters/exists::query.preference' + - $ref: '#/components/parameters/exists::query.realtime' + - $ref: '#/components/parameters/exists::query.refresh' + - $ref: '#/components/parameters/exists::query.routing' + - $ref: '#/components/parameters/exists::query._source' + - $ref: '#/components/parameters/exists::query._source_excludes' + - $ref: '#/components/parameters/exists::query._source_includes' + - $ref: '#/components/parameters/exists::query.version' + - $ref: '#/components/parameters/exists::query.version_type' + responses: + '200': + $ref: '#/components/responses/exists@200' + post: + operationId: index.1 + x-operation-group: index + x-version-added: '1.0' + description: Creates or updates a document in an index. + parameters: + - $ref: '#/components/parameters/index::path.id' + - $ref: '#/components/parameters/index::path.index' + - $ref: '#/components/parameters/index::query.wait_for_active_shards' + - $ref: '#/components/parameters/index::query.op_type' + - $ref: '#/components/parameters/index::query.refresh' + - $ref: '#/components/parameters/index::query.routing' + - $ref: '#/components/parameters/index::query.timeout' + - $ref: '#/components/parameters/index::query.version' + - $ref: '#/components/parameters/index::query.version_type' + - $ref: '#/components/parameters/index::query.if_seq_no' + - $ref: '#/components/parameters/index::query.if_primary_term' + - $ref: '#/components/parameters/index::query.pipeline' + - $ref: '#/components/parameters/index::query.require_alias' + requestBody: + $ref: '#/components/requestBodies/index' + responses: + '200': + $ref: '#/components/responses/index@200' + put: + operationId: index.2 + x-operation-group: index + x-version-added: '1.0' + description: Creates or updates a document in an index. + parameters: + - $ref: '#/components/parameters/index::path.id' + - $ref: '#/components/parameters/index::path.index' + - $ref: '#/components/parameters/index::query.wait_for_active_shards' + - $ref: '#/components/parameters/index::query.op_type' + - $ref: '#/components/parameters/index::query.refresh' + - $ref: '#/components/parameters/index::query.routing' + - $ref: '#/components/parameters/index::query.timeout' + - $ref: '#/components/parameters/index::query.version' + - $ref: '#/components/parameters/index::query.version_type' + - $ref: '#/components/parameters/index::query.if_seq_no' + - $ref: '#/components/parameters/index::query.if_primary_term' + - $ref: '#/components/parameters/index::query.pipeline' + - $ref: '#/components/parameters/index::query.require_alias' + requestBody: + $ref: '#/components/requestBodies/index' + responses: + '200': + $ref: '#/components/responses/index@200' + /{index}/_explain/{id}: + get: + operationId: explain.0 + x-operation-group: explain + x-version-added: '1.0' + description: Returns information about why a specific matches (or doesn't match) a query. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/explain/ + parameters: + - $ref: '#/components/parameters/explain::path.id' + - $ref: '#/components/parameters/explain::path.index' + - $ref: '#/components/parameters/explain::query.analyze_wildcard' + - $ref: '#/components/parameters/explain::query.analyzer' + - $ref: '#/components/parameters/explain::query.default_operator' + - $ref: '#/components/parameters/explain::query.df' + - $ref: '#/components/parameters/explain::query.stored_fields' + - $ref: '#/components/parameters/explain::query.lenient' + - $ref: '#/components/parameters/explain::query.preference' + - $ref: '#/components/parameters/explain::query.q' + - $ref: '#/components/parameters/explain::query.routing' + - $ref: '#/components/parameters/explain::query._source' + - $ref: '#/components/parameters/explain::query._source_excludes' + - $ref: '#/components/parameters/explain::query._source_includes' + requestBody: + $ref: '#/components/requestBodies/explain' + responses: + '200': + $ref: '#/components/responses/explain@200' + post: + operationId: explain.1 + x-operation-group: explain + x-version-added: '1.0' + description: Returns information about why a specific matches (or doesn't match) a query. + parameters: + - $ref: '#/components/parameters/explain::path.id' + - $ref: '#/components/parameters/explain::path.index' + - $ref: '#/components/parameters/explain::query.analyze_wildcard' + - $ref: '#/components/parameters/explain::query.analyzer' + - $ref: '#/components/parameters/explain::query.default_operator' + - $ref: '#/components/parameters/explain::query.df' + - $ref: '#/components/parameters/explain::query.stored_fields' + - $ref: '#/components/parameters/explain::query.lenient' + - $ref: '#/components/parameters/explain::query.preference' + - $ref: '#/components/parameters/explain::query.q' + - $ref: '#/components/parameters/explain::query.routing' + - $ref: '#/components/parameters/explain::query._source' + - $ref: '#/components/parameters/explain::query._source_excludes' + - $ref: '#/components/parameters/explain::query._source_includes' + requestBody: + $ref: '#/components/requestBodies/explain' + responses: + '200': + $ref: '#/components/responses/explain@200' + /{index}/_field_caps: + get: + operationId: field_caps.2 + x-operation-group: field_caps + x-version-added: '1.0' + description: Returns the information about the capabilities of fields among multiple indices. + parameters: + - $ref: '#/components/parameters/field_caps::path.index' + - $ref: '#/components/parameters/field_caps::query.fields' + - $ref: '#/components/parameters/field_caps::query.ignore_unavailable' + - $ref: '#/components/parameters/field_caps::query.allow_no_indices' + - $ref: '#/components/parameters/field_caps::query.expand_wildcards' + - $ref: '#/components/parameters/field_caps::query.include_unmapped' + requestBody: + $ref: '#/components/requestBodies/field_caps' + responses: + '200': + $ref: '#/components/responses/field_caps@200' + post: + operationId: field_caps.3 + x-operation-group: field_caps + x-version-added: '1.0' + description: Returns the information about the capabilities of fields among multiple indices. + parameters: + - $ref: '#/components/parameters/field_caps::path.index' + - $ref: '#/components/parameters/field_caps::query.fields' + - $ref: '#/components/parameters/field_caps::query.ignore_unavailable' + - $ref: '#/components/parameters/field_caps::query.allow_no_indices' + - $ref: '#/components/parameters/field_caps::query.expand_wildcards' + - $ref: '#/components/parameters/field_caps::query.include_unmapped' + requestBody: + $ref: '#/components/requestBodies/field_caps' + responses: + '200': + $ref: '#/components/responses/field_caps@200' + /{index}/_mget: + get: + operationId: mget.2 + x-operation-group: mget + x-version-added: '1.0' + description: Allows to get multiple documents in one request. + parameters: + - $ref: '#/components/parameters/mget::path.index' + - $ref: '#/components/parameters/mget::query.stored_fields' + - $ref: '#/components/parameters/mget::query.preference' + - $ref: '#/components/parameters/mget::query.realtime' + - $ref: '#/components/parameters/mget::query.refresh' + - $ref: '#/components/parameters/mget::query.routing' + - $ref: '#/components/parameters/mget::query._source' + - $ref: '#/components/parameters/mget::query._source_excludes' + - $ref: '#/components/parameters/mget::query._source_includes' + requestBody: + $ref: '#/components/requestBodies/mget' + responses: + '200': + $ref: '#/components/responses/mget@200' + post: + operationId: mget.3 + x-operation-group: mget + x-version-added: '1.0' + description: Allows to get multiple documents in one request. + parameters: + - $ref: '#/components/parameters/mget::path.index' + - $ref: '#/components/parameters/mget::query.stored_fields' + - $ref: '#/components/parameters/mget::query.preference' + - $ref: '#/components/parameters/mget::query.realtime' + - $ref: '#/components/parameters/mget::query.refresh' + - $ref: '#/components/parameters/mget::query.routing' + - $ref: '#/components/parameters/mget::query._source' + - $ref: '#/components/parameters/mget::query._source_excludes' + - $ref: '#/components/parameters/mget::query._source_includes' + requestBody: + $ref: '#/components/requestBodies/mget' + responses: + '200': + $ref: '#/components/responses/mget@200' + /{index}/_msearch: + get: + operationId: msearch.2 + x-operation-group: msearch + x-version-added: '1.0' + description: Allows to execute several search operations in one request. + parameters: + - $ref: '#/components/parameters/msearch::path.index' + - $ref: '#/components/parameters/msearch::query.search_type' + - $ref: '#/components/parameters/msearch::query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch::query.typed_keys' + - $ref: '#/components/parameters/msearch::query.pre_filter_shard_size' + - $ref: '#/components/parameters/msearch::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/msearch::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/msearch' + responses: + '200': + $ref: '#/components/responses/msearch@200' + post: + operationId: msearch.3 + x-operation-group: msearch + x-version-added: '1.0' + description: Allows to execute several search operations in one request. + parameters: + - $ref: '#/components/parameters/msearch::path.index' + - $ref: '#/components/parameters/msearch::query.search_type' + - $ref: '#/components/parameters/msearch::query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch::query.typed_keys' + - $ref: '#/components/parameters/msearch::query.pre_filter_shard_size' + - $ref: '#/components/parameters/msearch::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/msearch::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/msearch' + responses: + '200': + $ref: '#/components/responses/msearch@200' + /{index}/_msearch/template: + get: + operationId: msearch_template.2 + x-operation-group: msearch_template + x-version-added: '1.0' + description: Allows to execute several search template operations in one request. + parameters: + - $ref: '#/components/parameters/msearch_template::path.index' + - $ref: '#/components/parameters/msearch_template::query.search_type' + - $ref: '#/components/parameters/msearch_template::query.typed_keys' + - $ref: '#/components/parameters/msearch_template::query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch_template::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch_template::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/msearch_template' + responses: + '200': + $ref: '#/components/responses/msearch_template@200' + post: + operationId: msearch_template.3 + x-operation-group: msearch_template + x-version-added: '1.0' + description: Allows to execute several search template operations in one request. + parameters: + - $ref: '#/components/parameters/msearch_template::path.index' + - $ref: '#/components/parameters/msearch_template::query.search_type' + - $ref: '#/components/parameters/msearch_template::query.typed_keys' + - $ref: '#/components/parameters/msearch_template::query.max_concurrent_searches' + - $ref: '#/components/parameters/msearch_template::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/msearch_template::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/msearch_template' + responses: + '200': + $ref: '#/components/responses/msearch_template@200' + /{index}/_mtermvectors: + get: + operationId: mtermvectors.2 + x-operation-group: mtermvectors + x-version-added: '1.0' + description: Returns multiple termvectors in one request. + parameters: + - $ref: '#/components/parameters/mtermvectors::path.index' + - $ref: '#/components/parameters/mtermvectors::query.ids' + - $ref: '#/components/parameters/mtermvectors::query.term_statistics' + - $ref: '#/components/parameters/mtermvectors::query.field_statistics' + - $ref: '#/components/parameters/mtermvectors::query.fields' + - $ref: '#/components/parameters/mtermvectors::query.offsets' + - $ref: '#/components/parameters/mtermvectors::query.positions' + - $ref: '#/components/parameters/mtermvectors::query.payloads' + - $ref: '#/components/parameters/mtermvectors::query.preference' + - $ref: '#/components/parameters/mtermvectors::query.routing' + - $ref: '#/components/parameters/mtermvectors::query.realtime' + - $ref: '#/components/parameters/mtermvectors::query.version' + - $ref: '#/components/parameters/mtermvectors::query.version_type' + requestBody: + $ref: '#/components/requestBodies/mtermvectors' + responses: + '200': + $ref: '#/components/responses/mtermvectors@200' + post: + operationId: mtermvectors.3 + x-operation-group: mtermvectors + x-version-added: '1.0' + description: Returns multiple termvectors in one request. + parameters: + - $ref: '#/components/parameters/mtermvectors::path.index' + - $ref: '#/components/parameters/mtermvectors::query.ids' + - $ref: '#/components/parameters/mtermvectors::query.term_statistics' + - $ref: '#/components/parameters/mtermvectors::query.field_statistics' + - $ref: '#/components/parameters/mtermvectors::query.fields' + - $ref: '#/components/parameters/mtermvectors::query.offsets' + - $ref: '#/components/parameters/mtermvectors::query.positions' + - $ref: '#/components/parameters/mtermvectors::query.payloads' + - $ref: '#/components/parameters/mtermvectors::query.preference' + - $ref: '#/components/parameters/mtermvectors::query.routing' + - $ref: '#/components/parameters/mtermvectors::query.realtime' + - $ref: '#/components/parameters/mtermvectors::query.version' + - $ref: '#/components/parameters/mtermvectors::query.version_type' + requestBody: + $ref: '#/components/requestBodies/mtermvectors' + responses: + '200': + $ref: '#/components/responses/mtermvectors@200' + /{index}/_rank_eval: + get: + operationId: rank_eval.2 + x-operation-group: rank_eval + x-version-added: '1.0' + description: Allows to evaluate the quality of ranked search results over a set of typical search queries. + parameters: + - $ref: '#/components/parameters/rank_eval::path.index' + - $ref: '#/components/parameters/rank_eval::query.ignore_unavailable' + - $ref: '#/components/parameters/rank_eval::query.allow_no_indices' + - $ref: '#/components/parameters/rank_eval::query.expand_wildcards' + - $ref: '#/components/parameters/rank_eval::query.search_type' + requestBody: + $ref: '#/components/requestBodies/rank_eval' + responses: + '200': + $ref: '#/components/responses/rank_eval@200' + post: + operationId: rank_eval.3 + x-operation-group: rank_eval + x-version-added: '1.0' + description: Allows to evaluate the quality of ranked search results over a set of typical search queries. + parameters: + - $ref: '#/components/parameters/rank_eval::path.index' + - $ref: '#/components/parameters/rank_eval::query.ignore_unavailable' + - $ref: '#/components/parameters/rank_eval::query.allow_no_indices' + - $ref: '#/components/parameters/rank_eval::query.expand_wildcards' + - $ref: '#/components/parameters/rank_eval::query.search_type' + requestBody: + $ref: '#/components/requestBodies/rank_eval' + responses: + '200': + $ref: '#/components/responses/rank_eval@200' + /{index}/_search: + get: + operationId: search.2 + x-operation-group: search + x-version-added: '1.0' + description: Returns results matching a query. + parameters: + - $ref: '#/components/parameters/search::path.index' + - $ref: '#/components/parameters/search::query.analyzer' + - $ref: '#/components/parameters/search::query.analyze_wildcard' + - $ref: '#/components/parameters/search::query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/search::query.default_operator' + - $ref: '#/components/parameters/search::query.df' + - $ref: '#/components/parameters/search::query.explain' + - $ref: '#/components/parameters/search::query.stored_fields' + - $ref: '#/components/parameters/search::query.docvalue_fields' + - $ref: '#/components/parameters/search::query.from' + - $ref: '#/components/parameters/search::query.ignore_unavailable' + - $ref: '#/components/parameters/search::query.ignore_throttled' + - $ref: '#/components/parameters/search::query.allow_no_indices' + - $ref: '#/components/parameters/search::query.expand_wildcards' + - $ref: '#/components/parameters/search::query.lenient' + - $ref: '#/components/parameters/search::query.preference' + - $ref: '#/components/parameters/search::query.q' + - $ref: '#/components/parameters/search::query.routing' + - $ref: '#/components/parameters/search::query.scroll' + - $ref: '#/components/parameters/search::query.search_type' + - $ref: '#/components/parameters/search::query.size' + - $ref: '#/components/parameters/search::query.sort' + - $ref: '#/components/parameters/search::query._source' + - $ref: '#/components/parameters/search::query._source_excludes' + - $ref: '#/components/parameters/search::query._source_includes' + - $ref: '#/components/parameters/search::query.terminate_after' + - $ref: '#/components/parameters/search::query.stats' + - $ref: '#/components/parameters/search::query.suggest_field' + - $ref: '#/components/parameters/search::query.suggest_mode' + - $ref: '#/components/parameters/search::query.suggest_size' + - $ref: '#/components/parameters/search::query.suggest_text' + - $ref: '#/components/parameters/search::query.timeout' + - $ref: '#/components/parameters/search::query.track_scores' + - $ref: '#/components/parameters/search::query.track_total_hits' + - $ref: '#/components/parameters/search::query.allow_partial_search_results' + - $ref: '#/components/parameters/search::query.typed_keys' + - $ref: '#/components/parameters/search::query.version' + - $ref: '#/components/parameters/search::query.seq_no_primary_term' + - $ref: '#/components/parameters/search::query.request_cache' + - $ref: '#/components/parameters/search::query.batched_reduce_size' + - $ref: '#/components/parameters/search::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/search::query.pre_filter_shard_size' + - $ref: '#/components/parameters/search::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search::query.search_pipeline' + - $ref: '#/components/parameters/search::query.include_named_queries_score' + requestBody: + $ref: '#/components/requestBodies/search' + responses: + '200': + $ref: '#/components/responses/search@200' + post: + operationId: search.3 + x-operation-group: search + x-version-added: '1.0' + description: Returns results matching a query. + parameters: + - $ref: '#/components/parameters/search::path.index' + - $ref: '#/components/parameters/search::query.analyzer' + - $ref: '#/components/parameters/search::query.analyze_wildcard' + - $ref: '#/components/parameters/search::query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/search::query.default_operator' + - $ref: '#/components/parameters/search::query.df' + - $ref: '#/components/parameters/search::query.explain' + - $ref: '#/components/parameters/search::query.stored_fields' + - $ref: '#/components/parameters/search::query.docvalue_fields' + - $ref: '#/components/parameters/search::query.from' + - $ref: '#/components/parameters/search::query.ignore_unavailable' + - $ref: '#/components/parameters/search::query.ignore_throttled' + - $ref: '#/components/parameters/search::query.allow_no_indices' + - $ref: '#/components/parameters/search::query.expand_wildcards' + - $ref: '#/components/parameters/search::query.lenient' + - $ref: '#/components/parameters/search::query.preference' + - $ref: '#/components/parameters/search::query.q' + - $ref: '#/components/parameters/search::query.routing' + - $ref: '#/components/parameters/search::query.scroll' + - $ref: '#/components/parameters/search::query.search_type' + - $ref: '#/components/parameters/search::query.size' + - $ref: '#/components/parameters/search::query.sort' + - $ref: '#/components/parameters/search::query._source' + - $ref: '#/components/parameters/search::query._source_excludes' + - $ref: '#/components/parameters/search::query._source_includes' + - $ref: '#/components/parameters/search::query.terminate_after' + - $ref: '#/components/parameters/search::query.stats' + - $ref: '#/components/parameters/search::query.suggest_field' + - $ref: '#/components/parameters/search::query.suggest_mode' + - $ref: '#/components/parameters/search::query.suggest_size' + - $ref: '#/components/parameters/search::query.suggest_text' + - $ref: '#/components/parameters/search::query.timeout' + - $ref: '#/components/parameters/search::query.track_scores' + - $ref: '#/components/parameters/search::query.track_total_hits' + - $ref: '#/components/parameters/search::query.allow_partial_search_results' + - $ref: '#/components/parameters/search::query.typed_keys' + - $ref: '#/components/parameters/search::query.version' + - $ref: '#/components/parameters/search::query.seq_no_primary_term' + - $ref: '#/components/parameters/search::query.request_cache' + - $ref: '#/components/parameters/search::query.batched_reduce_size' + - $ref: '#/components/parameters/search::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/search::query.pre_filter_shard_size' + - $ref: '#/components/parameters/search::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search::query.search_pipeline' + - $ref: '#/components/parameters/search::query.include_named_queries_score' + requestBody: + $ref: '#/components/requestBodies/search' + responses: + '200': + $ref: '#/components/responses/search@200' + /{index}/_search/point_in_time: + post: + operationId: create_pit.0 + x-operation-group: create_pit + x-version-added: '2.4' + description: Creates point in time context. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#create-a-pit + parameters: + - $ref: '#/components/parameters/create_pit::path.index' + - $ref: '#/components/parameters/create_pit::query.allow_partial_pit_creation' + - $ref: '#/components/parameters/create_pit::query.keep_alive' + - $ref: '#/components/parameters/create_pit::query.preference' + - $ref: '#/components/parameters/create_pit::query.routing' + - $ref: '#/components/parameters/create_pit::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/create_pit@200' + /{index}/_search/template: + get: + operationId: search_template.2 + x-operation-group: search_template + x-version-added: '1.0' + description: Allows to use the Mustache language to pre-render a search definition. + parameters: + - $ref: '#/components/parameters/search_template::path.index' + - $ref: '#/components/parameters/search_template::query.ignore_unavailable' + - $ref: '#/components/parameters/search_template::query.ignore_throttled' + - $ref: '#/components/parameters/search_template::query.allow_no_indices' + - $ref: '#/components/parameters/search_template::query.expand_wildcards' + - $ref: '#/components/parameters/search_template::query.preference' + - $ref: '#/components/parameters/search_template::query.routing' + - $ref: '#/components/parameters/search_template::query.scroll' + - $ref: '#/components/parameters/search_template::query.search_type' + - $ref: '#/components/parameters/search_template::query.explain' + - $ref: '#/components/parameters/search_template::query.profile' + - $ref: '#/components/parameters/search_template::query.typed_keys' + - $ref: '#/components/parameters/search_template::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search_template::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/search_template' + responses: + '200': + $ref: '#/components/responses/search_template@200' + post: + operationId: search_template.3 + x-operation-group: search_template + x-version-added: '1.0' + description: Allows to use the Mustache language to pre-render a search definition. + parameters: + - $ref: '#/components/parameters/search_template::path.index' + - $ref: '#/components/parameters/search_template::query.ignore_unavailable' + - $ref: '#/components/parameters/search_template::query.ignore_throttled' + - $ref: '#/components/parameters/search_template::query.allow_no_indices' + - $ref: '#/components/parameters/search_template::query.expand_wildcards' + - $ref: '#/components/parameters/search_template::query.preference' + - $ref: '#/components/parameters/search_template::query.routing' + - $ref: '#/components/parameters/search_template::query.scroll' + - $ref: '#/components/parameters/search_template::query.search_type' + - $ref: '#/components/parameters/search_template::query.explain' + - $ref: '#/components/parameters/search_template::query.profile' + - $ref: '#/components/parameters/search_template::query.typed_keys' + - $ref: '#/components/parameters/search_template::query.rest_total_hits_as_int' + - $ref: '#/components/parameters/search_template::query.ccs_minimize_roundtrips' + requestBody: + $ref: '#/components/requestBodies/search_template' + responses: + '200': + $ref: '#/components/responses/search_template@200' + /{index}/_search_shards: + get: + operationId: search_shards.2 + x-operation-group: search_shards + x-version-added: '1.0' + description: Returns information about the indices and shards that a search request would be executed against. + parameters: + - $ref: '#/components/parameters/search_shards::path.index' + - $ref: '#/components/parameters/search_shards::query.preference' + - $ref: '#/components/parameters/search_shards::query.routing' + - $ref: '#/components/parameters/search_shards::query.local' + - $ref: '#/components/parameters/search_shards::query.ignore_unavailable' + - $ref: '#/components/parameters/search_shards::query.allow_no_indices' + - $ref: '#/components/parameters/search_shards::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/search_shards@200' + post: + operationId: search_shards.3 + x-operation-group: search_shards + x-version-added: '1.0' + description: Returns information about the indices and shards that a search request would be executed against. + parameters: + - $ref: '#/components/parameters/search_shards::path.index' + - $ref: '#/components/parameters/search_shards::query.preference' + - $ref: '#/components/parameters/search_shards::query.routing' + - $ref: '#/components/parameters/search_shards::query.local' + - $ref: '#/components/parameters/search_shards::query.ignore_unavailable' + - $ref: '#/components/parameters/search_shards::query.allow_no_indices' + - $ref: '#/components/parameters/search_shards::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/search_shards@200' + /{index}/_source/{id}: + get: + operationId: get_source.0 + x-operation-group: get_source + x-version-added: '1.0' + description: Returns the source of a document. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ + parameters: + - $ref: '#/components/parameters/get_source::path.id' + - $ref: '#/components/parameters/get_source::path.index' + - $ref: '#/components/parameters/get_source::query.preference' + - $ref: '#/components/parameters/get_source::query.realtime' + - $ref: '#/components/parameters/get_source::query.refresh' + - $ref: '#/components/parameters/get_source::query.routing' + - $ref: '#/components/parameters/get_source::query._source' + - $ref: '#/components/parameters/get_source::query._source_excludes' + - $ref: '#/components/parameters/get_source::query._source_includes' + - $ref: '#/components/parameters/get_source::query.version' + - $ref: '#/components/parameters/get_source::query.version_type' + responses: + '200': + $ref: '#/components/responses/get_source@200' + head: + operationId: exists_source.0 + x-operation-group: exists_source + x-version-added: '1.0' + description: Returns information about whether a document source exists in an index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/ + parameters: + - $ref: '#/components/parameters/exists_source::path.id' + - $ref: '#/components/parameters/exists_source::path.index' + - $ref: '#/components/parameters/exists_source::query.preference' + - $ref: '#/components/parameters/exists_source::query.realtime' + - $ref: '#/components/parameters/exists_source::query.refresh' + - $ref: '#/components/parameters/exists_source::query.routing' + - $ref: '#/components/parameters/exists_source::query._source' + - $ref: '#/components/parameters/exists_source::query._source_excludes' + - $ref: '#/components/parameters/exists_source::query._source_includes' + - $ref: '#/components/parameters/exists_source::query.version' + - $ref: '#/components/parameters/exists_source::query.version_type' + responses: + '200': + $ref: '#/components/responses/exists_source@200' + /{index}/_termvectors: + get: + operationId: termvectors.0 + x-operation-group: termvectors + x-version-added: '1.0' + description: Returns information and statistics about terms in the fields of a particular document. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/termvectors::path.index' + - $ref: '#/components/parameters/termvectors::query.term_statistics' + - $ref: '#/components/parameters/termvectors::query.field_statistics' + - $ref: '#/components/parameters/termvectors::query.fields' + - $ref: '#/components/parameters/termvectors::query.offsets' + - $ref: '#/components/parameters/termvectors::query.positions' + - $ref: '#/components/parameters/termvectors::query.payloads' + - $ref: '#/components/parameters/termvectors::query.preference' + - $ref: '#/components/parameters/termvectors::query.routing' + - $ref: '#/components/parameters/termvectors::query.realtime' + - $ref: '#/components/parameters/termvectors::query.version' + - $ref: '#/components/parameters/termvectors::query.version_type' + requestBody: + $ref: '#/components/requestBodies/termvectors' + responses: + '200': + $ref: '#/components/responses/termvectors@200' + post: + operationId: termvectors.1 + x-operation-group: termvectors + x-version-added: '1.0' + description: Returns information and statistics about terms in the fields of a particular document. + parameters: + - $ref: '#/components/parameters/termvectors::path.index' + - $ref: '#/components/parameters/termvectors::query.term_statistics' + - $ref: '#/components/parameters/termvectors::query.field_statistics' + - $ref: '#/components/parameters/termvectors::query.fields' + - $ref: '#/components/parameters/termvectors::query.offsets' + - $ref: '#/components/parameters/termvectors::query.positions' + - $ref: '#/components/parameters/termvectors::query.payloads' + - $ref: '#/components/parameters/termvectors::query.preference' + - $ref: '#/components/parameters/termvectors::query.routing' + - $ref: '#/components/parameters/termvectors::query.realtime' + - $ref: '#/components/parameters/termvectors::query.version' + - $ref: '#/components/parameters/termvectors::query.version_type' + requestBody: + $ref: '#/components/requestBodies/termvectors' + responses: + '200': + $ref: '#/components/responses/termvectors@200' + /{index}/_termvectors/{id}: + get: + operationId: termvectors.2 + x-operation-group: termvectors + x-version-added: '1.0' + description: Returns information and statistics about terms in the fields of a particular document. + parameters: + - $ref: '#/components/parameters/termvectors::path.index' + - $ref: '#/components/parameters/termvectors::path.id' + - $ref: '#/components/parameters/termvectors::query.term_statistics' + - $ref: '#/components/parameters/termvectors::query.field_statistics' + - $ref: '#/components/parameters/termvectors::query.fields' + - $ref: '#/components/parameters/termvectors::query.offsets' + - $ref: '#/components/parameters/termvectors::query.positions' + - $ref: '#/components/parameters/termvectors::query.payloads' + - $ref: '#/components/parameters/termvectors::query.preference' + - $ref: '#/components/parameters/termvectors::query.routing' + - $ref: '#/components/parameters/termvectors::query.realtime' + - $ref: '#/components/parameters/termvectors::query.version' + - $ref: '#/components/parameters/termvectors::query.version_type' + requestBody: + $ref: '#/components/requestBodies/termvectors' + responses: + '200': + $ref: '#/components/responses/termvectors@200' + post: + operationId: termvectors.3 + x-operation-group: termvectors + x-version-added: '1.0' + description: Returns information and statistics about terms in the fields of a particular document. + parameters: + - $ref: '#/components/parameters/termvectors::path.index' + - $ref: '#/components/parameters/termvectors::path.id' + - $ref: '#/components/parameters/termvectors::query.term_statistics' + - $ref: '#/components/parameters/termvectors::query.field_statistics' + - $ref: '#/components/parameters/termvectors::query.fields' + - $ref: '#/components/parameters/termvectors::query.offsets' + - $ref: '#/components/parameters/termvectors::query.positions' + - $ref: '#/components/parameters/termvectors::query.payloads' + - $ref: '#/components/parameters/termvectors::query.preference' + - $ref: '#/components/parameters/termvectors::query.routing' + - $ref: '#/components/parameters/termvectors::query.realtime' + - $ref: '#/components/parameters/termvectors::query.version' + - $ref: '#/components/parameters/termvectors::query.version_type' + requestBody: + $ref: '#/components/requestBodies/termvectors' + responses: + '200': + $ref: '#/components/responses/termvectors@200' + /{index}/_update/{id}: + post: + operationId: update.0 + x-operation-group: update + x-version-added: '1.0' + description: Updates a document with a script or partial document. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/update-document/ + parameters: + - $ref: '#/components/parameters/update::path.id' + - $ref: '#/components/parameters/update::path.index' + - $ref: '#/components/parameters/update::query.wait_for_active_shards' + - $ref: '#/components/parameters/update::query._source' + - $ref: '#/components/parameters/update::query._source_excludes' + - $ref: '#/components/parameters/update::query._source_includes' + - $ref: '#/components/parameters/update::query.lang' + - $ref: '#/components/parameters/update::query.refresh' + - $ref: '#/components/parameters/update::query.retry_on_conflict' + - $ref: '#/components/parameters/update::query.routing' + - $ref: '#/components/parameters/update::query.timeout' + - $ref: '#/components/parameters/update::query.if_seq_no' + - $ref: '#/components/parameters/update::query.if_primary_term' + - $ref: '#/components/parameters/update::query.require_alias' + requestBody: + $ref: '#/components/requestBodies/update' + responses: + '200': + $ref: '#/components/responses/update@200' + /{index}/_update_by_query: + post: + operationId: update_by_query.0 + x-operation-group: update_by_query + x-version-added: '1.0' + description: |- + Performs an update on every document in the index without changing the source, + for example to pick up a mapping change. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/document-apis/update-by-query/ + parameters: + - $ref: '#/components/parameters/update_by_query::path.index' + - $ref: '#/components/parameters/update_by_query::query.analyzer' + - $ref: '#/components/parameters/update_by_query::query.analyze_wildcard' + - $ref: '#/components/parameters/update_by_query::query.default_operator' + - $ref: '#/components/parameters/update_by_query::query.df' + - $ref: '#/components/parameters/update_by_query::query.from' + - $ref: '#/components/parameters/update_by_query::query.ignore_unavailable' + - $ref: '#/components/parameters/update_by_query::query.allow_no_indices' + - $ref: '#/components/parameters/update_by_query::query.conflicts' + - $ref: '#/components/parameters/update_by_query::query.expand_wildcards' + - $ref: '#/components/parameters/update_by_query::query.lenient' + - $ref: '#/components/parameters/update_by_query::query.pipeline' + - $ref: '#/components/parameters/update_by_query::query.preference' + - $ref: '#/components/parameters/update_by_query::query.q' + - $ref: '#/components/parameters/update_by_query::query.routing' + - $ref: '#/components/parameters/update_by_query::query.scroll' + - $ref: '#/components/parameters/update_by_query::query.search_type' + - $ref: '#/components/parameters/update_by_query::query.search_timeout' + - $ref: '#/components/parameters/update_by_query::query.size' + - $ref: '#/components/parameters/update_by_query::query.max_docs' + - $ref: '#/components/parameters/update_by_query::query.sort' + - $ref: '#/components/parameters/update_by_query::query._source' + - $ref: '#/components/parameters/update_by_query::query._source_excludes' + - $ref: '#/components/parameters/update_by_query::query._source_includes' + - $ref: '#/components/parameters/update_by_query::query.terminate_after' + - $ref: '#/components/parameters/update_by_query::query.stats' + - $ref: '#/components/parameters/update_by_query::query.version' + - $ref: '#/components/parameters/update_by_query::query.request_cache' + - $ref: '#/components/parameters/update_by_query::query.refresh' + - $ref: '#/components/parameters/update_by_query::query.timeout' + - $ref: '#/components/parameters/update_by_query::query.wait_for_active_shards' + - $ref: '#/components/parameters/update_by_query::query.scroll_size' + - $ref: '#/components/parameters/update_by_query::query.wait_for_completion' + - $ref: '#/components/parameters/update_by_query::query.requests_per_second' + - $ref: '#/components/parameters/update_by_query::query.slices' + requestBody: + $ref: '#/components/requestBodies/update_by_query' + responses: + '200': + $ref: '#/components/responses/update_by_query@200' +components: + requestBodies: + bulk: + content: + application/json: + schema: + type: array + items: + oneOf: + - $ref: '../schemas/_core.bulk.yaml#/components/schemas/OperationContainer' + - $ref: '../schemas/_core.bulk.yaml#/components/schemas/UpdateAction' + - type: object + description: The operation definition and data (action-data pairs), separated by newlines + x-serialize: bulk + required: true + clear_scroll: + content: + application/json: + schema: + type: object + properties: + scroll_id: + $ref: '../schemas/_common.yaml#/components/schemas/ScrollIds' + description: Comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter + count: + content: + application/json: + schema: + type: object + properties: + query: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer' + description: Query to restrict the results specified with the Query DSL (optional) + create: + content: + application/json: + schema: + type: object + description: The document + required: true + delete_by_query: + content: + application/json: + schema: + type: object + properties: + max_docs: + description: The maximum number of documents to delete. + type: number + query: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer' + slice: + $ref: '../schemas/_common.yaml#/components/schemas/SlicedScroll' + description: The search definition using the Query DSL + required: true + delete_pit: + content: + application/json: + schema: + type: object + description: The point-in-time ids to be deleted + properties: + pit_id: + type: array + items: + type: string + required: + - pit_id + explain: + content: + application/json: + schema: + type: object + properties: + query: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer' + description: The query definition using the Query DSL + field_caps: + content: + application/json: + schema: + type: object + properties: + fields: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + index_filter: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer' + runtime_mappings: + $ref: '../schemas/_common.mapping.yaml#/components/schemas/RuntimeFields' + description: An index filter specified with the Query DSL + index: + content: + application/json: + schema: + type: object + description: The document + required: true + mget: + content: + application/json: + schema: + type: object + properties: + docs: + description: The documents you want to retrieve. Required if no index is specified in the request URI. + type: array + items: + $ref: '../schemas/_core.mget.yaml#/components/schemas/Operation' + ids: + $ref: '../schemas/_common.yaml#/components/schemas/Ids' + description: Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is + provided in the URL. + required: true + msearch: + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/_core.msearch.yaml#/components/schemas/RequestItem' + description: The request definitions (metadata-search request definition pairs), separated by newlines + x-serialize: bulk + required: true + msearch_template: + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/_core.msearch_template.yaml#/components/schemas/RequestItem' + description: The request definitions (metadata-search request definition pairs), separated by newlines + x-serialize: bulk + required: true + mtermvectors: + content: + application/json: + schema: + type: object + properties: + docs: + description: Array of existing or artificial documents. + type: array + items: + $ref: '../schemas/_core.mtermvectors.yaml#/components/schemas/Operation' + ids: + description: Simplified syntax to specify documents by their ID if they're in the same index. + type: array + items: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + description: Define ids, documents, parameters or a list of parameters per document here. You must at least provide a + list of document ids. See documentation. + put_script: + content: + application/json: + schema: + type: object + properties: + script: + $ref: '../schemas/_common.yaml#/components/schemas/StoredScript' + required: + - script + description: The document + required: true + rank_eval: + content: + application/json: + schema: + type: object + properties: + requests: + description: A set of typical search requests, together with their provided ratings. + type: array + items: + $ref: '../schemas/_core.rank_eval.yaml#/components/schemas/RankEvalRequestItem' + metric: + $ref: '../schemas/_core.rank_eval.yaml#/components/schemas/RankEvalMetric' + required: + - requests + description: The ranking evaluation search definition, including search requests, document ratings and ranking metric + definition. + required: true + reindex: + content: + application/json: + schema: + type: object + properties: + conflicts: + $ref: '../schemas/_common.yaml#/components/schemas/Conflicts' + dest: + $ref: '../schemas/_core.reindex.yaml#/components/schemas/Destination' + max_docs: + description: The maximum number of documents to reindex. + type: number + script: + $ref: '../schemas/_common.yaml#/components/schemas/Script' + size: + type: number + source: + $ref: '../schemas/_core.reindex.yaml#/components/schemas/Source' + required: + - dest + - source + description: The search definition using the Query DSL and the prototype for the index request. + required: true + render_search_template: + content: + application/json: + schema: + type: object + properties: + file: + type: string + params: + description: |- + Key-value pairs used to replace Mustache variables in the template. + The key is the variable name. + The value is the variable value. + type: object + additionalProperties: + type: object + source: + description: |- + An inline search template. + Supports the same parameters as the search API's request body. + These parameters also support Mustache variables. + If no `id` or `` is specified, this parameter is required. + type: string + description: The search definition template and its params + scripts_painless_execute: + content: + application/json: + schema: + type: object + properties: + context: + description: The context that the script should run in. + type: string + context_setup: + $ref: '../schemas/_core.scripts_painless_execute.yaml#/components/schemas/PainlessContextSetup' + script: + $ref: '../schemas/_common.yaml#/components/schemas/InlineScript' + description: The script to execute + scroll: + content: + application/json: + schema: + type: object + properties: + scroll: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + scroll_id: + $ref: '../schemas/_common.yaml#/components/schemas/ScrollId' + required: + - scroll_id + description: The scroll ID if not passed by URL or query parameter. + search: + content: + application/json: + schema: + type: object + properties: + aggregations: + description: Defines the aggregations that are run as part of the search request. + type: object + additionalProperties: + $ref: '../schemas/_common.aggregations.yaml#/components/schemas/AggregationContainer' + collapse: + $ref: '../schemas/_core.search.yaml#/components/schemas/FieldCollapse' + explain: + description: If true, returns detailed information about score computation as part of a hit. + type: boolean + ext: + description: Configuration of search extensions defined by Opensearch plugins. + type: object + additionalProperties: + type: object + from: + description: |- + Starting document offset. + Needs to be non-negative. + 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. + type: number + highlight: + $ref: '../schemas/_core.search.yaml#/components/schemas/Highlight' + track_total_hits: + $ref: '../schemas/_core.search.yaml#/components/schemas/TrackHits' + indices_boost: + description: Boosts the _score of documents from specified indices. + type: array + items: + type: object + additionalProperties: + type: number + docvalue_fields: + description: >- + Array of wildcard (`*`) patterns. + + The request returns doc values for field names matching these patterns in the `hits.fields` property of the response. + type: array + items: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/FieldAndFormat' + knn: + description: Defines the approximate kNN search to run. + oneOf: + - $ref: '../schemas/_common.yaml#/components/schemas/KnnQuery' + - type: array + items: + $ref: '../schemas/_common.yaml#/components/schemas/KnnQuery' + rank: + $ref: '../schemas/_common.yaml#/components/schemas/RankContainer' + min_score: + description: |- + Minimum `_score` for matching documents. + Documents with a lower `_score` are not included in the search results. + type: number + post_filter: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer' + profile: + description: >- + Set to `true` to return detailed timing information about the execution of individual components in a + search request. + + NOTE: This is a debugging tool and adds significant overhead to search execution. + type: boolean + query: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer' + rescore: + description: Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by + the `query` and `post_filter` phases. + oneOf: + - $ref: '../schemas/_core.search.yaml#/components/schemas/Rescore' + - type: array + items: + $ref: '../schemas/_core.search.yaml#/components/schemas/Rescore' + script_fields: + description: Retrieve a script evaluation (based on different fields) for each hit. + type: object + additionalProperties: + $ref: '../schemas/_common.yaml#/components/schemas/ScriptField' + search_after: + $ref: '../schemas/_common.yaml#/components/schemas/SortResults' + size: + description: |- + 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. + type: number + slice: + $ref: '../schemas/_common.yaml#/components/schemas/SlicedScroll' + sort: + $ref: '../schemas/_common.yaml#/components/schemas/Sort' + _source: + $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfig' + fields: + description: >- + Array of wildcard (`*`) patterns. + + The request returns values for field names matching these patterns in the `hits.fields` property of the response. + type: array + items: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/FieldAndFormat' + suggest: + $ref: '../schemas/_core.search.yaml#/components/schemas/Suggester' + terminate_after: + description: >- + Maximum number of documents to collect for each shard. + + If a query reaches this limit, Opensearch terminates the query early. + + Opensearch collects documents before sorting. + + Use with caution. + + Opensearch applies this parameter to each shard handling the request. + + When possible, let Opensearch perform early termination automatically. + + Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + + If set to `0` (default), the query does not terminate early. + type: number + timeout: + description: |- + 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. + type: string + track_scores: + description: If true, calculate and return document scores, even if the scores are not used for sorting. + type: boolean + version: + description: If true, returns document version as part of a hit. + type: boolean + seq_no_primary_term: + description: If `true`, returns sequence number and primary term of the last modification of each hit. + type: boolean + stored_fields: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + pit: + $ref: '../schemas/_core.search.yaml#/components/schemas/PointInTimeReference' + runtime_mappings: + $ref: '../schemas/_common.mapping.yaml#/components/schemas/RuntimeFields' + stats: + description: |- + 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. + type: array + items: + type: string + description: The search definition using the Query DSL + search_template: + content: + application/json: + schema: + type: object + properties: + explain: + description: If `true`, returns detailed information about score calculation as part of each hit. + type: boolean + id: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + params: + description: |- + Key-value pairs used to replace Mustache variables in the template. + The key is the variable name. + The value is the variable value. + type: object + additionalProperties: + type: object + profile: + description: If `true`, the query execution is profiled. + type: boolean + source: + description: |- + 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. + type: string + description: The search definition template and its params + required: true + termvectors: + content: + application/json: + schema: + type: object + properties: + doc: + description: An artificial document (a document not present in the index) for which you want to retrieve term vectors. + type: object + filter: + $ref: '../schemas/_core.termvectors.yaml#/components/schemas/Filter' + per_field_analyzer: + description: Overrides the default per-field analyzer. + type: object + additionalProperties: + type: string + description: Define parameters and or supply a document to get termvectors for. See documentation. + update: + content: + application/json: + schema: + type: object + properties: + detect_noop: + description: |- + Set to false to disable setting 'result' in the response + to 'noop' if no change to the document occurred. + type: boolean + doc: + description: A partial update to an existing document. + type: object + doc_as_upsert: + description: Set to true to use the contents of 'doc' as the value of 'upsert' + type: boolean + script: + $ref: '../schemas/_common.yaml#/components/schemas/Script' + scripted_upsert: + description: Set to true to execute the script whether or not the document exists. + type: boolean + _source: + $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfig' + upsert: + description: |- + 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. + type: object + description: The request definition requires either `script` or partial `doc` + required: true + update_by_query: + content: + application/json: + schema: + type: object + properties: + max_docs: + description: The maximum number of documents to update. + type: number + query: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer' + script: + $ref: '../schemas/_common.yaml#/components/schemas/Script' + slice: + $ref: '../schemas/_common.yaml#/components/schemas/SlicedScroll' + conflicts: + $ref: '../schemas/_common.yaml#/components/schemas/Conflicts' + description: The search definition using the Query DSL + responses: + bulk@200: + description: '' + content: + application/json: + schema: + type: object + properties: + errors: + type: boolean + items: + type: array + items: + type: object + additionalProperties: + $ref: '../schemas/_core.bulk.yaml#/components/schemas/ResponseItem' + minProperties: 1 + maxProperties: 1 + took: + type: number + ingest_took: + type: number + required: + - errors + - items + - took + clear_scroll@200: + description: '' + content: + application/json: + schema: + type: object + properties: + succeeded: + type: boolean + num_freed: + type: number + required: + - succeeded + - num_freed + count@200: + description: '' + content: + application/json: + schema: + type: object + properties: + count: + type: number + _shards: + $ref: '../schemas/_common.yaml#/components/schemas/ShardStatistics' + required: + - count + - _shards + create@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WriteResponseBase' + create_pit@200: + description: '' + content: + application/json: + schema: + type: object + properties: + pit_id: + type: string + _shards: + $ref: '../schemas/_core._common.yaml#/components/schemas/ShardStatistics' + creation_time: + type: integer + format: int64 + delete@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WriteResponseBase' + delete_all_pits@200: + description: '' + content: + application/json: + schema: + type: object + properties: + pits: + type: array + items: + $ref: '../schemas/_core._common.yaml#/components/schemas/PitsDetailsDeleteAll' + delete_by_query@200: + description: '' + content: + application/json: + schema: + type: object + properties: + batches: + type: number + deleted: + type: number + failures: + type: array + items: + $ref: '../schemas/_common.yaml#/components/schemas/BulkIndexByScrollFailure' + noops: + type: number + requests_per_second: + type: number + retries: + $ref: '../schemas/_common.yaml#/components/schemas/Retries' + slice_id: + type: number + task: + $ref: '../schemas/_common.yaml#/components/schemas/TaskId' + throttled: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + throttled_millis: + $ref: '../schemas/_common.yaml#/components/schemas/DurationValueUnitMillis' + throttled_until: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + throttled_until_millis: + $ref: '../schemas/_common.yaml#/components/schemas/DurationValueUnitMillis' + timed_out: + type: boolean + took: + $ref: '../schemas/_common.yaml#/components/schemas/DurationValueUnitMillis' + total: + type: number + version_conflicts: + type: number + delete_by_query_rethrottle@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/tasks._common.yaml#/components/schemas/TaskListResponseBase' + delete_pit@200: + description: '' + content: + application/json: + schema: + type: object + properties: + pits: + type: array + items: + $ref: '../schemas/_core._common.yaml#/components/schemas/DeletedPit' + delete_script@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + exists@200: + description: '' + content: + application/json: {} + exists_source@200: + description: '' + content: + application/json: {} + explain@200: + description: '' + content: + application/json: + schema: + type: object + properties: + _index: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + _id: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + matched: + type: boolean + explanation: + $ref: '../schemas/_core.explain.yaml#/components/schemas/ExplanationDetail' + get: + $ref: '../schemas/_common.yaml#/components/schemas/InlineGet' + required: + - _index + - _id + - matched + field_caps@200: + description: '' + content: + application/json: + schema: + type: object + properties: + indices: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + fields: + type: object + additionalProperties: + type: object + additionalProperties: + $ref: '../schemas/_core.field_caps.yaml#/components/schemas/FieldCapability' + required: + - indices + - fields + get@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_core.get.yaml#/components/schemas/GetResult' + get_all_pits@200: + description: '' + content: + application/json: + schema: + type: object + properties: + pits: + type: array + items: + $ref: '../schemas/_core._common.yaml#/components/schemas/PitDetail' + get_script@200: + description: '' + content: + application/json: + schema: + type: object + properties: + _id: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + found: + type: boolean + script: + $ref: '../schemas/_common.yaml#/components/schemas/StoredScript' + required: + - _id + - found + get_script_context@200: + description: '' + content: + application/json: + schema: + type: object + properties: + contexts: + type: array + items: + $ref: '../schemas/_core.get_script_context.yaml#/components/schemas/Context' + required: + - contexts + get_script_languages@200: + description: '' + content: + application/json: + schema: + type: object + properties: + language_contexts: + type: array + items: + $ref: '../schemas/_core.get_script_languages.yaml#/components/schemas/LanguageContext' + types_allowed: + type: array + items: + type: string + required: + - language_contexts + - types_allowed + get_source@200: + description: '' + content: + application/json: + schema: + type: object + index@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WriteResponseBase' + info@200: + description: '' + content: + application/json: + schema: + type: object + properties: + cluster_name: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + cluster_uuid: + $ref: '../schemas/_common.yaml#/components/schemas/Uuid' + name: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + tagline: + type: string + version: + $ref: '../schemas/_common.yaml#/components/schemas/OpensearchVersionInfo' + required: + - cluster_name + - cluster_uuid + - name + - tagline + - version + mget@200: + description: '' + content: + application/json: + schema: + type: object + properties: + docs: + type: array + items: + $ref: '../schemas/_core.mget.yaml#/components/schemas/ResponseItem' + required: + - docs + msearch@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_core.msearch.yaml#/components/schemas/MultiSearchResult' + msearch_template@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_core.msearch.yaml#/components/schemas/MultiSearchResult' + mtermvectors@200: + description: '' + content: + application/json: + schema: + type: object + properties: + docs: + type: array + items: + $ref: '../schemas/_core.mtermvectors.yaml#/components/schemas/TermVectorsResult' + required: + - docs + ping@200: + description: '' + content: + application/json: {} + put_script@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + rank_eval@200: + description: '' + content: + application/json: + schema: + type: object + properties: + metric_score: + description: The overall evaluation quality calculated by the defined metric + type: number + details: + description: The details section contains one entry for every query in the original requests section, keyed by the + search request id + type: object + additionalProperties: + $ref: '../schemas/_core.rank_eval.yaml#/components/schemas/RankEvalMetricDetail' + failures: + type: object + additionalProperties: + type: object + required: + - metric_score + - details + - failures + reindex@200: + description: '' + content: + application/json: + schema: + type: object + properties: + batches: + type: number + created: + type: number + deleted: + type: number + failures: + type: array + items: + $ref: '../schemas/_common.yaml#/components/schemas/BulkIndexByScrollFailure' + noops: + type: number + retries: + $ref: '../schemas/_common.yaml#/components/schemas/Retries' + requests_per_second: + type: number + slice_id: + type: number + task: + $ref: '../schemas/_common.yaml#/components/schemas/TaskId' + throttled_millis: + $ref: '../schemas/_common.yaml#/components/schemas/EpochTimeUnitMillis' + throttled_until_millis: + $ref: '../schemas/_common.yaml#/components/schemas/EpochTimeUnitMillis' + timed_out: + type: boolean + took: + $ref: '../schemas/_common.yaml#/components/schemas/DurationValueUnitMillis' + total: + type: number + updated: + type: number + version_conflicts: + type: number + reindex_rethrottle@200: + description: '' + content: + application/json: + schema: + type: object + properties: + nodes: + type: object + additionalProperties: + $ref: '../schemas/_core.reindex_rethrottle.yaml#/components/schemas/ReindexNode' + required: + - nodes + render_search_template@200: + description: '' + content: + application/json: + schema: + type: object + properties: + template_output: + type: object + additionalProperties: + type: object + required: + - template_output + scripts_painless_execute@200: + description: '' + content: + application/json: + schema: + type: object + properties: + result: + type: object + required: + - result + scroll@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_core.search.yaml#/components/schemas/ResponseBody' + search@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_core.search.yaml#/components/schemas/ResponseBody' + search_shards@200: + description: '' + content: + application/json: + schema: + type: object + properties: + nodes: + type: object + additionalProperties: + $ref: '../schemas/_common.yaml#/components/schemas/NodeAttributes' + shards: + type: array + items: + type: array + items: + $ref: '../schemas/_common.yaml#/components/schemas/NodeShard' + indices: + type: object + additionalProperties: + $ref: '../schemas/_core.search_shards.yaml#/components/schemas/ShardStoreIndex' + required: + - nodes + - shards + - indices + search_template@200: + description: '' + content: + application/json: + schema: + type: object + properties: + took: + type: number + timed_out: + type: boolean + _shards: + $ref: '../schemas/_common.yaml#/components/schemas/ShardStatistics' + hits: + $ref: '../schemas/_core.search.yaml#/components/schemas/HitsMetadata' + aggregations: + type: object + additionalProperties: + $ref: '../schemas/_common.aggregations.yaml#/components/schemas/Aggregate' + _clusters: + $ref: '../schemas/_common.yaml#/components/schemas/ClusterStatistics' + fields: + type: object + additionalProperties: + type: object + max_score: + type: number + num_reduce_phases: + type: number + profile: + $ref: '../schemas/_core.search.yaml#/components/schemas/Profile' + pit_id: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + _scroll_id: + $ref: '../schemas/_common.yaml#/components/schemas/ScrollId' + suggest: + type: object + additionalProperties: + type: array + items: + $ref: '../schemas/_core.search.yaml#/components/schemas/Suggest' + terminated_early: + type: boolean + required: + - took + - timed_out + - _shards + - hits + termvectors@200: + description: '' + content: + application/json: + schema: + type: object + properties: + found: + type: boolean + _id: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + _index: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + term_vectors: + type: object + additionalProperties: + $ref: '../schemas/_core.termvectors.yaml#/components/schemas/TermVector' + took: + type: number + _version: + $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' + required: + - found + - _id + - _index + - took + - _version + update@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_core.update.yaml#/components/schemas/UpdateWriteResponseBase' + update_by_query@200: + description: '' + content: + application/json: + schema: + type: object + properties: + batches: + type: number + failures: + type: array + items: + $ref: '../schemas/_common.yaml#/components/schemas/BulkIndexByScrollFailure' + noops: + type: number + deleted: + type: number + requests_per_second: + type: number + retries: + $ref: '../schemas/_common.yaml#/components/schemas/Retries' + task: + $ref: '../schemas/_common.yaml#/components/schemas/TaskId' + timed_out: + type: boolean + took: + $ref: '../schemas/_common.yaml#/components/schemas/DurationValueUnitMillis' + total: + type: number + updated: + type: number + version_conflicts: + type: number + throttled: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + throttled_millis: + $ref: '../schemas/_common.yaml#/components/schemas/DurationValueUnitMillis' + throttled_until: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + throttled_until_millis: + $ref: '../schemas/_common.yaml#/components/schemas/DurationValueUnitMillis' + update_by_query_rethrottle@200: + description: '' + content: + application/json: + schema: + type: object + properties: + nodes: + type: object + additionalProperties: + $ref: '../schemas/_core.update_by_query_rethrottle.yaml#/components/schemas/UpdateByQueryRethrottleNode' + required: + - nodes + parameters: + bulk::path.index: + in: path + name: index + description: Name of the data stream, index, or index alias to perform bulk actions on. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + bulk::query._source: + in: query + name: _source + description: '`true` or `false` to return the `_source` field or not, or a list of fields to return.' + schema: + $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam' + style: form + bulk::query._source_excludes: + in: query + name: _source_excludes + description: A comma-separated list of source fields to exclude from the response. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + bulk::query._source_includes: + in: query + name: _source_includes + description: A comma-separated list of source fields to include in the response. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + bulk::query.pipeline: + in: query + name: pipeline + description: >- + ID of the pipeline to use to preprocess incoming documents. + + If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. + + If a final pipeline is configured it will always run, regardless of the value of this parameter. + schema: + type: string + style: form + bulk::query.refresh: + in: query + name: refresh + description: >- + If `true`, Opensearch 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. + + Valid values: `true`, `false`, `wait_for`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Refresh' + style: form + bulk::query.require_alias: + in: query + name: require_alias + description: If `true`, the request’s actions must target an index alias. + schema: + type: boolean + style: form + bulk::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + bulk::query.timeout: + in: query + name: timeout + description: 'Period each action waits for the following operations: automatic index creation, dynamic mapping updates, + waiting for active shards.' + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + bulk::query.type: + name: type + in: query + description: Default document type for items which don't provide one. + schema: + type: string + description: Default document type for items which don't provide one. + bulk::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' + style: form + clear_scroll::path.scroll_id: + in: path + name: scroll_id + description: |- + Comma-separated list of scroll IDs to clear. + To clear all scroll IDs, use `_all`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ScrollIds' + style: simple + count::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases to search. + Supports wildcards (`*`). + To search all data streams and indices, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + count::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + count::query.analyze_wildcard: + in: query + name: analyze_wildcard + description: |- + If `true`, wildcard and prefix queries are analyzed. + This parameter can only be used when the `q` query string parameter is specified. + schema: + type: boolean + style: form + count::query.analyzer: + in: query + name: analyzer + description: |- + Analyzer to use for the query string. + This parameter can only be used when the `q` query string parameter is specified. + schema: + type: string + style: form + count::query.default_operator: + in: query + name: default_operator + description: |- + The default operator for query string query: `AND` or `OR`. + This parameter can only be used when the `q` query string parameter is specified. + schema: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/Operator' + style: form + count::query.df: + in: query + name: df + description: |- + Field to use as default where no field prefix is given in the query string. + This parameter can only be used when the `q` query string parameter is specified. + schema: + type: string + style: form + count::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + count::query.ignore_throttled: + in: query + name: ignore_throttled + description: If `true`, concrete, expanded or aliased indices are ignored when frozen. + schema: + type: boolean + style: form + count::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + count::query.lenient: + in: query + name: lenient + description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will + be ignored. + schema: + type: boolean + style: form + count::query.min_score: + in: query + name: min_score + description: Sets the minimum `_score` value that documents must have to be included in the result. + schema: + type: number + style: form + count::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + count::query.q: + in: query + name: q + description: Query in the Lucene query string syntax. + schema: + type: string + style: form + count::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + count::query.terminate_after: + in: query + name: terminate_after + description: |- + Maximum number of documents to collect for each shard. + If a query reaches this limit, Opensearch terminates the query early. + Opensearch collects documents before sorting. + schema: + type: number + style: form + create::path.id: + in: path + name: id + description: Unique identifier for the document. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + create::path.index: + in: path + name: index + description: >- + Name of the data stream or index to target. + + If the target doesn’t exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. + + If the target doesn’t exist and doesn’t match a data stream template, this request creates the index. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + create::query.pipeline: + in: query + name: pipeline + description: >- + ID of the pipeline to use to preprocess incoming documents. + + If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. + + If a final pipeline is configured it will always run, regardless of the value of this parameter. + schema: + type: string + style: form + create::query.refresh: + in: query + name: refresh + description: >- + If `true`, Opensearch 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. + + Valid values: `true`, `false`, `wait_for`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Refresh' + style: form + create::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + create::query.timeout: + in: query + name: timeout + description: 'Period the request waits for the following operations: automatic index creation, dynamic mapping updates, + waiting for active shards.' + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + create::query.version: + in: query + name: version + description: |- + Explicit version number for concurrency control. + The specified version must match the current version of the document for the request to succeed. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' + style: form + create::query.version_type: + in: query + name: version_type + description: 'Specific version type: `external`, `external_gte`.' + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionType' + style: form + create::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' + style: form + create_pit::path.index: + name: index + in: path + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + x-data-type: array + required: true + create_pit::query.allow_partial_pit_creation: + name: allow_partial_pit_creation + in: query + description: Allow if point in time can be created with partial failures. + schema: + type: boolean + description: Allow if point in time can be created with partial failures. + create_pit::query.expand_wildcards: + name: expand_wildcards + in: query + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + create_pit::query.keep_alive: + name: keep_alive + in: query + description: Specify the keep alive for point in time. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + create_pit::query.preference: + name: preference + in: query + description: Specify the node or shard the operation should be performed on. + schema: + type: string + default: random + description: Specify the node or shard the operation should be performed on. + create_pit::query.routing: + name: routing + in: query + description: Comma-separated list of specific routing values. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of specific routing values. + explode: true + delete::path.id: + in: path + name: id + description: Unique identifier for the document. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + delete::path.index: + in: path + name: index + description: Name of the target index. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + delete::query.if_primary_term: + in: query + name: if_primary_term + description: Only perform the operation if the document has this primary term. + schema: + type: number + style: form + delete::query.if_seq_no: + in: query + name: if_seq_no + description: Only perform the operation if the document has this sequence number. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/SequenceNumber' + style: form + delete::query.refresh: + in: query + name: refresh + description: >- + If `true`, Opensearch 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. + + Valid values: `true`, `false`, `wait_for`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Refresh' + style: form + delete::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + delete::query.timeout: + in: query + name: timeout + description: Period to wait for active shards. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + delete::query.version: + in: query + name: version + description: |- + Explicit version number for concurrency control. + The specified version must match the current version of the document for the request to succeed. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' + style: form + delete::query.version_type: + in: query + name: version_type + description: 'Specific version type: `external`, `external_gte`.' + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionType' + style: form + delete::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' + style: form + delete_by_query::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases to search. + Supports wildcards (`*`). + To search all data streams or indices, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + delete_by_query::query._source: + name: _source + in: query + description: True or false to return the _source field or not, or a list of fields to return. + style: form + schema: + type: array + items: + type: string + description: True or false to return the _source field or not, or a list of fields to return. + explode: true + delete_by_query::query._source_excludes: + name: _source_excludes + in: query + description: List of fields to exclude from the returned _source field. + style: form + schema: + type: array + items: + type: string + description: List of fields to exclude from the returned _source field. + explode: true + delete_by_query::query._source_includes: + name: _source_includes + in: query + description: List of fields to extract and return from the _source field. + style: form + schema: + type: array + items: + type: string + description: List of fields to extract and return from the _source field. + explode: true + delete_by_query::query.allow_no_indices: + in: query + name: allow_no_indices + 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`. + schema: + type: boolean + style: form + delete_by_query::query.analyze_wildcard: + in: query + name: analyze_wildcard + description: If `true`, wildcard and prefix queries are analyzed. + schema: + type: boolean + style: form + delete_by_query::query.analyzer: + in: query + name: analyzer + description: Analyzer to use for the query string. + schema: + type: string + style: form + delete_by_query::query.conflicts: + in: query + name: conflicts + description: 'What to do if delete by query hits version conflicts: `abort` or `proceed`.' + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Conflicts' + style: form + delete_by_query::query.default_operator: + in: query + name: default_operator + description: 'The default operator for query string query: `AND` or `OR`.' + schema: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/Operator' + style: form + delete_by_query::query.df: + in: query + name: df + description: Field to use as default where no field prefix is given in the query string. + schema: + type: string + style: form + delete_by_query::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + delete_by_query::query.from: + in: query + name: from + description: 'Starting offset (default: 0)' + schema: + type: number + style: form + delete_by_query::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + delete_by_query::query.lenient: + in: query + name: lenient + description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will + be ignored. + schema: + type: boolean + style: form + delete_by_query::query.max_docs: + in: query + name: max_docs + description: |- + Maximum number of documents to process. + Defaults to all documents. + schema: + type: number + style: form + delete_by_query::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + delete_by_query::query.q: + in: query + name: q + description: Query in the Lucene query string syntax. + schema: + type: string + style: form + delete_by_query::query.refresh: + in: query + name: refresh + description: If `true`, Opensearch refreshes all shards involved in the delete by query after the request completes. + schema: + type: boolean + style: form + delete_by_query::query.request_cache: + in: query + name: request_cache + description: |- + If `true`, the request cache is used for this request. + Defaults to the index-level setting. + schema: + type: boolean + style: form + delete_by_query::query.requests_per_second: + in: query + name: requests_per_second + description: The throttle for this request in sub-requests per second. + schema: + type: number + style: form + delete_by_query::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + delete_by_query::query.scroll: + in: query + name: scroll + description: Period to retain the search context for scrolling. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + delete_by_query::query.scroll_size: + in: query + name: scroll_size + description: Size of the scroll request that powers the operation. + schema: + type: number + style: form + delete_by_query::query.search_timeout: + in: query + name: search_timeout + description: |- + Explicit timeout for each search request. + Defaults to no timeout. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + delete_by_query::query.search_type: + in: query + name: search_type + description: |- + The type of the search operation. + Available options: `query_then_fetch`, `dfs_query_then_fetch`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/SearchType' + style: form + delete_by_query::query.size: + name: size + in: query + description: Deprecated, please use `max_docs` instead. + schema: + type: integer + description: Deprecated, please use `max_docs` instead. + format: int32 + delete_by_query::query.slices: + in: query + name: slices + description: The number of slices this task should be divided into. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Slices' + style: form + delete_by_query::query.sort: + in: query + name: sort + description: A comma-separated list of : pairs. + schema: + type: array + items: + type: string + style: form + delete_by_query::query.stats: + in: query + name: stats + description: Specific `tag` of the request for logging and statistical purposes. + schema: + type: array + items: + type: string + style: form + delete_by_query::query.terminate_after: + in: query + name: terminate_after + description: >- + Maximum number of documents to collect for each shard. + + If a query reaches this limit, Opensearch terminates the query early. + + Opensearch collects documents before sorting. + + Use with caution. + + Opensearch applies this parameter to each shard handling the request. + + When possible, let Opensearch perform early termination automatically. + + Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + schema: + type: number + style: form + delete_by_query::query.timeout: + in: query + name: timeout + description: Period each deletion request waits for active shards. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + delete_by_query::query.version: + in: query + name: version + description: If `true`, returns the document version as part of a hit. + schema: + type: boolean + style: form + delete_by_query::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' + style: form + delete_by_query::query.wait_for_completion: + in: query + name: wait_for_completion + description: If `true`, the request blocks until the operation is complete. + schema: + type: boolean + style: form + delete_by_query_rethrottle::path.task_id: + in: path + name: task_id + description: The ID for the task. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/TaskId' + style: simple + delete_by_query_rethrottle::query.requests_per_second: + in: query + name: requests_per_second + description: The throttle for this request in sub-requests per second. + schema: + type: number + style: form + delete_script::path.id: + in: path + name: id + description: Identifier for the stored script or search template. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + delete_script::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + delete_script::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + delete_script::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + exists::path.id: + in: path + name: id + description: Identifier of the document. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + exists::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases. + Supports wildcards (`*`). + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + exists::query._source: + in: query + name: _source + description: '`true` or `false` to return the `_source` field or not, or a list of fields to return.' + schema: + $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam' + style: form + exists::query._source_excludes: + in: query + name: _source_excludes + description: A comma-separated list of source fields to exclude in the response. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + exists::query._source_includes: + in: query + name: _source_includes + description: A comma-separated list of source fields to include in the response. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + exists::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + exists::query.realtime: + in: query + name: realtime + description: If `true`, the request is real-time as opposed to near-real-time. + schema: + type: boolean + style: form + exists::query.refresh: + in: query + name: refresh + description: If `true`, Opensearch refreshes all shards involved in the delete by query after the request completes. + schema: + type: boolean + style: form + exists::query.routing: + in: query + name: routing + description: Target the specified primary shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + exists::query.stored_fields: + in: query + name: stored_fields + description: |- + 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + exists::query.version: + in: query + name: version + description: |- + Explicit version number for concurrency control. + The specified version must match the current version of the document for the request to succeed. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' + style: form + exists::query.version_type: + in: query + name: version_type + description: 'Specific version type: `external`, `external_gte`.' + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionType' + style: form + exists_source::path.id: + in: path + name: id + description: Identifier of the document. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + exists_source::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases. + Supports wildcards (`*`). + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + exists_source::query._source: + in: query + name: _source + description: '`true` or `false` to return the `_source` field or not, or a list of fields to return.' + schema: + $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam' + style: form + exists_source::query._source_excludes: + in: query + name: _source_excludes + description: A comma-separated list of source fields to exclude in the response. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + exists_source::query._source_includes: + in: query + name: _source_includes + description: A comma-separated list of source fields to include in the response. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + exists_source::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + exists_source::query.realtime: + in: query + name: realtime + description: If true, the request is real-time as opposed to near-real-time. + schema: + type: boolean + style: form + exists_source::query.refresh: + in: query + name: refresh + description: If `true`, Opensearch refreshes all shards involved in the delete by query after the request completes. + schema: + type: boolean + style: form + exists_source::query.routing: + in: query + name: routing + description: Target the specified primary shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + exists_source::query.version: + in: query + name: version + description: |- + Explicit version number for concurrency control. + The specified version must match the current version of the document for the request to succeed. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' + style: form + exists_source::query.version_type: + in: query + name: version_type + description: 'Specific version type: `external`, `external_gte`.' + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionType' + style: form + explain::path.id: + in: path + name: id + description: Defines the document ID. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + explain::path.index: + in: path + name: index + description: |- + Index names used to limit the request. + Only a single index name can be provided to this parameter. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + explain::query._source: + in: query + name: _source + description: True or false to return the `_source` field or not, or a list of fields to return. + schema: + $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam' + style: form + explain::query._source_excludes: + in: query + name: _source_excludes + description: A comma-separated list of source fields to exclude from the response. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + explain::query._source_includes: + in: query + name: _source_includes + description: A comma-separated list of source fields to include in the response. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + explain::query.analyze_wildcard: + in: query + name: analyze_wildcard + description: If `true`, wildcard and prefix queries are analyzed. + schema: + type: boolean + style: form + explain::query.analyzer: + in: query + name: analyzer + description: |- + Analyzer to use for the query string. + This parameter can only be used when the `q` query string parameter is specified. + schema: + type: string + style: form + explain::query.default_operator: + in: query + name: default_operator + description: 'The default operator for query string query: `AND` or `OR`.' + schema: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/Operator' + style: form + explain::query.df: + in: query + name: df + description: Field to use as default where no field prefix is given in the query string. + schema: + type: string + style: form + explain::query.lenient: + in: query + name: lenient + description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will + be ignored. + schema: + type: boolean + style: form + explain::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + explain::query.q: + in: query + name: q + description: Query in the Lucene query string syntax. + schema: + type: string + style: form + explain::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + explain::query.stored_fields: + in: query + name: stored_fields + description: A comma-separated list of stored fields to return in the response. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + field_caps::path.index: + in: path + name: index + 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. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + field_caps::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + field_caps::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + field_caps::query.fields: + in: query + name: fields + description: Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + field_caps::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `true`, missing or closed indices are not included in the response. + schema: + type: boolean + style: form + field_caps::query.include_unmapped: + in: query + name: include_unmapped + description: If true, unmapped fields are included in the response. + schema: + type: boolean + style: form + get::path.id: + in: path + name: id + description: Unique identifier of the document. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + get::path.index: + in: path + name: index + description: Name of the index that contains the document. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + get::query._source: + in: query + name: _source + description: True or false to return the _source field or not, or a list of fields to return. + schema: + $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam' + style: form + get::query._source_excludes: + in: query + name: _source_excludes + description: A comma-separated list of source fields to exclude in the response. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + get::query._source_includes: + in: query + name: _source_includes + description: A comma-separated list of source fields to include in the response. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + get::query.preference: + in: query + name: preference + description: Specifies the node or shard the operation should be performed on. Random by default. + schema: + type: string + style: form + get::query.realtime: + in: query + name: realtime + description: If `true`, the request is real-time as opposed to near-real-time. + schema: + type: boolean + style: form + get::query.refresh: + in: query + name: refresh + description: If true, Opensearch refreshes the affected shards to make this operation visible to search. If false, do + nothing with refreshes. + schema: + type: boolean + style: form + get::query.routing: + in: query + name: routing + description: Target the specified primary shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + get::query.stored_fields: + in: query + name: stored_fields + description: |- + 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + get::query.version: + in: query + name: version + description: Explicit version number for concurrency control. The specified version must match the current version of + the document for the request to succeed. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' + style: form + get::query.version_type: + in: query + name: version_type + description: 'Specific version type: internal, external, external_gte.' + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionType' + style: form + get_script::path.id: + in: path + name: id + description: Identifier for the stored script or search template. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + get_script::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + get_script::query.master_timeout: + in: query + name: master_timeout + description: Specify timeout for connection to master + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + get_source::path.id: + in: path + name: id + description: Unique identifier of the document. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + get_source::path.index: + in: path + name: index + description: Name of the index that contains the document. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + get_source::query._source: + in: query + name: _source + description: True or false to return the _source field or not, or a list of fields to return. + schema: + $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam' + style: form + get_source::query._source_excludes: + in: query + name: _source_excludes + description: A comma-separated list of source fields to exclude in the response. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + get_source::query._source_includes: + in: query + name: _source_includes + description: A comma-separated list of source fields to include in the response. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + get_source::query.preference: + in: query + name: preference + description: Specifies the node or shard the operation should be performed on. Random by default. + schema: + type: string + style: form + get_source::query.realtime: + in: query + name: realtime + description: Boolean) If true, the request is real-time as opposed to near-real-time. + schema: + type: boolean + style: form + get_source::query.refresh: + in: query + name: refresh + description: If true, Opensearch refreshes the affected shards to make this operation visible to search. If false, do + nothing with refreshes. + schema: + type: boolean + style: form + get_source::query.routing: + in: query + name: routing + description: Target the specified primary shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + get_source::query.version: + in: query + name: version + description: Explicit version number for concurrency control. The specified version must match the current version of + the document for the request to succeed. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' + style: form + get_source::query.version_type: + in: query + name: version_type + description: 'Specific version type: internal, external, external_gte.' + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionType' + style: form + index::path.id: + in: path + name: id + description: Unique identifier for the document. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + index::path.index: + in: path + name: index + description: Name of the data stream or index to target. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + index::query.if_primary_term: + in: query + name: if_primary_term + description: Only perform the operation if the document has this primary term. + schema: + type: number + style: form + index::query.if_seq_no: + in: query + name: if_seq_no + description: Only perform the operation if the document has this sequence number. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/SequenceNumber' + style: form + index::query.op_type: + in: query + name: op_type + description: |- + Set to create to only index the document if it does not already exist (put if absent). + If a document with the specified `_id` already exists, the indexing operation will fail. + Same as using the `/_create` endpoint. + Valid values: `index`, `create`. + If document id is specified, it defaults to `index`. + Otherwise, it defaults to `create`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/OpType' + style: form + index::query.pipeline: + in: query + name: pipeline + description: >- + ID of the pipeline to use to preprocess incoming documents. + + If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. + + If a final pipeline is configured it will always run, regardless of the value of this parameter. + schema: + type: string + style: form + index::query.refresh: + in: query + name: refresh + description: >- + If `true`, Opensearch 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. + + Valid values: `true`, `false`, `wait_for`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Refresh' + style: form + index::query.require_alias: + in: query + name: require_alias + description: If `true`, the destination must be an index alias. + schema: + type: boolean + style: form + index::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + index::query.timeout: + in: query + name: timeout + description: 'Period the request waits for the following operations: automatic index creation, dynamic mapping updates, + waiting for active shards.' + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + index::query.version: + in: query + name: version + description: |- + Explicit version number for concurrency control. + The specified version must match the current version of the document for the request to succeed. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' + style: form + index::query.version_type: + in: query + name: version_type + description: 'Specific version type: `external`, `external_gte`.' + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionType' + style: form + index::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' + style: form + mget::path.index: + in: path + name: index + 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. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + mget::query._source: + in: query + name: _source + description: True or false to return the `_source` field or not, or a list of fields to return. + schema: + $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam' + style: form + mget::query._source_excludes: + in: query + name: _source_excludes + description: >- + 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + mget::query._source_includes: + in: query + name: _source_includes + description: >- + 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + mget::query.preference: + in: query + name: preference + description: Specifies the node or shard the operation should be performed on. Random by default. + schema: + type: string + style: form + mget::query.realtime: + in: query + name: realtime + description: If `true`, the request is real-time as opposed to near-real-time. + schema: + type: boolean + style: form + mget::query.refresh: + in: query + name: refresh + description: If `true`, the request refreshes relevant shards before retrieving documents. + schema: + type: boolean + style: form + mget::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + mget::query.stored_fields: + in: query + name: stored_fields + description: If `true`, retrieves the document fields stored in the index rather than the document `_source`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + msearch::path.index: + in: path + name: index + description: Comma-separated list of data streams, indices, and index aliases to search. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + msearch::query.ccs_minimize_roundtrips: + in: query + name: ccs_minimize_roundtrips + description: If true, network roundtrips between the coordinating node and remote clusters are minimized for + cross-cluster search requests. + schema: + type: boolean + style: form + msearch::query.max_concurrent_searches: + in: query + name: max_concurrent_searches + description: Maximum number of concurrent searches the multi search API can execute. + schema: + type: number + style: form + msearch::query.max_concurrent_shard_requests: + in: query + name: max_concurrent_shard_requests + description: Maximum number of concurrent shard requests that each sub-search request executes per node. + schema: + type: number + style: form + msearch::query.pre_filter_shard_size: + in: query + name: pre_filter_shard_size + description: 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. + schema: + type: number + style: form + msearch::query.rest_total_hits_as_int: + in: query + name: rest_total_hits_as_int + description: If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + schema: + type: boolean + style: form + msearch::query.search_type: + in: query + name: search_type + description: Indicates whether global term and document frequencies should be used when scoring returned documents. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/SearchType' + style: form + msearch::query.typed_keys: + in: query + name: typed_keys + description: Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. + schema: + type: boolean + style: form + msearch_template::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases to search. + Supports wildcards (`*`). + To search all data streams and indices, omit this parameter or use `*`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + msearch_template::query.ccs_minimize_roundtrips: + in: query + name: ccs_minimize_roundtrips + description: If `true`, network round-trips are minimized for cross-cluster search requests. + schema: + type: boolean + style: form + msearch_template::query.max_concurrent_searches: + in: query + name: max_concurrent_searches + description: Maximum number of concurrent searches the API can run. + schema: + type: number + style: form + msearch_template::query.rest_total_hits_as_int: + in: query + name: rest_total_hits_as_int + description: |- + If `true`, the response returns `hits.total` as an integer. + If `false`, it returns `hits.total` as an object. + schema: + type: boolean + style: form + msearch_template::query.search_type: + in: query + name: search_type + description: |- + The type of the search operation. + Available options: `query_then_fetch`, `dfs_query_then_fetch`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/SearchType' + style: form + msearch_template::query.typed_keys: + in: query + name: typed_keys + description: If `true`, the response prefixes aggregation and suggester names with their respective types. + schema: + type: boolean + style: form + mtermvectors::path.index: + in: path + name: index + description: Name of the index that contains the documents. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + mtermvectors::query.field_statistics: + in: query + name: field_statistics + description: If `true`, the response includes the document count, sum of document frequencies, and sum of total term + frequencies. + schema: + type: boolean + style: form + mtermvectors::query.fields: + in: query + name: fields + description: >- + Comma-separated list or wildcard expressions of fields to include in the statistics. + + Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + mtermvectors::query.ids: + in: query + name: ids + description: A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the + request body + schema: + type: array + items: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: form + mtermvectors::query.offsets: + in: query + name: offsets + description: If `true`, the response includes term offsets. + schema: + type: boolean + style: form + mtermvectors::query.payloads: + in: query + name: payloads + description: If `true`, the response includes term payloads. + schema: + type: boolean + style: form + mtermvectors::query.positions: + in: query + name: positions + description: If `true`, the response includes term positions. + schema: + type: boolean + style: form + mtermvectors::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + mtermvectors::query.realtime: + in: query + name: realtime + description: If true, the request is real-time as opposed to near-real-time. + schema: + type: boolean + style: form + mtermvectors::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + mtermvectors::query.term_statistics: + in: query + name: term_statistics + description: If true, the response includes term frequency and document frequency. + schema: + type: boolean + style: form + mtermvectors::query.version: + in: query + name: version + description: If `true`, returns the document version as part of a hit. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' + style: form + mtermvectors::query.version_type: + in: query + name: version_type + description: Specific version type. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionType' + style: form + put_script::path.context: + in: path + name: context + description: |- + Context in which the script or search template should run. + To prevent errors, the API immediately compiles the script or template in this context. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + put_script::path.id: + in: path + name: id + description: |- + Identifier for the stored script or search template. + Must be unique within the cluster. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + put_script::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + put_script::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + put_script::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + rank_eval::path.index: + in: path + name: index + 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 `*`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + rank_eval::query.allow_no_indices: + in: query + name: allow_no_indices + 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`. + schema: + type: boolean + style: form + rank_eval::query.expand_wildcards: + in: query + name: expand_wildcards + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + rank_eval::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `true`, missing or closed indices are not included in the response. + schema: + type: boolean + style: form + rank_eval::query.search_type: + in: query + name: search_type + description: Search operation type + schema: + type: string + style: form + reindex::query.max_docs: + name: max_docs + in: query + description: 'Maximum number of documents to process (default: all documents).' + schema: + type: integer + description: 'Maximum number of documents to process (default: all documents).' + format: int32 + reindex::query.refresh: + in: query + name: refresh + description: If `true`, the request refreshes affected shards to make this operation visible to search. + schema: + type: boolean + style: form + reindex::query.requests_per_second: + in: query + name: requests_per_second + description: |- + The throttle for this request in sub-requests per second. + Defaults to no throttle. + schema: + type: number + style: form + reindex::query.scroll: + in: query + name: scroll + description: Specifies how long a consistent view of the index should be maintained for scrolled search. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + reindex::query.slices: + in: query + name: slices + description: |- + The number of slices this task should be divided into. + Defaults to 1 slice, meaning the task isn’t sliced into subtasks. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Slices' + style: form + reindex::query.timeout: + in: query + name: timeout + description: Period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + reindex::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' + style: form + reindex::query.wait_for_completion: + in: query + name: wait_for_completion + description: If `true`, the request blocks until the operation is complete. + schema: + type: boolean + style: form + reindex_rethrottle::path.task_id: + in: path + name: task_id + description: Identifier for the task. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + reindex_rethrottle::query.requests_per_second: + in: query + name: requests_per_second + description: The throttle for this request in sub-requests per second. + schema: + type: number + style: form + render_search_template::path.id: + in: path + name: id + description: |- + ID of the search template to render. + If no `source` is specified, this or the `id` request body parameter is required. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + scroll::path.scroll_id: + in: path + name: scroll_id + description: The scroll ID + required: true + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ScrollId' + style: simple + scroll::query.rest_total_hits_as_int: + in: query + name: rest_total_hits_as_int + 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. + schema: + type: boolean + style: form + scroll::query.scroll: + in: query + name: scroll + description: Period to retain the search context for scrolling. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + scroll::query.scroll_id: + in: query + name: scroll_id + description: The scroll ID for scrolled search + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ScrollId' + style: form + search::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases to search. + Supports wildcards (`*`). + To search all data streams and indices, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + search::query._source: + in: query + name: _source + description: >- + Indicates which source fields are returned for matching documents. + + These fields are returned in the `hits._source` property of the search response. + + Valid values are: + + `true` to return the entire document source; + + `false` to not return the document source; + + `` to return the source fields that are specified as a comma-separated list (supports wildcard (`*`) patterns). + schema: + $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam' + style: form + search::query._source_excludes: + in: query + name: _source_excludes + description: >- + 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. + + If the `_source` parameter is `false`, this parameter is ignored. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + search::query._source_includes: + in: query + name: _source_includes + description: |- + 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + search::query.allow_no_indices: + in: query + name: allow_no_indices + 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`. + schema: + type: boolean + style: form + search::query.allow_partial_search_results: + in: query + name: allow_partial_search_results + description: If true, returns partial results if there are shard request timeouts or shard failures. If false, returns + an error with no partial results. + schema: + type: boolean + style: form + search::query.analyze_wildcard: + in: query + name: analyze_wildcard + description: |- + If true, wildcard and prefix queries are analyzed. + This parameter can only be used when the q query string parameter is specified. + schema: + type: boolean + style: form + search::query.analyzer: + in: query + name: analyzer + description: |- + Analyzer to use for the query string. + This parameter can only be used when the q query string parameter is specified. + schema: + type: string + style: form + search::query.batched_reduce_size: + in: query + name: batched_reduce_size + 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. + schema: + type: number + style: form + search::query.ccs_minimize_roundtrips: + in: query + name: ccs_minimize_roundtrips + description: If true, network round-trips between the coordinating node and the remote clusters are minimized when + executing cross-cluster search (CCS) requests. + schema: + type: boolean + style: form + search::query.default_operator: + in: query + name: default_operator + description: |- + The default operator for query string query: AND or OR. + This parameter can only be used when the `q` query string parameter is specified. + schema: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/Operator' + style: form + search::query.df: + in: query + name: df + description: |- + Field to use as default where no field prefix is given in the query string. + This parameter can only be used when the q query string parameter is specified. + schema: + type: string + style: form + search::query.docvalue_fields: + in: query + name: docvalue_fields + description: A comma-separated list of fields to return as the docvalue representation for each hit. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + search::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + search::query.explain: + in: query + name: explain + description: If `true`, returns detailed information about score computation as part of a hit. + schema: + type: boolean + style: form + search::query.from: + in: query + name: from + description: |- + Starting document offset. + Needs to be non-negative. + 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. + schema: + type: number + style: form + search::query.ignore_throttled: + in: query + name: ignore_throttled + description: If `true`, concrete, expanded or aliased indices will be ignored when frozen. + schema: + type: boolean + style: form + search::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + search::query.include_named_queries_score: + name: include_named_queries_score + in: query + description: Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched + query associated with its score (true) or as an array containing the name of the matched queries (false) + schema: + type: boolean + default: false + description: Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched + query associated with its score (true) or as an array containing the name of the matched queries (false) + search::query.lenient: + in: query + name: lenient + description: >- + If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be + ignored. + + This parameter can only be used when the `q` query string parameter is specified. + schema: + type: boolean + style: form + search::query.max_concurrent_shard_requests: + in: query + name: max_concurrent_shard_requests + description: >- + Defines 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. + schema: + type: number + style: form + search::query.pre_filter_shard_size: + in: query + name: pre_filter_shard_size + description: >- + 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 (if date filters are mandatory to match but the shard bounds and the query are disjoint). + + When unspecified, the pre-filter phase is executed if any of these conditions is met: + + the request targets more than 128 shards; + + the request targets one or more read-only index; + + the primary sort of the query targets an indexed field. + schema: + type: number + style: form + search::query.preference: + in: query + name: preference + description: >- + Nodes and shards used for the search. + + By default, Opensearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: + + `_only_local` to run the search only on shards on the local node; + + `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method; + + `_only_nodes:,` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method; + + `_prefer_nodes:,` to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method; + + `_shards:,` to run the search only on the specified shards; + + `` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order. + schema: + type: string + style: form + search::query.q: + in: query + name: q + description: |- + Query in the Lucene query string syntax using query parameter search. + Query parameter searches do not support the full Opensearch Query DSL but are handy for testing. + schema: + type: string + style: form + search::query.request_cache: + in: query + name: request_cache + description: |- + If `true`, the caching of search results is enabled for requests where `size` is `0`. + Defaults to index level settings. + schema: + type: boolean + style: form + search::query.rest_total_hits_as_int: + in: query + name: rest_total_hits_as_int + description: Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. + schema: + type: boolean + style: form + search::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + search::query.scroll: + in: query + name: scroll + description: |- + Period to retain the search context for scrolling. See Scroll search results. + By default, this value cannot exceed `1d` (24 hours). + You can change this limit using the `search.max_keep_alive` cluster-level setting. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + search::query.search_pipeline: + name: search_pipeline + in: query + description: Customizable sequence of processing stages applied to search queries. + schema: + type: string + description: Customizable sequence of processing stages applied to search queries. + search::query.search_type: + in: query + name: search_type + description: How distributed term frequencies are calculated for relevance scoring. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/SearchType' + style: form + search::query.seq_no_primary_term: + in: query + name: seq_no_primary_term + description: If `true`, returns sequence number and primary term of the last modification of each hit. + schema: + type: boolean + style: form + search::query.size: + in: query + name: size + description: |- + Defines 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. + schema: + type: number + style: form + search::query.sort: + in: query + name: sort + description: A comma-separated list of : pairs. + schema: + oneOf: + - type: string + - type: array + items: + type: string + style: form + search::query.stats: + in: query + name: stats + description: Specific `tag` of the request for logging and statistical purposes. + schema: + type: array + items: + type: string + style: form + search::query.stored_fields: + in: query + name: stored_fields + description: |- + A comma-separated 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + search::query.suggest_field: + in: query + name: suggest_field + description: Specifies which field to use for suggestions. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Field' + style: form + search::query.suggest_mode: + in: query + name: suggest_mode + description: >- + Specifies the suggest mode. + + This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/SuggestMode' + style: form + search::query.suggest_size: + in: query + name: suggest_size + description: >- + Number of suggestions to return. + + This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + schema: + type: number + style: form + search::query.suggest_text: + in: query + name: suggest_text + description: >- + The source text for which the suggestions should be returned. + + This parameter can only be used when the `suggest_field` and `suggest_text` query string parameters are specified. + schema: + type: string + style: form + search::query.terminate_after: + in: query + name: terminate_after + description: >- + Maximum number of documents to collect for each shard. + + If a query reaches this limit, Opensearch terminates the query early. + + Opensearch collects documents before sorting. + + Use with caution. + + Opensearch applies this parameter to each shard handling the request. + + When possible, let Opensearch perform early termination automatically. + + Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + + If set to `0` (default), the query does not terminate early. + schema: + type: number + style: form + search::query.timeout: + in: query + name: timeout + description: |- + 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + search::query.track_scores: + in: query + name: track_scores + description: If `true`, calculate and return document scores, even if the scores are not used for sorting. + schema: + type: boolean + style: form + search::query.track_total_hits: + in: query + name: track_total_hits + description: |- + 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. + schema: + $ref: '../schemas/_core.search.yaml#/components/schemas/TrackHits' + style: form + search::query.typed_keys: + in: query + name: typed_keys + description: If `true`, aggregation and suggester names are be prefixed by their respective types in the response. + schema: + type: boolean + style: form + search::query.version: + in: query + name: version + description: If `true`, returns document version as part of a hit. + schema: + type: boolean + style: form + search_shards::path.index: + in: path + name: index + description: Returns the indices and shards that a search request would be executed against. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + search_shards::query.allow_no_indices: + in: query + name: allow_no_indices + 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`. + schema: + type: boolean + style: form + search_shards::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + search_shards::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + search_shards::query.local: + in: query + name: local + description: If `true`, the request retrieves information from the local node only. + schema: + type: boolean + style: form + search_shards::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + search_shards::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + search_template::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, + and aliases to search. Supports wildcards (*). + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + search_template::query.allow_no_indices: + in: query + name: allow_no_indices + 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`. + schema: + type: boolean + style: form + search_template::query.ccs_minimize_roundtrips: + in: query + name: ccs_minimize_roundtrips + description: If `true`, network round-trips are minimized for cross-cluster search requests. + schema: + type: boolean + style: form + search_template::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + search_template::query.explain: + in: query + name: explain + description: If `true`, the response includes additional details about score computation as part of a hit. + schema: + type: boolean + style: form + search_template::query.ignore_throttled: + in: query + name: ignore_throttled + description: If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. + schema: + type: boolean + style: form + search_template::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + search_template::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + search_template::query.profile: + in: query + name: profile + description: If `true`, the query execution is profiled. + schema: + type: boolean + style: form + search_template::query.rest_total_hits_as_int: + in: query + name: rest_total_hits_as_int + description: If true, hits.total are rendered as an integer in the response. + schema: + type: boolean + style: form + search_template::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + search_template::query.scroll: + in: query + name: scroll + description: |- + Specifies how long a consistent view of the index + should be maintained for scrolled search. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + search_template::query.search_type: + in: query + name: search_type + description: The type of the search operation. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/SearchType' + style: form + search_template::query.typed_keys: + in: query + name: typed_keys + description: If `true`, the response prefixes aggregation and suggester names with their respective types. + schema: + type: boolean + style: form + termvectors::path.id: + in: path + name: id + description: Unique identifier of the document. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + termvectors::path.index: + in: path + name: index + description: Name of the index that contains the document. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + termvectors::query.field_statistics: + in: query + name: field_statistics + description: If `true`, the response includes the document count, sum of document frequencies, and sum of total term + frequencies. + schema: + type: boolean + style: form + termvectors::query.fields: + in: query + name: fields + description: >- + Comma-separated list or wildcard expressions of fields to include in the statistics. + + Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + termvectors::query.offsets: + in: query + name: offsets + description: If `true`, the response includes term offsets. + schema: + type: boolean + style: form + termvectors::query.payloads: + in: query + name: payloads + description: If `true`, the response includes term payloads. + schema: + type: boolean + style: form + termvectors::query.positions: + in: query + name: positions + description: If `true`, the response includes term positions. + schema: + type: boolean + style: form + termvectors::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + termvectors::query.realtime: + in: query + name: realtime + description: If true, the request is real-time as opposed to near-real-time. + schema: + type: boolean + style: form + termvectors::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + termvectors::query.term_statistics: + in: query + name: term_statistics + description: If `true`, the response includes term frequency and document frequency. + schema: + type: boolean + style: form + termvectors::query.version: + in: query + name: version + description: If `true`, returns the document version as part of a hit. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' + style: form + termvectors::query.version_type: + in: query + name: version_type + description: Specific version type. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionType' + style: form + update::path.id: + in: path + name: id + description: Document ID + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + update::path.index: + in: path + name: index + description: The name of the index + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + update::query._source: + in: query + name: _source + description: |- + Set to false to disable source retrieval. You can also specify a comma-separated + list of the fields you want to retrieve. + schema: + $ref: '../schemas/_core.search.yaml#/components/schemas/SourceConfigParam' + style: form + update::query._source_excludes: + in: query + name: _source_excludes + description: Specify the source fields you want to exclude. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + update::query._source_includes: + in: query + name: _source_includes + description: Specify the source fields you want to retrieve. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + update::query.if_primary_term: + in: query + name: if_primary_term + description: Only perform the operation if the document has this primary term. + schema: + type: number + style: form + update::query.if_seq_no: + in: query + name: if_seq_no + description: Only perform the operation if the document has this sequence number. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/SequenceNumber' + style: form + update::query.lang: + in: query + name: lang + description: The script language. + schema: + type: string + style: form + update::query.refresh: + in: query + name: refresh + description: |- + If 'true', Opensearch 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Refresh' + style: form + update::query.require_alias: + in: query + name: require_alias + description: If true, the destination must be an index alias. + schema: + type: boolean + style: form + update::query.retry_on_conflict: + in: query + name: retry_on_conflict + description: Specify how many times should the operation be retried when a conflict occurs. + schema: + type: number + style: form + update::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + update::query.timeout: + in: query + name: timeout + description: |- + Period to wait for dynamic mapping updates and active shards. + This guarantees Opensearch waits for at least the timeout before failing. + The actual wait time could be longer, particularly when multiple waits occur. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + update::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + description: |- + 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' + style: form + update_by_query::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases to search. + Supports wildcards (`*`). + To search all data streams or indices, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + update_by_query::query._source: + name: _source + in: query + description: True or false to return the _source field or not, or a list of fields to return. + style: form + schema: + type: array + items: + type: string + description: True or false to return the _source field or not, or a list of fields to return. + explode: true + update_by_query::query._source_excludes: + name: _source_excludes + in: query + description: List of fields to exclude from the returned _source field. + style: form + schema: + type: array + items: + type: string + description: List of fields to exclude from the returned _source field. + explode: true + update_by_query::query._source_includes: + name: _source_includes + in: query + description: List of fields to extract and return from the _source field. + style: form + schema: + type: array + items: + type: string + description: List of fields to extract and return from the _source field. + explode: true + update_by_query::query.allow_no_indices: + in: query + name: allow_no_indices + 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`. + schema: + type: boolean + style: form + update_by_query::query.analyze_wildcard: + in: query + name: analyze_wildcard + description: If `true`, wildcard and prefix queries are analyzed. + schema: + type: boolean + style: form + update_by_query::query.analyzer: + in: query + name: analyzer + description: Analyzer to use for the query string. + schema: + type: string + style: form + update_by_query::query.conflicts: + in: query + name: conflicts + description: 'What to do if update by query hits version conflicts: `abort` or `proceed`.' + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Conflicts' + style: form + update_by_query::query.default_operator: + in: query + name: default_operator + description: 'The default operator for query string query: `AND` or `OR`.' + schema: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/Operator' + style: form + update_by_query::query.df: + in: query + name: df + description: Field to use as default where no field prefix is given in the query string. + schema: + type: string + style: form + update_by_query::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + update_by_query::query.from: + in: query + name: from + description: 'Starting offset (default: 0)' + schema: + type: number + style: form + update_by_query::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + update_by_query::query.lenient: + in: query + name: lenient + description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will + be ignored. + schema: + type: boolean + style: form + update_by_query::query.max_docs: + in: query + name: max_docs + description: |- + Maximum number of documents to process. + Defaults to all documents. + schema: + type: number + style: form + update_by_query::query.pipeline: + in: query + name: pipeline + description: >- + ID of the pipeline to use to preprocess incoming documents. + + If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. + + If a final pipeline is configured it will always run, regardless of the value of this parameter. + schema: + type: string + style: form + update_by_query::query.preference: + in: query + name: preference + description: |- + Specifies the node or shard the operation should be performed on. + Random by default. + schema: + type: string + style: form + update_by_query::query.q: + name: q + in: query + description: Query in the Lucene query string syntax. + schema: + type: string + description: Query in the Lucene query string syntax. + update_by_query::query.refresh: + in: query + name: refresh + description: If `true`, Opensearch refreshes affected shards to make the operation visible to search. + schema: + type: boolean + style: form + update_by_query::query.request_cache: + in: query + name: request_cache + description: If `true`, the request cache is used for this request. + schema: + type: boolean + style: form + update_by_query::query.requests_per_second: + in: query + name: requests_per_second + description: The throttle for this request in sub-requests per second. + schema: + type: number + style: form + update_by_query::query.routing: + in: query + name: routing + description: Custom value used to route operations to a specific shard. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + style: form + update_by_query::query.scroll: + in: query + name: scroll + description: Period to retain the search context for scrolling. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + update_by_query::query.scroll_size: + in: query + name: scroll_size + description: Size of the scroll request that powers the operation. + schema: + type: number + style: form + update_by_query::query.search_timeout: + in: query + name: search_timeout + description: Explicit timeout for each search request. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + update_by_query::query.search_type: + in: query + name: search_type + description: 'The type of the search operation. Available options: `query_then_fetch`, `dfs_query_then_fetch`.' + schema: + $ref: '../schemas/_common.yaml#/components/schemas/SearchType' + style: form + update_by_query::query.size: + name: size + in: query + description: Deprecated, please use `max_docs` instead. + schema: + type: integer + description: Deprecated, please use `max_docs` instead. + format: int32 + update_by_query::query.slices: + in: query + name: slices + description: The number of slices this task should be divided into. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Slices' + style: form + update_by_query::query.sort: + in: query + name: sort + description: A comma-separated list of : pairs. + schema: + type: array + items: + type: string + style: form + update_by_query::query.stats: + in: query + name: stats + description: Specific `tag` of the request for logging and statistical purposes. + schema: + type: array + items: + type: string + style: form + update_by_query::query.terminate_after: + in: query + name: terminate_after + description: >- + Maximum number of documents to collect for each shard. + + If a query reaches this limit, Opensearch terminates the query early. + + Opensearch collects documents before sorting. + + Use with caution. + + Opensearch applies this parameter to each shard handling the request. + + When possible, let Opensearch perform early termination automatically. + + Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + schema: + type: number + style: form + update_by_query::query.timeout: + in: query + name: timeout + description: 'Period each update request waits for the following operations: dynamic mapping updates, waiting for active + shards.' + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + update_by_query::query.version: + in: query + name: version + description: If `true`, returns the document version as part of a hit. + schema: + type: boolean + style: form + update_by_query::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' + style: form + update_by_query::query.wait_for_completion: + in: query + name: wait_for_completion + description: If `true`, the request blocks until the operation is complete. + schema: + type: boolean + style: form + update_by_query_rethrottle::path.task_id: + in: path + name: task_id + description: The ID for the task. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + update_by_query_rethrottle::query.requests_per_second: + in: query + name: requests_per_second + description: The throttle for this request in sub-requests per second. + schema: + type: number + style: form diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml new file mode 100644 index 00000000..f899ec2a --- /dev/null +++ b/spec/namespaces/cat.yaml @@ -0,0 +1,2798 @@ +openapi: 3.1.0 +info: + title: OpenSearch Cat API + description: OpenSearch Cat API + version: 1.0.0 +paths: + /_cat: + get: + operationId: cat.help.0 + x-operation-group: cat.help + x-version-added: '1.0' + description: Returns help for the Cat APIs. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/index/ + parameters: + - $ref: '#/components/parameters/cat.help::query.help' + - $ref: '#/components/parameters/cat.help::query.s' + responses: + '200': + $ref: '#/components/responses/cat.help@200' + /_cat/aliases: + get: + operationId: cat.aliases.0 + x-operation-group: cat.aliases + x-version-added: '1.0' + description: Shows information about currently configured aliases to indices including filter and routing infos. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/ + parameters: + - $ref: '#/components/parameters/cat.aliases::query.format' + - $ref: '#/components/parameters/cat.aliases::query.local' + - $ref: '#/components/parameters/cat.aliases::query.h' + - $ref: '#/components/parameters/cat.aliases::query.help' + - $ref: '#/components/parameters/cat.aliases::query.s' + - $ref: '#/components/parameters/cat.aliases::query.v' + - $ref: '#/components/parameters/cat.aliases::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/cat.aliases@200' + /_cat/aliases/{name}: + get: + operationId: cat.aliases.1 + x-operation-group: cat.aliases + x-version-added: '1.0' + description: Shows information about currently configured aliases to indices including filter and routing infos. + parameters: + - $ref: '#/components/parameters/cat.aliases::path.name' + - $ref: '#/components/parameters/cat.aliases::query.format' + - $ref: '#/components/parameters/cat.aliases::query.local' + - $ref: '#/components/parameters/cat.aliases::query.h' + - $ref: '#/components/parameters/cat.aliases::query.help' + - $ref: '#/components/parameters/cat.aliases::query.s' + - $ref: '#/components/parameters/cat.aliases::query.v' + - $ref: '#/components/parameters/cat.aliases::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/cat.aliases@200' + /_cat/allocation: + get: + operationId: cat.allocation.0 + x-operation-group: cat.allocation + x-version-added: '1.0' + description: Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/ + parameters: + - $ref: '#/components/parameters/cat.allocation::query.format' + - $ref: '#/components/parameters/cat.allocation::query.bytes' + - $ref: '#/components/parameters/cat.allocation::query.local' + - $ref: '#/components/parameters/cat.allocation::query.master_timeout' + - $ref: '#/components/parameters/cat.allocation::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.allocation::query.h' + - $ref: '#/components/parameters/cat.allocation::query.help' + - $ref: '#/components/parameters/cat.allocation::query.s' + - $ref: '#/components/parameters/cat.allocation::query.v' + responses: + '200': + $ref: '#/components/responses/cat.allocation@200' + /_cat/allocation/{node_id}: + get: + operationId: cat.allocation.1 + x-operation-group: cat.allocation + x-version-added: '1.0' + description: Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. + parameters: + - $ref: '#/components/parameters/cat.allocation::path.node_id' + - $ref: '#/components/parameters/cat.allocation::query.format' + - $ref: '#/components/parameters/cat.allocation::query.bytes' + - $ref: '#/components/parameters/cat.allocation::query.local' + - $ref: '#/components/parameters/cat.allocation::query.master_timeout' + - $ref: '#/components/parameters/cat.allocation::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.allocation::query.h' + - $ref: '#/components/parameters/cat.allocation::query.help' + - $ref: '#/components/parameters/cat.allocation::query.s' + - $ref: '#/components/parameters/cat.allocation::query.v' + responses: + '200': + $ref: '#/components/responses/cat.allocation@200' + /_cat/cluster_manager: + get: + operationId: cat.cluster_manager.0 + x-operation-group: cat.cluster_manager + x-version-added: '2.0' + description: Returns information about the cluster-manager node. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ + parameters: + - $ref: '#/components/parameters/cat.cluster_manager::query.format' + - $ref: '#/components/parameters/cat.cluster_manager::query.local' + - $ref: '#/components/parameters/cat.cluster_manager::query.master_timeout' + - $ref: '#/components/parameters/cat.cluster_manager::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.cluster_manager::query.h' + - $ref: '#/components/parameters/cat.cluster_manager::query.help' + - $ref: '#/components/parameters/cat.cluster_manager::query.s' + - $ref: '#/components/parameters/cat.cluster_manager::query.v' + responses: + '200': + $ref: '#/components/responses/cat.cluster_manager@200' + /_cat/count: + get: + operationId: cat.count.0 + x-operation-group: cat.count + x-version-added: '1.0' + description: Provides quick access to the document count of the entire cluster, or individual indices. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-count/ + parameters: + - $ref: '#/components/parameters/cat.count::query.format' + - $ref: '#/components/parameters/cat.count::query.h' + - $ref: '#/components/parameters/cat.count::query.help' + - $ref: '#/components/parameters/cat.count::query.s' + - $ref: '#/components/parameters/cat.count::query.v' + responses: + '200': + $ref: '#/components/responses/cat.count@200' + /_cat/count/{index}: + get: + operationId: cat.count.1 + x-operation-group: cat.count + x-version-added: '1.0' + description: Provides quick access to the document count of the entire cluster, or individual indices. + parameters: + - $ref: '#/components/parameters/cat.count::path.index' + - $ref: '#/components/parameters/cat.count::query.format' + - $ref: '#/components/parameters/cat.count::query.h' + - $ref: '#/components/parameters/cat.count::query.help' + - $ref: '#/components/parameters/cat.count::query.s' + - $ref: '#/components/parameters/cat.count::query.v' + responses: + '200': + $ref: '#/components/responses/cat.count@200' + /_cat/fielddata: + get: + operationId: cat.fielddata.0 + x-operation-group: cat.fielddata + x-version-added: '1.0' + description: Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/ + parameters: + - $ref: '#/components/parameters/cat.fielddata::query.format' + - $ref: '#/components/parameters/cat.fielddata::query.bytes' + - $ref: '#/components/parameters/cat.fielddata::query.h' + - $ref: '#/components/parameters/cat.fielddata::query.help' + - $ref: '#/components/parameters/cat.fielddata::query.s' + - $ref: '#/components/parameters/cat.fielddata::query.v' + - $ref: '#/components/parameters/cat.fielddata::query.fields' + responses: + '200': + $ref: '#/components/responses/cat.fielddata@200' + /_cat/fielddata/{fields}: + get: + operationId: cat.fielddata.1 + x-operation-group: cat.fielddata + x-version-added: '1.0' + description: Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + parameters: + - $ref: '#/components/parameters/cat.fielddata::path.fields' + - $ref: '#/components/parameters/cat.fielddata::query.format' + - $ref: '#/components/parameters/cat.fielddata::query.bytes' + - $ref: '#/components/parameters/cat.fielddata::query.h' + - $ref: '#/components/parameters/cat.fielddata::query.help' + - $ref: '#/components/parameters/cat.fielddata::query.s' + - $ref: '#/components/parameters/cat.fielddata::query.v' + - $ref: '#/components/parameters/cat.fielddata::query.fields' + responses: + '200': + $ref: '#/components/responses/cat.fielddata@200' + /_cat/health: + get: + operationId: cat.health.0 + x-operation-group: cat.health + x-version-added: '1.0' + description: Returns a concise representation of the cluster health. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-health/ + parameters: + - $ref: '#/components/parameters/cat.health::query.format' + - $ref: '#/components/parameters/cat.health::query.h' + - $ref: '#/components/parameters/cat.health::query.help' + - $ref: '#/components/parameters/cat.health::query.s' + - $ref: '#/components/parameters/cat.health::query.time' + - $ref: '#/components/parameters/cat.health::query.ts' + - $ref: '#/components/parameters/cat.health::query.v' + responses: + '200': + $ref: '#/components/responses/cat.health@200' + /_cat/indices: + get: + operationId: cat.indices.0 + x-operation-group: cat.indices + x-version-added: '1.0' + description: 'Returns information about indices: number of primaries and replicas, document counts, disk size, ...' + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-indices/ + parameters: + - $ref: '#/components/parameters/cat.indices::query.format' + - $ref: '#/components/parameters/cat.indices::query.bytes' + - $ref: '#/components/parameters/cat.indices::query.local' + - $ref: '#/components/parameters/cat.indices::query.master_timeout' + - $ref: '#/components/parameters/cat.indices::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.indices::query.h' + - $ref: '#/components/parameters/cat.indices::query.health' + - $ref: '#/components/parameters/cat.indices::query.help' + - $ref: '#/components/parameters/cat.indices::query.pri' + - $ref: '#/components/parameters/cat.indices::query.s' + - $ref: '#/components/parameters/cat.indices::query.time' + - $ref: '#/components/parameters/cat.indices::query.v' + - $ref: '#/components/parameters/cat.indices::query.include_unloaded_segments' + - $ref: '#/components/parameters/cat.indices::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/cat.indices@200' + /_cat/indices/{index}: + get: + operationId: cat.indices.1 + x-operation-group: cat.indices + x-version-added: '1.0' + description: 'Returns information about indices: number of primaries and replicas, document counts, disk size, ...' + parameters: + - $ref: '#/components/parameters/cat.indices::path.index' + - $ref: '#/components/parameters/cat.indices::query.format' + - $ref: '#/components/parameters/cat.indices::query.bytes' + - $ref: '#/components/parameters/cat.indices::query.local' + - $ref: '#/components/parameters/cat.indices::query.master_timeout' + - $ref: '#/components/parameters/cat.indices::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.indices::query.h' + - $ref: '#/components/parameters/cat.indices::query.health' + - $ref: '#/components/parameters/cat.indices::query.help' + - $ref: '#/components/parameters/cat.indices::query.pri' + - $ref: '#/components/parameters/cat.indices::query.s' + - $ref: '#/components/parameters/cat.indices::query.time' + - $ref: '#/components/parameters/cat.indices::query.v' + - $ref: '#/components/parameters/cat.indices::query.include_unloaded_segments' + - $ref: '#/components/parameters/cat.indices::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/cat.indices@200' + /_cat/master: + get: + operationId: cat.master.0 + x-operation-group: cat.master + deprecated: true + x-deprecation-message: To promote inclusive language, please use '/_cat/cluster_manager' instead. + x-version-added: '1.0' + x-version-deprecated: '2.0' + description: Returns information about the cluster-manager node. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/ + parameters: + - $ref: '#/components/parameters/cat.master::query.format' + - $ref: '#/components/parameters/cat.master::query.local' + - $ref: '#/components/parameters/cat.master::query.master_timeout' + - $ref: '#/components/parameters/cat.master::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.master::query.h' + - $ref: '#/components/parameters/cat.master::query.help' + - $ref: '#/components/parameters/cat.master::query.s' + - $ref: '#/components/parameters/cat.master::query.v' + responses: + '200': + $ref: '#/components/responses/cat.master@200' + /_cat/nodeattrs: + get: + operationId: cat.nodeattrs.0 + x-operation-group: cat.nodeattrs + x-version-added: '1.0' + description: Returns information about custom node attributes. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/ + parameters: + - $ref: '#/components/parameters/cat.nodeattrs::query.format' + - $ref: '#/components/parameters/cat.nodeattrs::query.local' + - $ref: '#/components/parameters/cat.nodeattrs::query.master_timeout' + - $ref: '#/components/parameters/cat.nodeattrs::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.nodeattrs::query.h' + - $ref: '#/components/parameters/cat.nodeattrs::query.help' + - $ref: '#/components/parameters/cat.nodeattrs::query.s' + - $ref: '#/components/parameters/cat.nodeattrs::query.v' + responses: + '200': + $ref: '#/components/responses/cat.nodeattrs@200' + /_cat/nodes: + get: + operationId: cat.nodes.0 + x-operation-group: cat.nodes + x-version-added: '1.0' + description: Returns basic statistics about performance of cluster nodes. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-nodes/ + parameters: + - $ref: '#/components/parameters/cat.nodes::query.bytes' + - $ref: '#/components/parameters/cat.nodes::query.format' + - $ref: '#/components/parameters/cat.nodes::query.full_id' + - $ref: '#/components/parameters/cat.nodes::query.local' + - $ref: '#/components/parameters/cat.nodes::query.master_timeout' + - $ref: '#/components/parameters/cat.nodes::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.nodes::query.h' + - $ref: '#/components/parameters/cat.nodes::query.help' + - $ref: '#/components/parameters/cat.nodes::query.s' + - $ref: '#/components/parameters/cat.nodes::query.time' + - $ref: '#/components/parameters/cat.nodes::query.v' + responses: + '200': + $ref: '#/components/responses/cat.nodes@200' + /_cat/pending_tasks: + get: + operationId: cat.pending_tasks.0 + x-operation-group: cat.pending_tasks + x-version-added: '1.0' + description: Returns a concise representation of the cluster pending tasks. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-pending-tasks/ + parameters: + - $ref: '#/components/parameters/cat.pending_tasks::query.format' + - $ref: '#/components/parameters/cat.pending_tasks::query.local' + - $ref: '#/components/parameters/cat.pending_tasks::query.master_timeout' + - $ref: '#/components/parameters/cat.pending_tasks::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.pending_tasks::query.h' + - $ref: '#/components/parameters/cat.pending_tasks::query.help' + - $ref: '#/components/parameters/cat.pending_tasks::query.s' + - $ref: '#/components/parameters/cat.pending_tasks::query.time' + - $ref: '#/components/parameters/cat.pending_tasks::query.v' + responses: + '200': + $ref: '#/components/responses/cat.pending_tasks@200' + /_cat/pit_segments: + get: + operationId: cat.pit_segments.0 + x-operation-group: cat.pit_segments + x-version-added: '2.4' + description: List segments for one or several PITs. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ + parameters: + - $ref: '#/components/parameters/cat.pit_segments::query.format' + - $ref: '#/components/parameters/cat.pit_segments::query.h' + - $ref: '#/components/parameters/cat.pit_segments::query.help' + - $ref: '#/components/parameters/cat.pit_segments::query.s' + - $ref: '#/components/parameters/cat.pit_segments::query.v' + - $ref: '#/components/parameters/cat.pit_segments::query.bytes' + requestBody: + $ref: '#/components/requestBodies/cat.pit_segments' + responses: + '200': + $ref: '#/components/responses/cat.pit_segments@200' + /_cat/pit_segments/_all: + get: + operationId: cat.all_pit_segments.0 + x-operation-group: cat.all_pit_segments + x-version-added: '2.4' + description: Lists all active point-in-time segments. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/point-in-time-api/ + parameters: + - $ref: '#/components/parameters/cat.all_pit_segments::query.format' + - $ref: '#/components/parameters/cat.all_pit_segments::query.h' + - $ref: '#/components/parameters/cat.all_pit_segments::query.help' + - $ref: '#/components/parameters/cat.all_pit_segments::query.s' + - $ref: '#/components/parameters/cat.all_pit_segments::query.v' + - $ref: '#/components/parameters/cat.all_pit_segments::query.bytes' + responses: + '200': + $ref: '#/components/responses/cat.all_pit_segments@200' + /_cat/plugins: + get: + operationId: cat.plugins.0 + x-operation-group: cat.plugins + x-version-added: '1.0' + description: Returns information about installed plugins across nodes node. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ + parameters: + - $ref: '#/components/parameters/cat.plugins::query.format' + - $ref: '#/components/parameters/cat.plugins::query.local' + - $ref: '#/components/parameters/cat.plugins::query.master_timeout' + - $ref: '#/components/parameters/cat.plugins::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.plugins::query.h' + - $ref: '#/components/parameters/cat.plugins::query.help' + - $ref: '#/components/parameters/cat.plugins::query.s' + - $ref: '#/components/parameters/cat.plugins::query.v' + responses: + '200': + $ref: '#/components/responses/cat.plugins@200' + /_cat/recovery: + get: + operationId: cat.recovery.0 + x-operation-group: cat.recovery + x-version-added: '1.0' + description: Returns information about index shard recoveries, both on-going completed. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/ + parameters: + - $ref: '#/components/parameters/cat.recovery::query.format' + - $ref: '#/components/parameters/cat.recovery::query.active_only' + - $ref: '#/components/parameters/cat.recovery::query.bytes' + - $ref: '#/components/parameters/cat.recovery::query.detailed' + - $ref: '#/components/parameters/cat.recovery::query.h' + - $ref: '#/components/parameters/cat.recovery::query.help' + - $ref: '#/components/parameters/cat.recovery::query.index' + - $ref: '#/components/parameters/cat.recovery::query.s' + - $ref: '#/components/parameters/cat.recovery::query.time' + - $ref: '#/components/parameters/cat.recovery::query.v' + responses: + '200': + $ref: '#/components/responses/cat.recovery@200' + /_cat/recovery/{index}: + get: + operationId: cat.recovery.1 + x-operation-group: cat.recovery + x-version-added: '1.0' + description: Returns information about index shard recoveries, both on-going completed. + parameters: + - $ref: '#/components/parameters/cat.recovery::path.index' + - $ref: '#/components/parameters/cat.recovery::query.format' + - $ref: '#/components/parameters/cat.recovery::query.active_only' + - $ref: '#/components/parameters/cat.recovery::query.bytes' + - $ref: '#/components/parameters/cat.recovery::query.detailed' + - $ref: '#/components/parameters/cat.recovery::query.h' + - $ref: '#/components/parameters/cat.recovery::query.help' + - $ref: '#/components/parameters/cat.recovery::query.index' + - $ref: '#/components/parameters/cat.recovery::query.s' + - $ref: '#/components/parameters/cat.recovery::query.time' + - $ref: '#/components/parameters/cat.recovery::query.v' + responses: + '200': + $ref: '#/components/responses/cat.recovery@200' + /_cat/repositories: + get: + operationId: cat.repositories.0 + x-operation-group: cat.repositories + x-version-added: '1.0' + description: Returns information about snapshot repositories registered in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-repositories/ + parameters: + - $ref: '#/components/parameters/cat.repositories::query.format' + - $ref: '#/components/parameters/cat.repositories::query.local' + - $ref: '#/components/parameters/cat.repositories::query.master_timeout' + - $ref: '#/components/parameters/cat.repositories::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.repositories::query.h' + - $ref: '#/components/parameters/cat.repositories::query.help' + - $ref: '#/components/parameters/cat.repositories::query.s' + - $ref: '#/components/parameters/cat.repositories::query.v' + responses: + '200': + $ref: '#/components/responses/cat.repositories@200' + /_cat/segment_replication: + get: + operationId: cat.segment_replication.0 + x-operation-group: cat.segment_replication + x-version-added: 2.6.0 + description: Returns information about both on-going and latest completed Segment Replication events. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/ + parameters: + - $ref: '#/components/parameters/cat.segment_replication::query.format' + - $ref: '#/components/parameters/cat.segment_replication::query.h' + - $ref: '#/components/parameters/cat.segment_replication::query.help' + - $ref: '#/components/parameters/cat.segment_replication::query.s' + - $ref: '#/components/parameters/cat.segment_replication::query.v' + - $ref: '#/components/parameters/cat.segment_replication::query.allow_no_indices' + - $ref: '#/components/parameters/cat.segment_replication::query.expand_wildcards' + - $ref: '#/components/parameters/cat.segment_replication::query.ignore_throttled' + - $ref: '#/components/parameters/cat.segment_replication::query.ignore_unavailable' + - $ref: '#/components/parameters/cat.segment_replication::query.active_only' + - $ref: '#/components/parameters/cat.segment_replication::query.completed_only' + - $ref: '#/components/parameters/cat.segment_replication::query.bytes' + - $ref: '#/components/parameters/cat.segment_replication::query.detailed' + - $ref: '#/components/parameters/cat.segment_replication::query.shards' + - $ref: '#/components/parameters/cat.segment_replication::query.index' + - $ref: '#/components/parameters/cat.segment_replication::query.time' + - $ref: '#/components/parameters/cat.segment_replication::query.timeout' + responses: + '200': + $ref: '#/components/responses/cat.segment_replication@200' + /_cat/segment_replication/{index}: + get: + operationId: cat.segment_replication.1 + x-operation-group: cat.segment_replication + x-version-added: 2.6.0 + description: Returns information about both on-going and latest completed Segment Replication events. + parameters: + - $ref: '#/components/parameters/cat.segment_replication::path.index' + - $ref: '#/components/parameters/cat.segment_replication::query.format' + - $ref: '#/components/parameters/cat.segment_replication::query.h' + - $ref: '#/components/parameters/cat.segment_replication::query.help' + - $ref: '#/components/parameters/cat.segment_replication::query.s' + - $ref: '#/components/parameters/cat.segment_replication::query.v' + - $ref: '#/components/parameters/cat.segment_replication::query.allow_no_indices' + - $ref: '#/components/parameters/cat.segment_replication::query.expand_wildcards' + - $ref: '#/components/parameters/cat.segment_replication::query.ignore_throttled' + - $ref: '#/components/parameters/cat.segment_replication::query.ignore_unavailable' + - $ref: '#/components/parameters/cat.segment_replication::query.active_only' + - $ref: '#/components/parameters/cat.segment_replication::query.completed_only' + - $ref: '#/components/parameters/cat.segment_replication::query.bytes' + - $ref: '#/components/parameters/cat.segment_replication::query.detailed' + - $ref: '#/components/parameters/cat.segment_replication::query.shards' + - $ref: '#/components/parameters/cat.segment_replication::query.index' + - $ref: '#/components/parameters/cat.segment_replication::query.time' + - $ref: '#/components/parameters/cat.segment_replication::query.timeout' + responses: + '200': + $ref: '#/components/responses/cat.segment_replication@200' + /_cat/segments: + get: + operationId: cat.segments.0 + x-operation-group: cat.segments + x-version-added: '1.0' + description: Provides low-level information about the segments in the shards of an index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-segments/ + parameters: + - $ref: '#/components/parameters/cat.segments::query.format' + - $ref: '#/components/parameters/cat.segments::query.bytes' + - $ref: '#/components/parameters/cat.segments::query.master_timeout' + - $ref: '#/components/parameters/cat.segments::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.segments::query.h' + - $ref: '#/components/parameters/cat.segments::query.help' + - $ref: '#/components/parameters/cat.segments::query.s' + - $ref: '#/components/parameters/cat.segments::query.v' + responses: + '200': + $ref: '#/components/responses/cat.segments@200' + /_cat/segments/{index}: + get: + operationId: cat.segments.1 + x-operation-group: cat.segments + x-version-added: '1.0' + description: Provides low-level information about the segments in the shards of an index. + parameters: + - $ref: '#/components/parameters/cat.segments::path.index' + - $ref: '#/components/parameters/cat.segments::query.format' + - $ref: '#/components/parameters/cat.segments::query.bytes' + - $ref: '#/components/parameters/cat.segments::query.master_timeout' + - $ref: '#/components/parameters/cat.segments::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.segments::query.h' + - $ref: '#/components/parameters/cat.segments::query.help' + - $ref: '#/components/parameters/cat.segments::query.s' + - $ref: '#/components/parameters/cat.segments::query.v' + responses: + '200': + $ref: '#/components/responses/cat.segments@200' + /_cat/shards: + get: + operationId: cat.shards.0 + x-operation-group: cat.shards + x-version-added: '1.0' + description: Provides a detailed view of shard allocation on nodes. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-shards/ + parameters: + - $ref: '#/components/parameters/cat.shards::query.format' + - $ref: '#/components/parameters/cat.shards::query.bytes' + - $ref: '#/components/parameters/cat.shards::query.local' + - $ref: '#/components/parameters/cat.shards::query.master_timeout' + - $ref: '#/components/parameters/cat.shards::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.shards::query.h' + - $ref: '#/components/parameters/cat.shards::query.help' + - $ref: '#/components/parameters/cat.shards::query.s' + - $ref: '#/components/parameters/cat.shards::query.time' + - $ref: '#/components/parameters/cat.shards::query.v' + responses: + '200': + $ref: '#/components/responses/cat.shards@200' + /_cat/shards/{index}: + get: + operationId: cat.shards.1 + x-operation-group: cat.shards + x-version-added: '1.0' + description: Provides a detailed view of shard allocation on nodes. + parameters: + - $ref: '#/components/parameters/cat.shards::path.index' + - $ref: '#/components/parameters/cat.shards::query.format' + - $ref: '#/components/parameters/cat.shards::query.bytes' + - $ref: '#/components/parameters/cat.shards::query.local' + - $ref: '#/components/parameters/cat.shards::query.master_timeout' + - $ref: '#/components/parameters/cat.shards::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.shards::query.h' + - $ref: '#/components/parameters/cat.shards::query.help' + - $ref: '#/components/parameters/cat.shards::query.s' + - $ref: '#/components/parameters/cat.shards::query.time' + - $ref: '#/components/parameters/cat.shards::query.v' + responses: + '200': + $ref: '#/components/responses/cat.shards@200' + /_cat/snapshots: + get: + operationId: cat.snapshots.0 + x-operation-group: cat.snapshots + x-version-added: '1.0' + description: Returns all snapshots in a specific repository. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-snapshots/ + parameters: + - $ref: '#/components/parameters/cat.snapshots::query.format' + - $ref: '#/components/parameters/cat.snapshots::query.ignore_unavailable' + - $ref: '#/components/parameters/cat.snapshots::query.master_timeout' + - $ref: '#/components/parameters/cat.snapshots::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.snapshots::query.h' + - $ref: '#/components/parameters/cat.snapshots::query.help' + - $ref: '#/components/parameters/cat.snapshots::query.s' + - $ref: '#/components/parameters/cat.snapshots::query.time' + - $ref: '#/components/parameters/cat.snapshots::query.v' + responses: + '200': + $ref: '#/components/responses/cat.snapshots@200' + /_cat/snapshots/{repository}: + get: + operationId: cat.snapshots.1 + x-operation-group: cat.snapshots + x-version-added: '1.0' + description: Returns all snapshots in a specific repository. + parameters: + - $ref: '#/components/parameters/cat.snapshots::path.repository' + - $ref: '#/components/parameters/cat.snapshots::query.format' + - $ref: '#/components/parameters/cat.snapshots::query.ignore_unavailable' + - $ref: '#/components/parameters/cat.snapshots::query.master_timeout' + - $ref: '#/components/parameters/cat.snapshots::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.snapshots::query.h' + - $ref: '#/components/parameters/cat.snapshots::query.help' + - $ref: '#/components/parameters/cat.snapshots::query.s' + - $ref: '#/components/parameters/cat.snapshots::query.time' + - $ref: '#/components/parameters/cat.snapshots::query.v' + responses: + '200': + $ref: '#/components/responses/cat.snapshots@200' + /_cat/tasks: + get: + operationId: cat.tasks.0 + x-operation-group: cat.tasks + x-version-added: '1.0' + description: Returns information about the tasks currently executing on one or more nodes in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/ + parameters: + - $ref: '#/components/parameters/cat.tasks::query.format' + - $ref: '#/components/parameters/cat.tasks::query.nodes' + - $ref: '#/components/parameters/cat.tasks::query.actions' + - $ref: '#/components/parameters/cat.tasks::query.detailed' + - $ref: '#/components/parameters/cat.tasks::query.parent_task_id' + - $ref: '#/components/parameters/cat.tasks::query.h' + - $ref: '#/components/parameters/cat.tasks::query.help' + - $ref: '#/components/parameters/cat.tasks::query.s' + - $ref: '#/components/parameters/cat.tasks::query.time' + - $ref: '#/components/parameters/cat.tasks::query.v' + responses: + '200': + $ref: '#/components/responses/cat.tasks@200' + /_cat/templates: + get: + operationId: cat.templates.0 + x-operation-group: cat.templates + x-version-added: '1.0' + description: Returns information about existing templates. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-templates/ + parameters: + - $ref: '#/components/parameters/cat.templates::query.format' + - $ref: '#/components/parameters/cat.templates::query.local' + - $ref: '#/components/parameters/cat.templates::query.master_timeout' + - $ref: '#/components/parameters/cat.templates::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.templates::query.h' + - $ref: '#/components/parameters/cat.templates::query.help' + - $ref: '#/components/parameters/cat.templates::query.s' + - $ref: '#/components/parameters/cat.templates::query.v' + responses: + '200': + $ref: '#/components/responses/cat.templates@200' + /_cat/templates/{name}: + get: + operationId: cat.templates.1 + x-operation-group: cat.templates + x-version-added: '1.0' + description: Returns information about existing templates. + parameters: + - $ref: '#/components/parameters/cat.templates::path.name' + - $ref: '#/components/parameters/cat.templates::query.format' + - $ref: '#/components/parameters/cat.templates::query.local' + - $ref: '#/components/parameters/cat.templates::query.master_timeout' + - $ref: '#/components/parameters/cat.templates::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.templates::query.h' + - $ref: '#/components/parameters/cat.templates::query.help' + - $ref: '#/components/parameters/cat.templates::query.s' + - $ref: '#/components/parameters/cat.templates::query.v' + responses: + '200': + $ref: '#/components/responses/cat.templates@200' + /_cat/thread_pool: + get: + operationId: cat.thread_pool.0 + x-operation-group: cat.thread_pool + x-version-added: '1.0' + description: |- + Returns cluster-wide thread pool statistics per node. + By default the active, queue and rejected statistics are returned for all thread pools. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cat/cat-thread-pool/ + parameters: + - $ref: '#/components/parameters/cat.thread_pool::query.format' + - $ref: '#/components/parameters/cat.thread_pool::query.size' + - $ref: '#/components/parameters/cat.thread_pool::query.local' + - $ref: '#/components/parameters/cat.thread_pool::query.master_timeout' + - $ref: '#/components/parameters/cat.thread_pool::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.thread_pool::query.h' + - $ref: '#/components/parameters/cat.thread_pool::query.help' + - $ref: '#/components/parameters/cat.thread_pool::query.s' + - $ref: '#/components/parameters/cat.thread_pool::query.v' + responses: + '200': + $ref: '#/components/responses/cat.thread_pool@200' + /_cat/thread_pool/{thread_pool_patterns}: + get: + operationId: cat.thread_pool.1 + x-operation-group: cat.thread_pool + x-version-added: '1.0' + description: |- + Returns cluster-wide thread pool statistics per node. + By default the active, queue and rejected statistics are returned for all thread pools. + parameters: + - $ref: '#/components/parameters/cat.thread_pool::path.thread_pool_patterns' + - $ref: '#/components/parameters/cat.thread_pool::query.format' + - $ref: '#/components/parameters/cat.thread_pool::query.size' + - $ref: '#/components/parameters/cat.thread_pool::query.local' + - $ref: '#/components/parameters/cat.thread_pool::query.master_timeout' + - $ref: '#/components/parameters/cat.thread_pool::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cat.thread_pool::query.h' + - $ref: '#/components/parameters/cat.thread_pool::query.help' + - $ref: '#/components/parameters/cat.thread_pool::query.s' + - $ref: '#/components/parameters/cat.thread_pool::query.v' + responses: + '200': + $ref: '#/components/responses/cat.thread_pool@200' +components: + requestBodies: + cat.pit_segments: + content: + application/json: + schema: + type: object + properties: + pit_id: + type: array + items: + type: string + required: + - pit_id + responses: + cat.aliases@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.aliases.yaml#/components/schemas/AliasesRecord' + cat.all_pit_segments@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat._common.yaml#/components/schemas/CatPitSegmentsRecord' + cat.allocation@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.allocation.yaml#/components/schemas/AllocationRecord' + cat.cluster_manager@200: + description: '' + cat.count@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.count.yaml#/components/schemas/CountRecord' + cat.fielddata@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.fielddata.yaml#/components/schemas/FielddataRecord' + cat.health@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.health.yaml#/components/schemas/HealthRecord' + cat.help@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.help.yaml#/components/schemas/HelpRecord' + cat.indices@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.indices.yaml#/components/schemas/IndicesRecord' + cat.master@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.master.yaml#/components/schemas/MasterRecord' + cat.nodeattrs@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.nodeattrs.yaml#/components/schemas/NodeAttributesRecord' + cat.nodes@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.nodes.yaml#/components/schemas/NodesRecord' + cat.pending_tasks@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.pending_tasks.yaml#/components/schemas/PendingTasksRecord' + cat.pit_segments@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat._common.yaml#/components/schemas/CatPitSegmentsRecord' + cat.plugins@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.plugins.yaml#/components/schemas/PluginsRecord' + cat.recovery@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.recovery.yaml#/components/schemas/RecoveryRecord' + cat.repositories@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.repositories.yaml#/components/schemas/RepositoriesRecord' + cat.segment_replication@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat._common.yaml#/components/schemas/CatSegmentReplicationRecord' + cat.segments@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.segments.yaml#/components/schemas/SegmentsRecord' + cat.shards@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.shards.yaml#/components/schemas/ShardsRecord' + cat.snapshots@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.snapshots.yaml#/components/schemas/SnapshotsRecord' + cat.tasks@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.tasks.yaml#/components/schemas/TasksRecord' + cat.templates@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.templates.yaml#/components/schemas/TemplatesRecord' + cat.thread_pool@200: + description: '' + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/cat.thread_pool.yaml#/components/schemas/ThreadPoolRecord' + parameters: + cat.aliases::path.name: + in: path + name: name + description: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit + this parameter or use `*` or `_all`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + cat.aliases::query.expand_wildcards: + in: query + name: expand_wildcards + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + cat.aliases::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.aliases::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.aliases::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.aliases::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.aliases::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.aliases::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.all_pit_segments::query.bytes: + name: bytes + in: query + description: The unit in which to display byte values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Bytes' + cat.all_pit_segments::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.all_pit_segments::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.all_pit_segments::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.all_pit_segments::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.all_pit_segments::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.allocation::path.node_id: + in: path + name: node_id + description: Comma-separated list of node identifiers or names used to limit the returned information. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/NodeIds' + style: simple + cat.allocation::query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Bytes' + style: form + cat.allocation::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cat.allocation::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.allocation::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.allocation::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.allocation::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.allocation::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.allocation::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.allocation::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.cluster_manager::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cat.cluster_manager::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.cluster_manager::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.cluster_manager::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.cluster_manager::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.cluster_manager::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.cluster_manager::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.cluster_manager::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.count::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + cat.count::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.count::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.count::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.count::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.count::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.fielddata::path.fields: + in: path + name: fields + description: |- + Comma-separated list of fields used to limit returned information. + To retrieve all fields, omit this parameter. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: simple + cat.fielddata::query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Bytes' + style: form + cat.fielddata::query.fields: + in: query + name: fields + description: Comma-separated list of fields used to limit returned information. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + cat.fielddata::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.fielddata::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.fielddata::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.fielddata::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.fielddata::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.health::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.health::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.health::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.health::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.health::query.time: + in: query + name: time + description: The unit used to display time values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' + style: form + cat.health::query.ts: + in: query + name: ts + description: If true, returns `HH:MM:SS` and Unix epoch timestamps. + schema: + type: boolean + style: form + cat.health::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.help::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.help::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.indices::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + cat.indices::query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Bytes' + style: form + cat.indices::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cat.indices::query.expand_wildcards: + in: query + name: expand_wildcards + description: The type of index that wildcard patterns can match. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + cat.indices::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.indices::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.indices::query.health: + in: query + name: health + description: The health status used to limit returned indices. By default, the response includes indices of any health status. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/HealthStatus' + style: form + cat.indices::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.indices::query.include_unloaded_segments: + in: query + name: include_unloaded_segments + description: If true, the response includes information from segments that are not loaded into memory. + schema: + type: boolean + style: form + cat.indices::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.indices::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.indices::query.pri: + in: query + name: pri + description: If true, the response only includes information from primary shards. + schema: + type: boolean + style: form + cat.indices::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.indices::query.time: + in: query + name: time + description: The unit used to display time values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' + style: form + cat.indices::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.master::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cat.master::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.master::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.master::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.master::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.master::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.master::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.master::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.nodeattrs::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cat.nodeattrs::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.nodeattrs::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.nodeattrs::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.nodeattrs::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.nodeattrs::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.nodeattrs::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.nodeattrs::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.nodes::query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Bytes' + style: form + cat.nodes::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cat.nodes::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.nodes::query.full_id: + in: query + name: full_id + description: If `true`, return the full node ID. If `false`, return the shortened node ID. + schema: + oneOf: + - type: boolean + - type: string + style: form + cat.nodes::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.nodes::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.nodes::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + x-version-deprecated: '1.0' + x-deprecation-message: This parameter does not cause this API to act locally. + deprecated: true + cat.nodes::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.nodes::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.nodes::query.time: + name: time + in: query + description: The unit in which to display time values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' + cat.nodes::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.pending_tasks::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cat.pending_tasks::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.pending_tasks::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.pending_tasks::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.pending_tasks::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.pending_tasks::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.pending_tasks::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.pending_tasks::query.time: + name: time + in: query + description: The unit in which to display time values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' + cat.pending_tasks::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.pit_segments::query.bytes: + name: bytes + in: query + description: The unit in which to display byte values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Bytes' + cat.pit_segments::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.pit_segments::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.pit_segments::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.pit_segments::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.pit_segments::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.plugins::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cat.plugins::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.plugins::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.plugins::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.plugins::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.plugins::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.plugins::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.plugins::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.recovery::path.index: + in: path + name: index + description: |- + A 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`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + cat.recovery::query.active_only: + in: query + name: active_only + description: If `true`, the response only includes ongoing shard recoveries. + schema: + type: boolean + style: form + cat.recovery::query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Bytes' + style: form + cat.recovery::query.detailed: + in: query + name: detailed + description: If `true`, the response includes detailed information about shard recoveries. + schema: + type: boolean + style: form + cat.recovery::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.recovery::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.recovery::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.recovery::query.index: + name: index + in: query + description: Comma-separated list or wildcard expression of index names to limit the returned information. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list or wildcard expression of index names to limit the returned information. + explode: true + cat.recovery::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.recovery::query.time: + name: time + in: query + description: The unit in which to display time values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' + cat.recovery::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.repositories::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cat.repositories::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.repositories::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.repositories::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.repositories::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.repositories::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.repositories::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.repositories::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.segment_replication::path.index: + name: index + in: path + description: Comma-separated list or wildcard expression of index names to limit the returned information. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Comma-separated list or wildcard expression of index names to limit the returned information. + x-data-type: array + required: true + cat.segment_replication::query.active_only: + name: active_only + in: query + description: If `true`, the response only includes ongoing segment replication events. + schema: + type: boolean + default: false + description: If `true`, the response only includes ongoing segment replication events. + cat.segment_replication::query.allow_no_indices: + name: allow_no_indices + in: 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). + schema: + type: boolean + 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). + cat.segment_replication::query.bytes: + name: bytes + in: query + description: The unit in which to display byte values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Bytes' + cat.segment_replication::query.completed_only: + name: completed_only + in: query + description: If `true`, the response only includes latest completed segment replication events. + schema: + type: boolean + default: false + description: If `true`, the response only includes latest completed segment replication events. + cat.segment_replication::query.detailed: + name: detailed + in: query + description: If `true`, the response includes detailed information about segment replications. + schema: + type: boolean + default: false + description: If `true`, the response includes detailed information about segment replications. + cat.segment_replication::query.expand_wildcards: + name: expand_wildcards + in: query + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + cat.segment_replication::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.segment_replication::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.segment_replication::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.segment_replication::query.ignore_throttled: + name: ignore_throttled + in: query + description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + schema: + type: boolean + description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + cat.segment_replication::query.ignore_unavailable: + name: ignore_unavailable + in: query + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + schema: + type: boolean + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + cat.segment_replication::query.index: + name: index + in: query + description: Comma-separated list or wildcard expression of index names to limit the returned information. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list or wildcard expression of index names to limit the returned information. + explode: true + cat.segment_replication::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.segment_replication::query.shards: + name: shards + in: query + description: Comma-separated list of shards to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of shards to display. + explode: true + cat.segment_replication::query.time: + name: time + in: query + description: The unit in which to display time values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' + cat.segment_replication::query.timeout: + name: timeout + in: query + description: Operation timeout. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + cat.segment_replication::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.segments::path.index: + in: path + name: index + description: |- + A 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`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + cat.segments::query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Bytes' + style: form + cat.segments::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cat.segments::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.segments::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.segments::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.segments::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.segments::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.segments::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.shards::path.index: + in: path + name: index + description: |- + A 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`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + cat.shards::query.bytes: + in: query + name: bytes + description: The unit used to display byte values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Bytes' + style: form + cat.shards::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cat.shards::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.shards::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.shards::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.shards::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.shards::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.shards::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.shards::query.time: + name: time + in: query + description: The unit in which to display time values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' + cat.shards::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.snapshots::path.repository: + in: path + name: repository + description: |- + A comma-separated list of snapshot repositories used to limit the request. + Accepts wildcard expressions. + `_all` returns all repositories. + If any repository fails during the request, Opensearch returns an error. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + cat.snapshots::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cat.snapshots::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.snapshots::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.snapshots::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.snapshots::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `true`, the response does not include information from unavailable snapshots. + schema: + type: boolean + style: form + cat.snapshots::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.snapshots::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.snapshots::query.time: + name: time + in: query + description: The unit in which to display time values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' + cat.snapshots::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.tasks::query.actions: + in: query + name: actions + description: The task action names, which are used to limit the response. + schema: + type: array + items: + type: string + style: form + cat.tasks::query.detailed: + in: query + name: detailed + description: If `true`, the response includes detailed information about shard recoveries. + schema: + type: boolean + style: form + cat.tasks::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.tasks::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.tasks::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.tasks::query.nodes: + name: nodes + in: query + description: 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. + style: form + schema: + type: array + items: + type: string + description: 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. + explode: true + cat.tasks::query.parent_task_id: + in: query + name: parent_task_id + description: The parent task identifier, which is used to limit the response. + schema: + type: string + style: form + cat.tasks::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.tasks::query.time: + name: time + in: query + description: The unit in which to display time values. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/TimeUnit' + cat.tasks::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.templates::path.name: + in: path + name: name + description: |- + The name of the template to return. + Accepts wildcard expressions. If omitted, all templates are returned. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + cat.templates::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cat.templates::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.templates::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.templates::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.templates::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.templates::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.templates::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.templates::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. + cat.thread_pool::path.thread_pool_patterns: + in: path + name: thread_pool_patterns + description: |- + A comma-separated list of thread pool names used to limit the request. + Accepts wildcard expressions. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + cat.thread_pool::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cat.thread_pool::query.format: + name: format + in: query + description: A short version of the Accept header, e.g. json, yaml. + schema: + type: string + description: A short version of the Accept header, e.g. json, yaml. + cat.thread_pool::query.h: + name: h + in: query + description: Comma-separated list of column names to display. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names to display. + explode: true + cat.thread_pool::query.help: + name: help + in: query + description: Return help information. + schema: + type: boolean + default: false + description: Return help information. + cat.thread_pool::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + cat.thread_pool::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + cat.thread_pool::query.s: + name: s + in: query + description: Comma-separated list of column names or column aliases to sort by. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of column names or column aliases to sort by. + explode: true + cat.thread_pool::query.size: + name: size + in: query + description: The multiplier in which to display values. + schema: + type: integer + description: The multiplier in which to display values. + format: int32 + cat.thread_pool::query.v: + name: v + in: query + description: Verbose mode. Display column headers. + schema: + type: boolean + default: false + description: Verbose mode. Display column headers. diff --git a/spec/namespaces/cluster.yaml b/spec/namespaces/cluster.yaml new file mode 100644 index 00000000..c9d3ba93 --- /dev/null +++ b/spec/namespaces/cluster.yaml @@ -0,0 +1,1386 @@ +openapi: 3.1.0 +info: + title: OpenSearch Cluster API + description: OpenSearch Cluster API + version: 1.0.0 +paths: + /_cluster/allocation/explain: + get: + operationId: cluster.allocation_explain.0 + x-operation-group: cluster.allocation_explain + x-version-added: '1.0' + description: Provides explanations for shard allocations in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/ + parameters: + - $ref: '#/components/parameters/cluster.allocation_explain::query.include_yes_decisions' + - $ref: '#/components/parameters/cluster.allocation_explain::query.include_disk_info' + requestBody: + $ref: '#/components/requestBodies/cluster.allocation_explain' + responses: + '200': + $ref: '#/components/responses/cluster.allocation_explain@200' + post: + operationId: cluster.allocation_explain.1 + x-operation-group: cluster.allocation_explain + x-version-added: '1.0' + description: Provides explanations for shard allocations in the cluster. + parameters: + - $ref: '#/components/parameters/cluster.allocation_explain::query.include_yes_decisions' + - $ref: '#/components/parameters/cluster.allocation_explain::query.include_disk_info' + requestBody: + $ref: '#/components/requestBodies/cluster.allocation_explain' + responses: + '200': + $ref: '#/components/responses/cluster.allocation_explain@200' + /_cluster/decommission/awareness: + delete: + operationId: cluster.delete_decommission_awareness.0 + x-operation-group: cluster.delete_decommission_awareness + x-version-added: '1.0' + description: Delete any existing decommission. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone + responses: + '200': + $ref: '#/components/responses/cluster.delete_decommission_awareness@200' + /_cluster/decommission/awareness/{awareness_attribute_name}/_status: + get: + operationId: cluster.get_decommission_awareness.0 + x-operation-group: cluster.get_decommission_awareness + x-version-added: '1.0' + description: Get details and status of decommissioned attribute. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-getting-zone-decommission-status + parameters: + - $ref: '#/components/parameters/cluster.get_decommission_awareness::path.awareness_attribute_name' + responses: + '200': + $ref: '#/components/responses/cluster.get_decommission_awareness@200' + /_cluster/decommission/awareness/{awareness_attribute_name}/{awareness_attribute_value}: + put: + operationId: cluster.put_decommission_awareness.0 + x-operation-group: cluster.put_decommission_awareness + x-version-added: '1.0' + description: Decommissions an awareness attribute. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-decommission/#example-decommissioning-and-recommissioning-a-zone + parameters: + - $ref: '#/components/parameters/cluster.put_decommission_awareness::path.awareness_attribute_name' + - $ref: '#/components/parameters/cluster.put_decommission_awareness::path.awareness_attribute_value' + responses: + '200': + $ref: '#/components/responses/cluster.put_decommission_awareness@200' + /_cluster/health: + get: + operationId: cluster.health.0 + x-operation-group: cluster.health + x-version-added: '1.0' + description: Returns basic information about the health of the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-health/ + parameters: + - $ref: '#/components/parameters/cluster.health::query.expand_wildcards' + - $ref: '#/components/parameters/cluster.health::query.level' + - $ref: '#/components/parameters/cluster.health::query.local' + - $ref: '#/components/parameters/cluster.health::query.master_timeout' + - $ref: '#/components/parameters/cluster.health::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.health::query.timeout' + - $ref: '#/components/parameters/cluster.health::query.wait_for_active_shards' + - $ref: '#/components/parameters/cluster.health::query.wait_for_nodes' + - $ref: '#/components/parameters/cluster.health::query.wait_for_events' + - $ref: '#/components/parameters/cluster.health::query.wait_for_no_relocating_shards' + - $ref: '#/components/parameters/cluster.health::query.wait_for_no_initializing_shards' + - $ref: '#/components/parameters/cluster.health::query.wait_for_status' + - $ref: '#/components/parameters/cluster.health::query.awareness_attribute' + responses: + '200': + $ref: '#/components/responses/cluster.health@200' + /_cluster/health/{index}: + get: + operationId: cluster.health.1 + x-operation-group: cluster.health + x-version-added: '1.0' + description: Returns basic information about the health of the cluster. + parameters: + - $ref: '#/components/parameters/cluster.health::path.index' + - $ref: '#/components/parameters/cluster.health::query.expand_wildcards' + - $ref: '#/components/parameters/cluster.health::query.level' + - $ref: '#/components/parameters/cluster.health::query.local' + - $ref: '#/components/parameters/cluster.health::query.master_timeout' + - $ref: '#/components/parameters/cluster.health::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.health::query.timeout' + - $ref: '#/components/parameters/cluster.health::query.wait_for_active_shards' + - $ref: '#/components/parameters/cluster.health::query.wait_for_nodes' + - $ref: '#/components/parameters/cluster.health::query.wait_for_events' + - $ref: '#/components/parameters/cluster.health::query.wait_for_no_relocating_shards' + - $ref: '#/components/parameters/cluster.health::query.wait_for_no_initializing_shards' + - $ref: '#/components/parameters/cluster.health::query.wait_for_status' + - $ref: '#/components/parameters/cluster.health::query.awareness_attribute' + responses: + '200': + $ref: '#/components/responses/cluster.health@200' + /_cluster/pending_tasks: + get: + operationId: cluster.pending_tasks.0 + x-operation-group: cluster.pending_tasks + x-version-added: '1.0' + description: |- + Returns a list of any cluster-level changes (e.g. create index, update mapping, + allocate or fail shard) which have not yet been executed. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/cluster.pending_tasks::query.local' + - $ref: '#/components/parameters/cluster.pending_tasks::query.master_timeout' + - $ref: '#/components/parameters/cluster.pending_tasks::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/cluster.pending_tasks@200' + /_cluster/reroute: + post: + operationId: cluster.reroute.0 + x-operation-group: cluster.reroute + x-version-added: '1.0' + description: Allows to manually change the allocation of individual shards in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/cluster.reroute::query.dry_run' + - $ref: '#/components/parameters/cluster.reroute::query.explain' + - $ref: '#/components/parameters/cluster.reroute::query.retry_failed' + - $ref: '#/components/parameters/cluster.reroute::query.metric' + - $ref: '#/components/parameters/cluster.reroute::query.master_timeout' + - $ref: '#/components/parameters/cluster.reroute::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.reroute::query.timeout' + requestBody: + $ref: '#/components/requestBodies/cluster.reroute' + responses: + '200': + $ref: '#/components/responses/cluster.reroute@200' + /_cluster/routing/awareness/weights: + delete: + operationId: cluster.delete_weighted_routing.0 + x-operation-group: cluster.delete_weighted_routing + x-version-added: '1.0' + description: Delete weighted shard routing weights. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-deleting-weights + responses: + '200': + $ref: '#/components/responses/cluster.delete_weighted_routing@200' + /_cluster/routing/awareness/{attribute}/weights: + get: + operationId: cluster.get_weighted_routing.0 + x-operation-group: cluster.get_weighted_routing + x-version-added: '1.0' + description: Fetches weighted shard routing weights. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-getting-weights-for-all-zones + parameters: + - $ref: '#/components/parameters/cluster.get_weighted_routing::path.attribute' + responses: + '200': + $ref: '#/components/responses/cluster.get_weighted_routing@200' + put: + operationId: cluster.put_weighted_routing.0 + x-operation-group: cluster.put_weighted_routing + x-version-added: '1.0' + description: Updates weighted shard routing weights. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-awareness/#example-weighted-round-robin-search + parameters: + - $ref: '#/components/parameters/cluster.put_weighted_routing::path.attribute' + responses: + '200': + $ref: '#/components/responses/cluster.put_weighted_routing@200' + /_cluster/settings: + get: + operationId: cluster.get_settings.0 + x-operation-group: cluster.get_settings + x-version-added: '1.0' + description: Returns cluster settings. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-settings/ + parameters: + - $ref: '#/components/parameters/cluster.get_settings::query.flat_settings' + - $ref: '#/components/parameters/cluster.get_settings::query.master_timeout' + - $ref: '#/components/parameters/cluster.get_settings::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.get_settings::query.timeout' + - $ref: '#/components/parameters/cluster.get_settings::query.include_defaults' + responses: + '200': + $ref: '#/components/responses/cluster.get_settings@200' + put: + operationId: cluster.put_settings.0 + x-operation-group: cluster.put_settings + x-version-added: '1.0' + description: Updates the cluster settings. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-settings/ + parameters: + - $ref: '#/components/parameters/cluster.put_settings::query.flat_settings' + - $ref: '#/components/parameters/cluster.put_settings::query.master_timeout' + - $ref: '#/components/parameters/cluster.put_settings::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.put_settings::query.timeout' + requestBody: + $ref: '#/components/requestBodies/cluster.put_settings' + responses: + '200': + $ref: '#/components/responses/cluster.put_settings@200' + /_cluster/state: + get: + operationId: cluster.state.0 + x-operation-group: cluster.state + x-version-added: '1.0' + description: Returns a comprehensive information about the state of the cluster. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/cluster.state::query.local' + - $ref: '#/components/parameters/cluster.state::query.master_timeout' + - $ref: '#/components/parameters/cluster.state::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.state::query.flat_settings' + - $ref: '#/components/parameters/cluster.state::query.wait_for_metadata_version' + - $ref: '#/components/parameters/cluster.state::query.wait_for_timeout' + - $ref: '#/components/parameters/cluster.state::query.ignore_unavailable' + - $ref: '#/components/parameters/cluster.state::query.allow_no_indices' + - $ref: '#/components/parameters/cluster.state::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/cluster.state@200' + /_cluster/state/{metric}: + get: + operationId: cluster.state.1 + x-operation-group: cluster.state + x-version-added: '1.0' + description: Returns a comprehensive information about the state of the cluster. + parameters: + - $ref: '#/components/parameters/cluster.state::path.metric' + - $ref: '#/components/parameters/cluster.state::query.local' + - $ref: '#/components/parameters/cluster.state::query.master_timeout' + - $ref: '#/components/parameters/cluster.state::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.state::query.flat_settings' + - $ref: '#/components/parameters/cluster.state::query.wait_for_metadata_version' + - $ref: '#/components/parameters/cluster.state::query.wait_for_timeout' + - $ref: '#/components/parameters/cluster.state::query.ignore_unavailable' + - $ref: '#/components/parameters/cluster.state::query.allow_no_indices' + - $ref: '#/components/parameters/cluster.state::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/cluster.state@200' + /_cluster/state/{metric}/{index}: + get: + operationId: cluster.state.2 + x-operation-group: cluster.state + x-version-added: '1.0' + description: Returns a comprehensive information about the state of the cluster. + parameters: + - $ref: '#/components/parameters/cluster.state::path.index' + - $ref: '#/components/parameters/cluster.state::path.metric' + - $ref: '#/components/parameters/cluster.state::query.local' + - $ref: '#/components/parameters/cluster.state::query.master_timeout' + - $ref: '#/components/parameters/cluster.state::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.state::query.flat_settings' + - $ref: '#/components/parameters/cluster.state::query.wait_for_metadata_version' + - $ref: '#/components/parameters/cluster.state::query.wait_for_timeout' + - $ref: '#/components/parameters/cluster.state::query.ignore_unavailable' + - $ref: '#/components/parameters/cluster.state::query.allow_no_indices' + - $ref: '#/components/parameters/cluster.state::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/cluster.state@200' + /_cluster/stats: + get: + operationId: cluster.stats.0 + x-operation-group: cluster.stats + x-version-added: '1.0' + description: Returns high-level overview of cluster statistics. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/ + parameters: + - $ref: '#/components/parameters/cluster.stats::query.flat_settings' + - $ref: '#/components/parameters/cluster.stats::query.timeout' + responses: + '200': + $ref: '#/components/responses/cluster.stats@200' + /_cluster/stats/nodes/{node_id}: + get: + operationId: cluster.stats.1 + x-operation-group: cluster.stats + x-version-added: '1.0' + description: Returns high-level overview of cluster statistics. + parameters: + - $ref: '#/components/parameters/cluster.stats::path.node_id' + - $ref: '#/components/parameters/cluster.stats::query.flat_settings' + - $ref: '#/components/parameters/cluster.stats::query.timeout' + responses: + '200': + $ref: '#/components/responses/cluster.stats@200' + /_cluster/voting_config_exclusions: + delete: + operationId: cluster.delete_voting_config_exclusions.0 + x-operation-group: cluster.delete_voting_config_exclusions + x-version-added: '1.0' + description: Clears cluster voting config exclusions. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/cluster.delete_voting_config_exclusions::query.wait_for_removal' + responses: + '200': + $ref: '#/components/responses/cluster.delete_voting_config_exclusions@200' + post: + operationId: cluster.post_voting_config_exclusions.0 + x-operation-group: cluster.post_voting_config_exclusions + x-version-added: '1.0' + description: Updates the cluster voting config exclusions by node ids or node names. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/cluster.post_voting_config_exclusions::query.node_ids' + - $ref: '#/components/parameters/cluster.post_voting_config_exclusions::query.node_names' + - $ref: '#/components/parameters/cluster.post_voting_config_exclusions::query.timeout' + responses: + '200': + $ref: '#/components/responses/cluster.post_voting_config_exclusions@200' + /_component_template: + get: + operationId: cluster.get_component_template.0 + x-operation-group: cluster.get_component_template + x-version-added: '1.0' + description: Returns one or more component templates. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/cluster.get_component_template::query.master_timeout' + - $ref: '#/components/parameters/cluster.get_component_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.get_component_template::query.local' + responses: + '200': + $ref: '#/components/responses/cluster.get_component_template@200' + /_component_template/{name}: + delete: + operationId: cluster.delete_component_template.0 + x-operation-group: cluster.delete_component_template + x-version-added: '1.0' + description: Deletes a component template. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/cluster.delete_component_template::path.name' + - $ref: '#/components/parameters/cluster.delete_component_template::query.timeout' + - $ref: '#/components/parameters/cluster.delete_component_template::query.master_timeout' + - $ref: '#/components/parameters/cluster.delete_component_template::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/cluster.delete_component_template@200' + get: + operationId: cluster.get_component_template.1 + x-operation-group: cluster.get_component_template + x-version-added: '1.0' + description: Returns one or more component templates. + parameters: + - $ref: '#/components/parameters/cluster.get_component_template::path.name' + - $ref: '#/components/parameters/cluster.get_component_template::query.master_timeout' + - $ref: '#/components/parameters/cluster.get_component_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.get_component_template::query.local' + responses: + '200': + $ref: '#/components/responses/cluster.get_component_template@200' + head: + operationId: cluster.exists_component_template.0 + x-operation-group: cluster.exists_component_template + x-version-added: '1.0' + description: Returns information about whether a particular component template exist. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/cluster.exists_component_template::path.name' + - $ref: '#/components/parameters/cluster.exists_component_template::query.master_timeout' + - $ref: '#/components/parameters/cluster.exists_component_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/cluster.exists_component_template::query.local' + responses: + '200': + $ref: '#/components/responses/cluster.exists_component_template@200' + post: + operationId: cluster.put_component_template.0 + x-operation-group: cluster.put_component_template + x-version-added: '1.0' + description: Creates or updates a component template. + parameters: + - $ref: '#/components/parameters/cluster.put_component_template::path.name' + - $ref: '#/components/parameters/cluster.put_component_template::query.create' + - $ref: '#/components/parameters/cluster.put_component_template::query.timeout' + - $ref: '#/components/parameters/cluster.put_component_template::query.master_timeout' + - $ref: '#/components/parameters/cluster.put_component_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/cluster.put_component_template' + responses: + '200': + $ref: '#/components/responses/cluster.put_component_template@200' + put: + operationId: cluster.put_component_template.1 + x-operation-group: cluster.put_component_template + x-version-added: '1.0' + description: Creates or updates a component template. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-templates/#use-component-templates-to-create-an-index-template + parameters: + - $ref: '#/components/parameters/cluster.put_component_template::path.name' + - $ref: '#/components/parameters/cluster.put_component_template::query.create' + - $ref: '#/components/parameters/cluster.put_component_template::query.timeout' + - $ref: '#/components/parameters/cluster.put_component_template::query.master_timeout' + - $ref: '#/components/parameters/cluster.put_component_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/cluster.put_component_template' + responses: + '200': + $ref: '#/components/responses/cluster.put_component_template@200' + /_remote/info: + get: + operationId: cluster.remote_info.0 + x-operation-group: cluster.remote_info + x-version-added: '1.0' + description: Returns the information about configured remote clusters. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/remote-info/ + parameters: [] + responses: + '200': + $ref: '#/components/responses/cluster.remote_info@200' +components: + requestBodies: + cluster.allocation_explain: + content: + application/json: + schema: + type: object + properties: + current_node: + description: Specifies the node ID or the name of the node to only explain a shard that is currently located on the + specified node. + type: string + index: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + primary: + description: If true, returns explanation for the primary shard for the given shard ID. + type: boolean + shard: + description: Specifies the ID of the shard that you would like an explanation for. + type: number + description: The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard' + cluster.put_component_template: + content: + application/json: + schema: + type: object + properties: + allow_auto_create: + description: |- + This setting overrides the value of the `action.auto_create_index` cluster setting. + If set to `true` in a template, then indices can be automatically created using that + template even if auto-creation of indices is disabled via `actions.auto_create_index`. + If set to `false` then data streams matching the template must always be explicitly created. + type: boolean + template: + $ref: '../schemas/indices._common.yaml#/components/schemas/IndexState' + version: + $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' + _meta: + $ref: '../schemas/_common.yaml#/components/schemas/Metadata' + required: + - template + description: The template definition + required: true + cluster.put_settings: + content: + application/json: + schema: + type: object + properties: + persistent: + type: object + additionalProperties: + type: object + transient: + type: object + additionalProperties: + type: object + description: The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). + required: true + cluster.reroute: + content: + application/json: + schema: + type: object + properties: + commands: + description: Defines the commands to perform. + type: array + items: + $ref: '../schemas/cluster.reroute.yaml#/components/schemas/Command' + description: The definition of `commands` to perform (`move`, `cancel`, `allocate`) + responses: + cluster.allocation_explain@200: + description: '' + content: + application/json: + schema: + type: object + properties: + allocate_explanation: + type: string + allocation_delay: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + allocation_delay_in_millis: + $ref: '../schemas/_common.yaml#/components/schemas/DurationValueUnitMillis' + can_allocate: + $ref: '../schemas/cluster.allocation_explain.yaml#/components/schemas/Decision' + can_move_to_other_node: + $ref: '../schemas/cluster.allocation_explain.yaml#/components/schemas/Decision' + can_rebalance_cluster: + $ref: '../schemas/cluster.allocation_explain.yaml#/components/schemas/Decision' + can_rebalance_cluster_decisions: + type: array + items: + $ref: '../schemas/cluster.allocation_explain.yaml#/components/schemas/AllocationDecision' + can_rebalance_to_other_node: + $ref: '../schemas/cluster.allocation_explain.yaml#/components/schemas/Decision' + can_remain_decisions: + type: array + items: + $ref: '../schemas/cluster.allocation_explain.yaml#/components/schemas/AllocationDecision' + can_remain_on_current_node: + $ref: '../schemas/cluster.allocation_explain.yaml#/components/schemas/Decision' + cluster_info: + $ref: '../schemas/cluster.allocation_explain.yaml#/components/schemas/ClusterInfo' + configured_delay: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + configured_delay_in_millis: + $ref: '../schemas/_common.yaml#/components/schemas/DurationValueUnitMillis' + current_node: + $ref: '../schemas/cluster.allocation_explain.yaml#/components/schemas/CurrentNode' + current_state: + type: string + index: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + move_explanation: + type: string + node_allocation_decisions: + type: array + items: + $ref: '../schemas/cluster.allocation_explain.yaml#/components/schemas/NodeAllocationExplanation' + primary: + type: boolean + rebalance_explanation: + type: string + remaining_delay: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + remaining_delay_in_millis: + $ref: '../schemas/_common.yaml#/components/schemas/DurationValueUnitMillis' + shard: + type: number + unassigned_info: + $ref: '../schemas/cluster.allocation_explain.yaml#/components/schemas/UnassignedInformation' + note: + type: string + required: + - current_state + - index + - primary + - shard + cluster.delete_component_template@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + cluster.delete_decommission_awareness@200: + description: '' + cluster.delete_voting_config_exclusions@200: + description: '' + content: + application/json: {} + cluster.delete_weighted_routing@200: + description: '' + cluster.exists_component_template@200: + description: '' + content: + application/json: {} + cluster.get_component_template@200: + description: '' + content: + application/json: + schema: + type: object + properties: + component_templates: + type: array + items: + $ref: '../schemas/cluster._common.yaml#/components/schemas/ComponentTemplate' + required: + - component_templates + cluster.get_decommission_awareness@200: + description: '' + cluster.get_settings@200: + description: '' + content: + application/json: + schema: + type: object + properties: + persistent: + type: object + additionalProperties: + type: object + transient: + type: object + additionalProperties: + type: object + defaults: + type: object + additionalProperties: + type: object + required: + - persistent + - transient + cluster.get_weighted_routing@200: + description: '' + cluster.health@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/cluster.health.yaml#/components/schemas/HealthResponseBody' + cluster.pending_tasks@200: + description: '' + content: + application/json: + schema: + type: object + properties: + tasks: + type: array + items: + $ref: '../schemas/cluster.pending_tasks.yaml#/components/schemas/PendingTask' + required: + - tasks + cluster.post_voting_config_exclusions@200: + description: '' + content: + application/json: {} + cluster.put_component_template@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + cluster.put_decommission_awareness@200: + description: '' + cluster.put_settings@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + persistent: + type: object + additionalProperties: + type: object + transient: + type: object + additionalProperties: + type: object + required: + - acknowledged + - persistent + - transient + cluster.put_weighted_routing@200: + description: '' + cluster.remote_info@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '../schemas/cluster.remote_info.yaml#/components/schemas/ClusterRemoteInfo' + cluster.reroute@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + explanations: + type: array + items: + $ref: '../schemas/cluster.reroute.yaml#/components/schemas/RerouteExplanation' + state: + description: |- + 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. + type: object + required: + - acknowledged + cluster.state@200: + description: '' + content: + application/json: + schema: + type: object + cluster.stats@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/cluster.stats.yaml#/components/schemas/StatsResponseBase' + parameters: + cluster.allocation_explain::query.include_disk_info: + in: query + name: include_disk_info + description: If true, returns information about disk usage and shard sizes. + schema: + type: boolean + style: form + cluster.allocation_explain::query.include_yes_decisions: + in: query + name: include_yes_decisions + description: If true, returns YES decisions in explanation. + schema: + type: boolean + style: form + cluster.delete_component_template::path.name: + in: path + name: name + description: Comma-separated list or wildcard expression of component template names used to limit the request. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + cluster.delete_component_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cluster.delete_component_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.delete_component_template::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + cluster.delete_voting_config_exclusions::query.wait_for_removal: + in: query + name: wait_for_removal + description: |- + 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. + schema: + type: boolean + style: form + cluster.exists_component_template::path.name: + in: path + name: name + description: |- + Comma-separated list of component template names used to limit the request. + Wildcard (*) expressions are supported. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + cluster.exists_component_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cluster.exists_component_template::query.local: + in: query + name: local + description: |- + If true, the request retrieves information from the local node only. + Defaults to false, which means information is retrieved from the master node. + schema: + type: boolean + style: form + cluster.exists_component_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.get_component_template::path.name: + in: path + name: name + description: |- + Comma-separated list of component template names used to limit the request. + Wildcard (`*`) expressions are supported. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + cluster.get_component_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cluster.get_component_template::query.local: + in: query + name: local + description: |- + If `true`, the request retrieves information from the local node only. + If `false`, information is retrieved from the master node. + schema: + type: boolean + style: form + cluster.get_component_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.get_decommission_awareness::path.awareness_attribute_name: + name: awareness_attribute_name + in: path + description: Awareness attribute name. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Awareness attribute name. + required: true + cluster.get_settings::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cluster.get_settings::query.flat_settings: + in: query + name: flat_settings + description: If `true`, returns settings in flat format. + schema: + type: boolean + style: form + cluster.get_settings::query.include_defaults: + in: query + name: include_defaults + description: If `true`, returns default cluster settings from the local node. + schema: + type: boolean + style: form + cluster.get_settings::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.get_settings::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + cluster.get_weighted_routing::path.attribute: + name: attribute + in: path + description: Awareness attribute name. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Awareness attribute name. + required: true + cluster.health::path.index: + in: path + name: index + 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 *. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + cluster.health::query.awareness_attribute: + name: awareness_attribute + in: query + description: The awareness attribute for which the health is required. + schema: + type: string + description: The awareness attribute for which the health is required. + cluster.health::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cluster.health::query.expand_wildcards: + in: query + name: expand_wildcards + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + cluster.health::query.level: + in: query + name: level + description: Can be one of cluster, indices or shards. Controls the details level of the health information returned. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Level' + style: form + cluster.health::query.local: + in: query + name: local + description: If true, the request retrieves information from the local node only. Defaults to false, which means + information is retrieved from the master node. + schema: + type: boolean + style: form + cluster.health::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.health::query.timeout: + in: query + name: timeout + description: Period to wait for a response. If no response is received before the timeout expires, the request fails and + returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + cluster.health::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' + style: form + cluster.health::query.wait_for_events: + in: query + name: wait_for_events + description: Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with + the given priority are processed. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForEvents' + style: form + cluster.health::query.wait_for_no_initializing_shards: + in: query + name: wait_for_no_initializing_shards + description: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no + shard initializations. Defaults to false, which means it will not wait for initializing shards. + schema: + type: boolean + style: form + cluster.health::query.wait_for_no_relocating_shards: + in: query + name: wait_for_no_relocating_shards + description: A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no + shard relocations. Defaults to false, which means it will not wait for relocating shards. + schema: + type: boolean + style: form + cluster.health::query.wait_for_nodes: + in: query + name: wait_for_nodes + 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/HealthStatus' + style: form + cluster.pending_tasks::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cluster.pending_tasks::query.local: + in: query + name: local + description: |- + If `true`, the request retrieves information from the local node only. + If `false`, information is retrieved from the master node. + schema: + type: boolean + style: form + cluster.pending_tasks::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.post_voting_config_exclusions::query.node_ids: + in: query + name: node_ids + description: |- + 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Ids' + style: form + cluster.post_voting_config_exclusions::query.node_names: + in: query + name: node_names + description: |- + 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: form + cluster.post_voting_config_exclusions::query.timeout: + in: query + name: timeout + description: |- + 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + cluster.put_component_template::path.name: + in: path + name: name + description: >- + Name of the component template to create. + + Opensearch includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. + + Opensearch Agent uses these templates to configure backing indices for its data streams. + + If you use Opensearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. + + If you don’t use Opensearch Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + cluster.put_component_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cluster.put_component_template::query.create: + in: query + name: create + description: If `true`, this request cannot replace or update existing component templates. + schema: + type: boolean + style: form + cluster.put_component_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.put_component_template::query.timeout: + name: timeout + in: query + description: Operation timeout. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + cluster.put_decommission_awareness::path.awareness_attribute_name: + name: awareness_attribute_name + in: path + description: Awareness attribute name. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Awareness attribute name. + required: true + cluster.put_decommission_awareness::path.awareness_attribute_value: + name: awareness_attribute_value + in: path + description: Awareness attribute value. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Awareness attribute value. + required: true + cluster.put_settings::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cluster.put_settings::query.flat_settings: + in: query + name: flat_settings + description: 'Return settings in flat format (default: false)' + schema: + type: boolean + style: form + cluster.put_settings::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.put_settings::query.timeout: + in: query + name: timeout + description: Explicit operation timeout + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + cluster.put_weighted_routing::path.attribute: + name: attribute + in: path + description: Awareness attribute name. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Awareness attribute name. + required: true + cluster.reroute::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cluster.reroute::query.dry_run: + in: query + name: dry_run + description: If true, then the request simulates the operation only and returns the resulting state. + schema: + type: boolean + style: form + cluster.reroute::query.explain: + in: query + name: explain + description: If true, then the response contains an explanation of why the commands can or cannot be executed. + schema: + type: boolean + style: form + cluster.reroute::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.reroute::query.metric: + in: query + name: metric + description: Limits the information returned to the specified metrics. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Metrics' + style: form + cluster.reroute::query.retry_failed: + in: query + name: retry_failed + description: If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. + schema: + type: boolean + style: form + cluster.reroute::query.timeout: + in: query + name: timeout + description: Period to wait for a response. If no response is received before the timeout expires, the request fails and + returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + cluster.state::path.index: + in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + cluster.state::path.metric: + in: path + name: metric + description: Limit the information returned to the specified metrics + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Metrics' + style: simple + cluster.state::query.allow_no_indices: + in: query + name: allow_no_indices + 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) + schema: + type: boolean + style: form + cluster.state::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + cluster.state::query.expand_wildcards: + in: query + name: expand_wildcards + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + cluster.state::query.flat_settings: + in: query + name: flat_settings + description: 'Return settings in flat format (default: false)' + schema: + type: boolean + style: form + cluster.state::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: Whether specified concrete indices should be ignored when unavailable (missing or closed) + schema: + type: boolean + style: form + cluster.state::query.local: + in: query + name: local + description: 'Return local information, do not retrieve the state from master node (default: false)' + schema: + type: boolean + style: form + cluster.state::query.master_timeout: + in: query + name: master_timeout + description: Specify timeout for connection to master + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + cluster.state::query.wait_for_metadata_version: + in: query + name: wait_for_metadata_version + description: Wait for the metadata version to be equal or greater than the specified metadata version + schema: + $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' + style: form + cluster.state::query.wait_for_timeout: + in: query + name: wait_for_timeout + description: The maximum time to wait for wait_for_metadata_version before timing out + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + cluster.stats::path.node_id: + in: path + name: node_id + description: Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/NodeIds' + style: simple + cluster.stats::query.flat_settings: + in: query + name: flat_settings + description: If `true`, returns settings in flat format. + schema: + type: boolean + style: form + cluster.stats::query.timeout: + in: query + name: timeout + 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form diff --git a/spec/namespaces/dangling_indices.yaml b/spec/namespaces/dangling_indices.yaml new file mode 100644 index 00000000..33edc6f4 --- /dev/null +++ b/spec/namespaces/dangling_indices.yaml @@ -0,0 +1,160 @@ +openapi: 3.1.0 +info: + title: OpenSearch Dangling_indices API + description: OpenSearch Dangling_indices API + version: 1.0.0 +paths: + /_dangling: + get: + operationId: dangling_indices.list_dangling_indices.0 + x-operation-group: dangling_indices.list_dangling_indices + x-version-added: '1.0' + description: Returns all dangling indices. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ + parameters: [] + responses: + '200': + $ref: '#/components/responses/dangling_indices.list_dangling_indices@200' + /_dangling/{index_uuid}: + delete: + operationId: dangling_indices.delete_dangling_index.0 + x-operation-group: dangling_indices.delete_dangling_index + x-version-added: '1.0' + description: Deletes the specified dangling index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ + parameters: + - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::path.index_uuid' + - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.accept_data_loss' + - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.timeout' + - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.master_timeout' + - $ref: '#/components/parameters/dangling_indices.delete_dangling_index::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/dangling_indices.delete_dangling_index@200' + post: + operationId: dangling_indices.import_dangling_index.0 + x-operation-group: dangling_indices.import_dangling_index + x-version-added: '1.0' + description: Imports the specified dangling index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/dangling-index/ + parameters: + - $ref: '#/components/parameters/dangling_indices.import_dangling_index::path.index_uuid' + - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.accept_data_loss' + - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.timeout' + - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.master_timeout' + - $ref: '#/components/parameters/dangling_indices.import_dangling_index::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/dangling_indices.import_dangling_index@200' +components: + requestBodies: {} + responses: + dangling_indices.delete_dangling_index@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + dangling_indices.import_dangling_index@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + dangling_indices.list_dangling_indices@200: + description: '' + content: + application/json: + schema: + type: object + properties: + dangling_indices: + type: array + items: + $ref: '../schemas/dangling_indices.list_dangling_indices.yaml#/components/schemas/DanglingIndex' + required: + - dangling_indices + parameters: + dangling_indices.delete_dangling_index::path.index_uuid: + in: path + name: index_uuid + description: The UUID of the dangling index + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Uuid' + style: simple + dangling_indices.delete_dangling_index::query.accept_data_loss: + in: query + name: accept_data_loss + description: Must be set to true in order to delete the dangling index + required: true + schema: + type: boolean + style: form + dangling_indices.delete_dangling_index::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + dangling_indices.delete_dangling_index::query.master_timeout: + in: query + name: master_timeout + description: Specify timeout for connection to master + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + dangling_indices.delete_dangling_index::query.timeout: + in: query + name: timeout + description: Explicit operation timeout + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + dangling_indices.import_dangling_index::path.index_uuid: + in: path + name: index_uuid + description: The UUID of the dangling index + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Uuid' + style: simple + dangling_indices.import_dangling_index::query.accept_data_loss: + in: query + name: accept_data_loss + description: Must be set to true in order to import the dangling index + required: true + schema: + type: boolean + style: form + dangling_indices.import_dangling_index::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + dangling_indices.import_dangling_index::query.master_timeout: + in: query + name: master_timeout + description: Specify timeout for connection to master + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + dangling_indices.import_dangling_index::query.timeout: + in: query + name: timeout + description: Explicit operation timeout + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml new file mode 100644 index 00000000..d2a0234e --- /dev/null +++ b/spec/namespaces/indices.yaml @@ -0,0 +1,5087 @@ +openapi: 3.1.0 +info: + title: OpenSearch Indices API + description: OpenSearch Indices API + version: 1.0.0 +paths: + /_alias: + get: + operationId: indices.get_alias.0 + x-operation-group: indices.get_alias + x-version-added: '1.0' + description: Returns an alias. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-alias/ + parameters: + - $ref: '#/components/parameters/indices.get_alias::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_alias::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_alias::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_alias::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_alias@200' + /_alias/{name}: + get: + operationId: indices.get_alias.1 + x-operation-group: indices.get_alias + x-version-added: '1.0' + description: Returns an alias. + parameters: + - $ref: '#/components/parameters/indices.get_alias::path.name' + - $ref: '#/components/parameters/indices.get_alias::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_alias::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_alias::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_alias::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_alias@200' + head: + operationId: indices.exists_alias.0 + x-operation-group: indices.exists_alias + x-version-added: '1.0' + description: Returns information about whether a particular alias exists. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.exists_alias::path.name' + - $ref: '#/components/parameters/indices.exists_alias::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.exists_alias::query.allow_no_indices' + - $ref: '#/components/parameters/indices.exists_alias::query.expand_wildcards' + - $ref: '#/components/parameters/indices.exists_alias::query.local' + responses: + '200': + $ref: '#/components/responses/indices.exists_alias@200' + /_aliases: + post: + operationId: indices.update_aliases.0 + x-operation-group: indices.update_aliases + x-version-added: '1.0' + description: Updates index aliases. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/alias/ + parameters: + - $ref: '#/components/parameters/indices.update_aliases::query.timeout' + - $ref: '#/components/parameters/indices.update_aliases::query.master_timeout' + - $ref: '#/components/parameters/indices.update_aliases::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.update_aliases' + responses: + '200': + $ref: '#/components/responses/indices.update_aliases@200' + /_analyze: + get: + operationId: indices.analyze.0 + x-operation-group: indices.analyze + x-version-added: '1.0' + description: Performs the analysis process on a text and return the tokens breakdown of the text. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/analyze-apis/perform-text-analysis/ + parameters: + - $ref: '#/components/parameters/indices.analyze::query.index' + requestBody: + $ref: '#/components/requestBodies/indices.analyze' + responses: + '200': + $ref: '#/components/responses/indices.analyze@200' + post: + operationId: indices.analyze.1 + x-operation-group: indices.analyze + x-version-added: '1.0' + description: Performs the analysis process on a text and return the tokens breakdown of the text. + parameters: + - $ref: '#/components/parameters/indices.analyze::query.index' + requestBody: + $ref: '#/components/requestBodies/indices.analyze' + responses: + '200': + $ref: '#/components/responses/indices.analyze@200' + /_cache/clear: + post: + operationId: indices.clear_cache.0 + x-operation-group: indices.clear_cache + x-version-added: '1.0' + description: Clears all or specific caches for one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/ + parameters: + - $ref: '#/components/parameters/indices.clear_cache::query.fielddata' + - $ref: '#/components/parameters/indices.clear_cache::query.fields' + - $ref: '#/components/parameters/indices.clear_cache::query.query' + - $ref: '#/components/parameters/indices.clear_cache::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.clear_cache::query.allow_no_indices' + - $ref: '#/components/parameters/indices.clear_cache::query.expand_wildcards' + - $ref: '#/components/parameters/indices.clear_cache::query.index' + - $ref: '#/components/parameters/indices.clear_cache::query.request' + responses: + '200': + $ref: '#/components/responses/indices.clear_cache@200' + /_data_stream: + get: + operationId: indices.get_data_stream.0 + x-operation-group: indices.get_data_stream + x-version-added: '1.0' + description: Returns data streams. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/data-streams/ + parameters: [] + responses: + '200': + $ref: '#/components/responses/indices.get_data_stream@200' + /_data_stream/_stats: + get: + operationId: indices.data_streams_stats.0 + x-operation-group: indices.data_streams_stats + x-version-added: '1.0' + description: Provides statistics on operations happening in a data stream. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/data-streams/ + parameters: [] + responses: + '200': + $ref: '#/components/responses/indices.data_streams_stats@200' + /_data_stream/{name}: + delete: + operationId: indices.delete_data_stream.0 + x-operation-group: indices.delete_data_stream + x-version-added: '1.0' + description: Deletes a data stream. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/data-streams/ + parameters: + - $ref: '#/components/parameters/indices.delete_data_stream::path.name' + responses: + '200': + $ref: '#/components/responses/indices.delete_data_stream@200' + get: + operationId: indices.get_data_stream.1 + x-operation-group: indices.get_data_stream + x-version-added: '1.0' + description: Returns data streams. + parameters: + - $ref: '#/components/parameters/indices.get_data_stream::path.name' + responses: + '200': + $ref: '#/components/responses/indices.get_data_stream@200' + put: + operationId: indices.create_data_stream.0 + x-operation-group: indices.create_data_stream + x-version-added: '1.0' + description: Creates or updates a data stream. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/data-streams/ + parameters: + - $ref: '#/components/parameters/indices.create_data_stream::path.name' + requestBody: + $ref: '#/components/requestBodies/indices.create_data_stream' + responses: + '200': + $ref: '#/components/responses/indices.create_data_stream@200' + /_data_stream/{name}/_stats: + get: + operationId: indices.data_streams_stats.1 + x-operation-group: indices.data_streams_stats + x-version-added: '1.0' + description: Provides statistics on operations happening in a data stream. + parameters: + - $ref: '#/components/parameters/indices.data_streams_stats::path.name' + responses: + '200': + $ref: '#/components/responses/indices.data_streams_stats@200' + /_flush: + get: + operationId: indices.flush.0 + x-operation-group: indices.flush + x-version-added: '1.0' + description: Performs the flush operation on one or more indices. + parameters: + - $ref: '#/components/parameters/indices.flush::query.force' + - $ref: '#/components/parameters/indices.flush::query.wait_if_ongoing' + - $ref: '#/components/parameters/indices.flush::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.flush::query.allow_no_indices' + - $ref: '#/components/parameters/indices.flush::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.flush@200' + post: + operationId: indices.flush.1 + x-operation-group: indices.flush + x-version-added: '1.0' + description: Performs the flush operation on one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.flush::query.force' + - $ref: '#/components/parameters/indices.flush::query.wait_if_ongoing' + - $ref: '#/components/parameters/indices.flush::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.flush::query.allow_no_indices' + - $ref: '#/components/parameters/indices.flush::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.flush@200' + /_forcemerge: + post: + operationId: indices.forcemerge.0 + x-operation-group: indices.forcemerge + x-version-added: '1.0' + description: Performs the force merge operation on one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.forcemerge::query.flush' + - $ref: '#/components/parameters/indices.forcemerge::query.primary_only' + - $ref: '#/components/parameters/indices.forcemerge::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.forcemerge::query.allow_no_indices' + - $ref: '#/components/parameters/indices.forcemerge::query.expand_wildcards' + - $ref: '#/components/parameters/indices.forcemerge::query.max_num_segments' + - $ref: '#/components/parameters/indices.forcemerge::query.only_expunge_deletes' + - $ref: '#/components/parameters/indices.forcemerge::query.wait_for_completion' + responses: + '200': + $ref: '#/components/responses/indices.forcemerge@200' + /_index_template: + get: + operationId: indices.get_index_template.0 + x-operation-group: indices.get_index_template + x-version-added: '1.0' + description: Returns an index template. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-templates/ + parameters: + - $ref: '#/components/parameters/indices.get_index_template::query.flat_settings' + - $ref: '#/components/parameters/indices.get_index_template::query.master_timeout' + - $ref: '#/components/parameters/indices.get_index_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_index_template::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_index_template@200' + /_index_template/_simulate: + post: + operationId: indices.simulate_template.0 + x-operation-group: indices.simulate_template + x-version-added: '1.0' + description: Simulate resolving the given template name or body. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.simulate_template::query.create' + - $ref: '#/components/parameters/indices.simulate_template::query.cause' + - $ref: '#/components/parameters/indices.simulate_template::query.master_timeout' + - $ref: '#/components/parameters/indices.simulate_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.simulate_template' + responses: + '200': + $ref: '#/components/responses/indices.simulate_template@200' + /_index_template/_simulate/{name}: + post: + operationId: indices.simulate_template.1 + x-operation-group: indices.simulate_template + x-version-added: '1.0' + description: Simulate resolving the given template name or body. + parameters: + - $ref: '#/components/parameters/indices.simulate_template::path.name' + - $ref: '#/components/parameters/indices.simulate_template::query.create' + - $ref: '#/components/parameters/indices.simulate_template::query.cause' + - $ref: '#/components/parameters/indices.simulate_template::query.master_timeout' + - $ref: '#/components/parameters/indices.simulate_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.simulate_template' + responses: + '200': + $ref: '#/components/responses/indices.simulate_template@200' + /_index_template/_simulate_index/{name}: + post: + operationId: indices.simulate_index_template.0 + x-operation-group: indices.simulate_index_template + x-version-added: '1.0' + description: Simulate matching the given index name against the index templates in the system. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.simulate_index_template::path.name' + - $ref: '#/components/parameters/indices.simulate_index_template::query.create' + - $ref: '#/components/parameters/indices.simulate_index_template::query.cause' + - $ref: '#/components/parameters/indices.simulate_index_template::query.master_timeout' + - $ref: '#/components/parameters/indices.simulate_index_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.simulate_index_template' + responses: + '200': + $ref: '#/components/responses/indices.simulate_index_template@200' + /_index_template/{name}: + delete: + operationId: indices.delete_index_template.0 + x-operation-group: indices.delete_index_template + x-version-added: '1.0' + description: Deletes an index template. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-templates/#delete-a-template + parameters: + - $ref: '#/components/parameters/indices.delete_index_template::path.name' + - $ref: '#/components/parameters/indices.delete_index_template::query.timeout' + - $ref: '#/components/parameters/indices.delete_index_template::query.master_timeout' + - $ref: '#/components/parameters/indices.delete_index_template::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/indices.delete_index_template@200' + get: + operationId: indices.get_index_template.1 + x-operation-group: indices.get_index_template + x-version-added: '1.0' + description: Returns an index template. + parameters: + - $ref: '#/components/parameters/indices.get_index_template::path.name' + - $ref: '#/components/parameters/indices.get_index_template::query.flat_settings' + - $ref: '#/components/parameters/indices.get_index_template::query.master_timeout' + - $ref: '#/components/parameters/indices.get_index_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_index_template::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_index_template@200' + head: + operationId: indices.exists_index_template.0 + x-operation-group: indices.exists_index_template + x-version-added: '1.0' + description: Returns information about whether a particular index template exists. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-templates/ + parameters: + - $ref: '#/components/parameters/indices.exists_index_template::path.name' + - $ref: '#/components/parameters/indices.exists_index_template::query.flat_settings' + - $ref: '#/components/parameters/indices.exists_index_template::query.master_timeout' + - $ref: '#/components/parameters/indices.exists_index_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.exists_index_template::query.local' + responses: + '200': + $ref: '#/components/responses/indices.exists_index_template@200' + post: + operationId: indices.put_index_template.0 + x-operation-group: indices.put_index_template + x-version-added: '1.0' + description: Creates or updates an index template. + parameters: + - $ref: '#/components/parameters/indices.put_index_template::path.name' + - $ref: '#/components/parameters/indices.put_index_template::query.create' + - $ref: '#/components/parameters/indices.put_index_template::query.cause' + - $ref: '#/components/parameters/indices.put_index_template::query.master_timeout' + - $ref: '#/components/parameters/indices.put_index_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.put_index_template' + responses: + '200': + $ref: '#/components/responses/indices.put_index_template@200' + put: + operationId: indices.put_index_template.1 + x-operation-group: indices.put_index_template + x-version-added: '1.0' + description: Creates or updates an index template. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-templates/ + parameters: + - $ref: '#/components/parameters/indices.put_index_template::path.name' + - $ref: '#/components/parameters/indices.put_index_template::query.create' + - $ref: '#/components/parameters/indices.put_index_template::query.cause' + - $ref: '#/components/parameters/indices.put_index_template::query.master_timeout' + - $ref: '#/components/parameters/indices.put_index_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.put_index_template' + responses: + '200': + $ref: '#/components/responses/indices.put_index_template@200' + /_mapping: + get: + operationId: indices.get_mapping.0 + x-operation-group: indices.get_mapping + x-version-added: '1.0' + description: Returns mappings for one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest/field-types/index/#get-a-mapping + parameters: + - $ref: '#/components/parameters/indices.get_mapping::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_mapping::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_mapping::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_mapping::query.master_timeout' + - $ref: '#/components/parameters/indices.get_mapping::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_mapping::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_mapping@200' + /_mapping/field/{fields}: + get: + operationId: indices.get_field_mapping.0 + x-operation-group: indices.get_field_mapping + x-version-added: '1.0' + description: Returns mapping for one or more fields. + externalDocs: + url: https://opensearch.org/docs/latest/field-types/index/ + parameters: + - $ref: '#/components/parameters/indices.get_field_mapping::path.fields' + - $ref: '#/components/parameters/indices.get_field_mapping::query.include_defaults' + - $ref: '#/components/parameters/indices.get_field_mapping::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_field_mapping::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_field_mapping::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_field_mapping::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_field_mapping@200' + /_recovery: + get: + operationId: indices.recovery.0 + x-operation-group: indices.recovery + x-version-added: '1.0' + description: Returns information about ongoing index shard recoveries. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.recovery::query.detailed' + - $ref: '#/components/parameters/indices.recovery::query.active_only' + responses: + '200': + $ref: '#/components/responses/indices.recovery@200' + /_refresh: + get: + operationId: indices.refresh.0 + x-operation-group: indices.refresh + x-version-added: '1.0' + description: Performs the refresh operation in one or more indices. + parameters: + - $ref: '#/components/parameters/indices.refresh::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.refresh::query.allow_no_indices' + - $ref: '#/components/parameters/indices.refresh::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.refresh@200' + post: + operationId: indices.refresh.1 + x-operation-group: indices.refresh + x-version-added: '1.0' + description: Performs the refresh operation in one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/remote-store/index/#refresh-level-and-request-level-durability + parameters: + - $ref: '#/components/parameters/indices.refresh::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.refresh::query.allow_no_indices' + - $ref: '#/components/parameters/indices.refresh::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.refresh@200' + /_resolve/index/{name}: + get: + operationId: indices.resolve_index.0 + x-operation-group: indices.resolve_index + x-version-added: '1.0' + description: Returns information about any matching indices, aliases, and data streams. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.resolve_index::path.name' + - $ref: '#/components/parameters/indices.resolve_index::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.resolve_index@200' + /_segments: + get: + operationId: indices.segments.0 + x-operation-group: indices.segments + x-version-added: '1.0' + description: Provides low-level information about segments in a Lucene index. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.segments::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.segments::query.allow_no_indices' + - $ref: '#/components/parameters/indices.segments::query.expand_wildcards' + - $ref: '#/components/parameters/indices.segments::query.verbose' + responses: + '200': + $ref: '#/components/responses/indices.segments@200' + /_settings: + get: + operationId: indices.get_settings.0 + x-operation-group: indices.get_settings + x-version-added: '1.0' + description: Returns settings for one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/ + parameters: + - $ref: '#/components/parameters/indices.get_settings::query.master_timeout' + - $ref: '#/components/parameters/indices.get_settings::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_settings::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_settings::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_settings::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_settings::query.flat_settings' + - $ref: '#/components/parameters/indices.get_settings::query.local' + - $ref: '#/components/parameters/indices.get_settings::query.include_defaults' + responses: + '200': + $ref: '#/components/responses/indices.get_settings@200' + put: + operationId: indices.put_settings.0 + x-operation-group: indices.put_settings + x-version-added: '1.0' + description: Updates the index settings. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/update-settings/ + parameters: + - $ref: '#/components/parameters/indices.put_settings::query.master_timeout' + - $ref: '#/components/parameters/indices.put_settings::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_settings::query.timeout' + - $ref: '#/components/parameters/indices.put_settings::query.preserve_existing' + - $ref: '#/components/parameters/indices.put_settings::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.put_settings::query.allow_no_indices' + - $ref: '#/components/parameters/indices.put_settings::query.expand_wildcards' + - $ref: '#/components/parameters/indices.put_settings::query.flat_settings' + requestBody: + $ref: '#/components/requestBodies/indices.put_settings' + responses: + '200': + $ref: '#/components/responses/indices.put_settings@200' + /_settings/{name}: + get: + operationId: indices.get_settings.1 + x-operation-group: indices.get_settings + x-version-added: '1.0' + description: Returns settings for one or more indices. + parameters: + - $ref: '#/components/parameters/indices.get_settings::path.name' + - $ref: '#/components/parameters/indices.get_settings::query.master_timeout' + - $ref: '#/components/parameters/indices.get_settings::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_settings::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_settings::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_settings::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_settings::query.flat_settings' + - $ref: '#/components/parameters/indices.get_settings::query.local' + - $ref: '#/components/parameters/indices.get_settings::query.include_defaults' + responses: + '200': + $ref: '#/components/responses/indices.get_settings@200' + /_shard_stores: + get: + operationId: indices.shard_stores.0 + x-operation-group: indices.shard_stores + x-version-added: '1.0' + description: Provides store information for shard copies of indices. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.shard_stores::query.status' + - $ref: '#/components/parameters/indices.shard_stores::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.shard_stores::query.allow_no_indices' + - $ref: '#/components/parameters/indices.shard_stores::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.shard_stores@200' + /_stats: + get: + operationId: indices.stats.0 + x-operation-group: indices.stats + x-version-added: '1.0' + description: Provides statistics on operations happening in an index. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.stats::query.completion_fields' + - $ref: '#/components/parameters/indices.stats::query.fielddata_fields' + - $ref: '#/components/parameters/indices.stats::query.fields' + - $ref: '#/components/parameters/indices.stats::query.groups' + - $ref: '#/components/parameters/indices.stats::query.level' + - $ref: '#/components/parameters/indices.stats::query.include_segment_file_sizes' + - $ref: '#/components/parameters/indices.stats::query.include_unloaded_segments' + - $ref: '#/components/parameters/indices.stats::query.expand_wildcards' + - $ref: '#/components/parameters/indices.stats::query.forbid_closed_indices' + responses: + '200': + $ref: '#/components/responses/indices.stats@200' + /_stats/{metric}: + get: + operationId: indices.stats.1 + x-operation-group: indices.stats + x-version-added: '1.0' + description: Provides statistics on operations happening in an index. + parameters: + - $ref: '#/components/parameters/indices.stats::path.metric' + - $ref: '#/components/parameters/indices.stats::query.completion_fields' + - $ref: '#/components/parameters/indices.stats::query.fielddata_fields' + - $ref: '#/components/parameters/indices.stats::query.fields' + - $ref: '#/components/parameters/indices.stats::query.groups' + - $ref: '#/components/parameters/indices.stats::query.level' + - $ref: '#/components/parameters/indices.stats::query.include_segment_file_sizes' + - $ref: '#/components/parameters/indices.stats::query.include_unloaded_segments' + - $ref: '#/components/parameters/indices.stats::query.expand_wildcards' + - $ref: '#/components/parameters/indices.stats::query.forbid_closed_indices' + responses: + '200': + $ref: '#/components/responses/indices.stats@200' + /_template: + get: + operationId: indices.get_template.0 + x-operation-group: indices.get_template + x-version-added: '1.0' + description: Returns an index template. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.get_template::query.flat_settings' + - $ref: '#/components/parameters/indices.get_template::query.master_timeout' + - $ref: '#/components/parameters/indices.get_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_template::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_template@200' + /_template/{name}: + delete: + operationId: indices.delete_template.0 + x-operation-group: indices.delete_template + x-version-added: '1.0' + description: Deletes an index template. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.delete_template::path.name' + - $ref: '#/components/parameters/indices.delete_template::query.timeout' + - $ref: '#/components/parameters/indices.delete_template::query.master_timeout' + - $ref: '#/components/parameters/indices.delete_template::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/indices.delete_template@200' + get: + operationId: indices.get_template.1 + x-operation-group: indices.get_template + x-version-added: '1.0' + description: Returns an index template. + parameters: + - $ref: '#/components/parameters/indices.get_template::path.name' + - $ref: '#/components/parameters/indices.get_template::query.flat_settings' + - $ref: '#/components/parameters/indices.get_template::query.master_timeout' + - $ref: '#/components/parameters/indices.get_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_template::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_template@200' + head: + operationId: indices.exists_template.0 + x-operation-group: indices.exists_template + x-version-added: '1.0' + description: Returns information about whether a particular index template exists. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.exists_template::path.name' + - $ref: '#/components/parameters/indices.exists_template::query.flat_settings' + - $ref: '#/components/parameters/indices.exists_template::query.master_timeout' + - $ref: '#/components/parameters/indices.exists_template::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.exists_template::query.local' + responses: + '200': + $ref: '#/components/responses/indices.exists_template@200' + post: + operationId: indices.put_template.0 + x-operation-group: indices.put_template + x-version-added: '1.0' + description: Creates or updates an index template. + parameters: + - $ref: '#/components/parameters/indices.put_template::path.name' + - $ref: '#/components/parameters/indices.put_template::query.order' + - $ref: '#/components/parameters/indices.put_template::query.create' + - $ref: '#/components/parameters/indices.put_template::query.master_timeout' + - $ref: '#/components/parameters/indices.put_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.put_template' + responses: + '200': + $ref: '#/components/responses/indices.put_template@200' + put: + operationId: indices.put_template.1 + x-operation-group: indices.put_template + x-version-added: '1.0' + description: Creates or updates an index template. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-templates/ + parameters: + - $ref: '#/components/parameters/indices.put_template::path.name' + - $ref: '#/components/parameters/indices.put_template::query.order' + - $ref: '#/components/parameters/indices.put_template::query.create' + - $ref: '#/components/parameters/indices.put_template::query.master_timeout' + - $ref: '#/components/parameters/indices.put_template::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.put_template' + responses: + '200': + $ref: '#/components/responses/indices.put_template@200' + /_upgrade: + get: + operationId: indices.get_upgrade.0 + x-operation-group: indices.get_upgrade + x-version-added: '1.0' + description: The _upgrade API is no longer useful and will be removed. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.get_upgrade::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_upgrade::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_upgrade::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.get_upgrade@200' + post: + operationId: indices.upgrade.0 + x-operation-group: indices.upgrade + x-version-added: '1.0' + description: The _upgrade API is no longer useful and will be removed. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.upgrade::query.allow_no_indices' + - $ref: '#/components/parameters/indices.upgrade::query.expand_wildcards' + - $ref: '#/components/parameters/indices.upgrade::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.upgrade::query.wait_for_completion' + - $ref: '#/components/parameters/indices.upgrade::query.only_ancient_segments' + responses: + '200': + $ref: '#/components/responses/indices.upgrade@200' + /_validate/query: + get: + operationId: indices.validate_query.0 + x-operation-group: indices.validate_query + x-version-added: '1.0' + description: Allows a user to validate a potentially expensive query without executing it. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.validate_query::query.explain' + - $ref: '#/components/parameters/indices.validate_query::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.validate_query::query.allow_no_indices' + - $ref: '#/components/parameters/indices.validate_query::query.expand_wildcards' + - $ref: '#/components/parameters/indices.validate_query::query.q' + - $ref: '#/components/parameters/indices.validate_query::query.analyzer' + - $ref: '#/components/parameters/indices.validate_query::query.analyze_wildcard' + - $ref: '#/components/parameters/indices.validate_query::query.default_operator' + - $ref: '#/components/parameters/indices.validate_query::query.df' + - $ref: '#/components/parameters/indices.validate_query::query.lenient' + - $ref: '#/components/parameters/indices.validate_query::query.rewrite' + - $ref: '#/components/parameters/indices.validate_query::query.all_shards' + requestBody: + $ref: '#/components/requestBodies/indices.validate_query' + responses: + '200': + $ref: '#/components/responses/indices.validate_query@200' + post: + operationId: indices.validate_query.1 + x-operation-group: indices.validate_query + x-version-added: '1.0' + description: Allows a user to validate a potentially expensive query without executing it. + parameters: + - $ref: '#/components/parameters/indices.validate_query::query.explain' + - $ref: '#/components/parameters/indices.validate_query::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.validate_query::query.allow_no_indices' + - $ref: '#/components/parameters/indices.validate_query::query.expand_wildcards' + - $ref: '#/components/parameters/indices.validate_query::query.q' + - $ref: '#/components/parameters/indices.validate_query::query.analyzer' + - $ref: '#/components/parameters/indices.validate_query::query.analyze_wildcard' + - $ref: '#/components/parameters/indices.validate_query::query.default_operator' + - $ref: '#/components/parameters/indices.validate_query::query.df' + - $ref: '#/components/parameters/indices.validate_query::query.lenient' + - $ref: '#/components/parameters/indices.validate_query::query.rewrite' + - $ref: '#/components/parameters/indices.validate_query::query.all_shards' + requestBody: + $ref: '#/components/requestBodies/indices.validate_query' + responses: + '200': + $ref: '#/components/responses/indices.validate_query@200' + /{alias}/_rollover: + post: + operationId: indices.rollover.0 + x-operation-group: indices.rollover + x-version-added: '1.0' + description: |- + Updates an alias to point to a new index when the existing index + is considered to be too large or too old. + externalDocs: + url: https://opensearch.org/docs/latest/dashboards/im-dashboards/rollover/ + parameters: + - $ref: '#/components/parameters/indices.rollover::path.alias' + - $ref: '#/components/parameters/indices.rollover::query.timeout' + - $ref: '#/components/parameters/indices.rollover::query.dry_run' + - $ref: '#/components/parameters/indices.rollover::query.master_timeout' + - $ref: '#/components/parameters/indices.rollover::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.rollover::query.wait_for_active_shards' + requestBody: + $ref: '#/components/requestBodies/indices.rollover' + responses: + '200': + $ref: '#/components/responses/indices.rollover@200' + /{alias}/_rollover/{new_index}: + post: + operationId: indices.rollover.1 + x-operation-group: indices.rollover + x-version-added: '1.0' + description: |- + Updates an alias to point to a new index when the existing index + is considered to be too large or too old. + parameters: + - $ref: '#/components/parameters/indices.rollover::path.alias' + - $ref: '#/components/parameters/indices.rollover::path.new_index' + - $ref: '#/components/parameters/indices.rollover::query.timeout' + - $ref: '#/components/parameters/indices.rollover::query.dry_run' + - $ref: '#/components/parameters/indices.rollover::query.master_timeout' + - $ref: '#/components/parameters/indices.rollover::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.rollover::query.wait_for_active_shards' + requestBody: + $ref: '#/components/requestBodies/indices.rollover' + responses: + '200': + $ref: '#/components/responses/indices.rollover@200' + /{index}: + delete: + operationId: indices.delete.0 + x-operation-group: indices.delete + x-version-added: '1.0' + description: Deletes an index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/delete-index/ + parameters: + - $ref: '#/components/parameters/indices.delete::path.index' + - $ref: '#/components/parameters/indices.delete::query.timeout' + - $ref: '#/components/parameters/indices.delete::query.master_timeout' + - $ref: '#/components/parameters/indices.delete::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.delete::query.allow_no_indices' + - $ref: '#/components/parameters/indices.delete::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.delete::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.delete@200' + get: + operationId: indices.get.0 + x-operation-group: indices.get + x-version-added: '1.0' + description: Returns information about one or more indices. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/get-index/ + parameters: + - $ref: '#/components/parameters/indices.get::path.index' + - $ref: '#/components/parameters/indices.get::query.local' + - $ref: '#/components/parameters/indices.get::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get::query.flat_settings' + - $ref: '#/components/parameters/indices.get::query.include_defaults' + - $ref: '#/components/parameters/indices.get::query.master_timeout' + - $ref: '#/components/parameters/indices.get::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/indices.get@200' + head: + operationId: indices.exists.0 + x-operation-group: indices.exists + x-version-added: '1.0' + description: Returns information about whether a particular index exists. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/exists/ + parameters: + - $ref: '#/components/parameters/indices.exists::path.index' + - $ref: '#/components/parameters/indices.exists::query.local' + - $ref: '#/components/parameters/indices.exists::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.exists::query.allow_no_indices' + - $ref: '#/components/parameters/indices.exists::query.expand_wildcards' + - $ref: '#/components/parameters/indices.exists::query.flat_settings' + - $ref: '#/components/parameters/indices.exists::query.include_defaults' + responses: + '200': + $ref: '#/components/responses/indices.exists@200' + put: + operationId: indices.create.0 + x-operation-group: indices.create + x-version-added: '1.0' + description: Creates an index with optional settings and mappings. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/create-index/ + parameters: + - $ref: '#/components/parameters/indices.create::path.index' + - $ref: '#/components/parameters/indices.create::query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.create::query.timeout' + - $ref: '#/components/parameters/indices.create::query.master_timeout' + - $ref: '#/components/parameters/indices.create::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.create' + responses: + '200': + $ref: '#/components/responses/indices.create@200' + /{index}/_alias: + get: + operationId: indices.get_alias.2 + x-operation-group: indices.get_alias + x-version-added: '1.0' + description: Returns an alias. + parameters: + - $ref: '#/components/parameters/indices.get_alias::path.index' + - $ref: '#/components/parameters/indices.get_alias::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_alias::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_alias::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_alias::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_alias@200' + /{index}/_alias/{name}: + delete: + operationId: indices.delete_alias.0 + x-operation-group: indices.delete_alias + x-version-added: '1.0' + description: Deletes an alias. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-alias/#delete-aliases + parameters: + - $ref: '#/components/parameters/indices.delete_alias::path.index' + - $ref: '#/components/parameters/indices.delete_alias::path.name' + - $ref: '#/components/parameters/indices.delete_alias::query.timeout' + - $ref: '#/components/parameters/indices.delete_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.delete_alias::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/indices.delete_alias@200' + get: + operationId: indices.get_alias.3 + x-operation-group: indices.get_alias + x-version-added: '1.0' + description: Returns an alias. + parameters: + - $ref: '#/components/parameters/indices.get_alias::path.index' + - $ref: '#/components/parameters/indices.get_alias::path.name' + - $ref: '#/components/parameters/indices.get_alias::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_alias::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_alias::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_alias::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_alias@200' + head: + operationId: indices.exists_alias.1 + x-operation-group: indices.exists_alias + x-version-added: '1.0' + description: Returns information about whether a particular alias exists. + parameters: + - $ref: '#/components/parameters/indices.exists_alias::path.index' + - $ref: '#/components/parameters/indices.exists_alias::path.name' + - $ref: '#/components/parameters/indices.exists_alias::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.exists_alias::query.allow_no_indices' + - $ref: '#/components/parameters/indices.exists_alias::query.expand_wildcards' + - $ref: '#/components/parameters/indices.exists_alias::query.local' + responses: + '200': + $ref: '#/components/responses/indices.exists_alias@200' + post: + operationId: indices.put_alias.0 + x-operation-group: indices.put_alias + x-version-added: '1.0' + description: Creates or updates an alias. + parameters: + - $ref: '#/components/parameters/indices.put_alias::path.index' + - $ref: '#/components/parameters/indices.put_alias::path.name' + - $ref: '#/components/parameters/indices.put_alias::query.timeout' + - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.put_alias' + responses: + '200': + $ref: '#/components/responses/indices.put_alias@200' + put: + operationId: indices.put_alias.1 + x-operation-group: indices.put_alias + x-version-added: '1.0' + description: Creates or updates an alias. + externalDocs: + url: https://opensearch.org/docs/latest/im-plugin/index-alias/#create-aliases + parameters: + - $ref: '#/components/parameters/indices.put_alias::path.index' + - $ref: '#/components/parameters/indices.put_alias::path.name' + - $ref: '#/components/parameters/indices.put_alias::query.timeout' + - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.put_alias' + responses: + '200': + $ref: '#/components/responses/indices.put_alias@200' + /{index}/_aliases/{name}: + delete: + operationId: indices.delete_alias.1 + x-operation-group: indices.delete_alias + x-version-added: '1.0' + description: Deletes an alias. + parameters: + - $ref: '#/components/parameters/indices.delete_alias::path.index' + - $ref: '#/components/parameters/indices.delete_alias::path.name' + - $ref: '#/components/parameters/indices.delete_alias::query.timeout' + - $ref: '#/components/parameters/indices.delete_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.delete_alias::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/indices.delete_alias@200' + post: + operationId: indices.put_alias.2 + x-operation-group: indices.put_alias + x-version-added: '1.0' + description: Creates or updates an alias. + parameters: + - $ref: '#/components/parameters/indices.put_alias::path.index' + - $ref: '#/components/parameters/indices.put_alias::path.name' + - $ref: '#/components/parameters/indices.put_alias::query.timeout' + - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.put_alias' + responses: + '200': + $ref: '#/components/responses/indices.put_alias@200' + put: + operationId: indices.put_alias.3 + x-operation-group: indices.put_alias + x-version-added: '1.0' + description: Creates or updates an alias. + parameters: + - $ref: '#/components/parameters/indices.put_alias::path.index' + - $ref: '#/components/parameters/indices.put_alias::path.name' + - $ref: '#/components/parameters/indices.put_alias::query.timeout' + - $ref: '#/components/parameters/indices.put_alias::query.master_timeout' + - $ref: '#/components/parameters/indices.put_alias::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.put_alias' + responses: + '200': + $ref: '#/components/responses/indices.put_alias@200' + /{index}/_analyze: + get: + operationId: indices.analyze.2 + x-operation-group: indices.analyze + x-version-added: '1.0' + description: Performs the analysis process on a text and return the tokens breakdown of the text. + parameters: + - $ref: '#/components/parameters/indices.analyze::path.index' + - $ref: '#/components/parameters/indices.analyze::query.index' + requestBody: + $ref: '#/components/requestBodies/indices.analyze' + responses: + '200': + $ref: '#/components/responses/indices.analyze@200' + post: + operationId: indices.analyze.3 + x-operation-group: indices.analyze + x-version-added: '1.0' + description: Performs the analysis process on a text and return the tokens breakdown of the text. + parameters: + - $ref: '#/components/parameters/indices.analyze::path.index' + - $ref: '#/components/parameters/indices.analyze::query.index' + requestBody: + $ref: '#/components/requestBodies/indices.analyze' + responses: + '200': + $ref: '#/components/responses/indices.analyze@200' + /{index}/_block/{block}: + put: + operationId: indices.add_block.0 + x-operation-group: indices.add_block + x-version-added: '1.0' + description: Adds a block to an index. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/indices.add_block::path.index' + - $ref: '#/components/parameters/indices.add_block::path.block' + - $ref: '#/components/parameters/indices.add_block::query.timeout' + - $ref: '#/components/parameters/indices.add_block::query.master_timeout' + - $ref: '#/components/parameters/indices.add_block::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.add_block::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.add_block::query.allow_no_indices' + - $ref: '#/components/parameters/indices.add_block::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.add_block@200' + /{index}/_cache/clear: + post: + operationId: indices.clear_cache.1 + x-operation-group: indices.clear_cache + x-version-added: '1.0' + description: Clears all or specific caches for one or more indices. + parameters: + - $ref: '#/components/parameters/indices.clear_cache::path.index' + - $ref: '#/components/parameters/indices.clear_cache::query.fielddata' + - $ref: '#/components/parameters/indices.clear_cache::query.fields' + - $ref: '#/components/parameters/indices.clear_cache::query.query' + - $ref: '#/components/parameters/indices.clear_cache::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.clear_cache::query.allow_no_indices' + - $ref: '#/components/parameters/indices.clear_cache::query.expand_wildcards' + - $ref: '#/components/parameters/indices.clear_cache::query.index' + - $ref: '#/components/parameters/indices.clear_cache::query.request' + responses: + '200': + $ref: '#/components/responses/indices.clear_cache@200' + /{index}/_clone/{target}: + post: + operationId: indices.clone.0 + x-operation-group: indices.clone + x-version-added: '1.0' + description: Clones an index. + parameters: + - $ref: '#/components/parameters/indices.clone::path.index' + - $ref: '#/components/parameters/indices.clone::path.target' + - $ref: '#/components/parameters/indices.clone::query.timeout' + - $ref: '#/components/parameters/indices.clone::query.master_timeout' + - $ref: '#/components/parameters/indices.clone::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.clone::query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.clone::query.wait_for_completion' + - $ref: '#/components/parameters/indices.clone::query.task_execution_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.clone' + responses: + '200': + $ref: '#/components/responses/indices.clone@200' + put: + operationId: indices.clone.1 + x-operation-group: indices.clone + x-version-added: '1.0' + description: Clones an index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/clone/ + parameters: + - $ref: '#/components/parameters/indices.clone::path.index' + - $ref: '#/components/parameters/indices.clone::path.target' + - $ref: '#/components/parameters/indices.clone::query.timeout' + - $ref: '#/components/parameters/indices.clone::query.master_timeout' + - $ref: '#/components/parameters/indices.clone::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.clone::query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.clone::query.wait_for_completion' + - $ref: '#/components/parameters/indices.clone::query.task_execution_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.clone' + responses: + '200': + $ref: '#/components/responses/indices.clone@200' + /{index}/_close: + post: + operationId: indices.close.0 + x-operation-group: indices.close + x-version-added: '1.0' + description: Closes an index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/close-index/ + parameters: + - $ref: '#/components/parameters/indices.close::path.index' + - $ref: '#/components/parameters/indices.close::query.timeout' + - $ref: '#/components/parameters/indices.close::query.master_timeout' + - $ref: '#/components/parameters/indices.close::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.close::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.close::query.allow_no_indices' + - $ref: '#/components/parameters/indices.close::query.expand_wildcards' + - $ref: '#/components/parameters/indices.close::query.wait_for_active_shards' + responses: + '200': + $ref: '#/components/responses/indices.close@200' + /{index}/_flush: + get: + operationId: indices.flush.2 + x-operation-group: indices.flush + x-version-added: '1.0' + description: Performs the flush operation on one or more indices. + parameters: + - $ref: '#/components/parameters/indices.flush::path.index' + - $ref: '#/components/parameters/indices.flush::query.force' + - $ref: '#/components/parameters/indices.flush::query.wait_if_ongoing' + - $ref: '#/components/parameters/indices.flush::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.flush::query.allow_no_indices' + - $ref: '#/components/parameters/indices.flush::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.flush@200' + post: + operationId: indices.flush.3 + x-operation-group: indices.flush + x-version-added: '1.0' + description: Performs the flush operation on one or more indices. + parameters: + - $ref: '#/components/parameters/indices.flush::path.index' + - $ref: '#/components/parameters/indices.flush::query.force' + - $ref: '#/components/parameters/indices.flush::query.wait_if_ongoing' + - $ref: '#/components/parameters/indices.flush::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.flush::query.allow_no_indices' + - $ref: '#/components/parameters/indices.flush::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.flush@200' + /{index}/_forcemerge: + post: + operationId: indices.forcemerge.1 + x-operation-group: indices.forcemerge + x-version-added: '1.0' + description: Performs the force merge operation on one or more indices. + parameters: + - $ref: '#/components/parameters/indices.forcemerge::path.index' + - $ref: '#/components/parameters/indices.forcemerge::query.flush' + - $ref: '#/components/parameters/indices.forcemerge::query.primary_only' + - $ref: '#/components/parameters/indices.forcemerge::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.forcemerge::query.allow_no_indices' + - $ref: '#/components/parameters/indices.forcemerge::query.expand_wildcards' + - $ref: '#/components/parameters/indices.forcemerge::query.max_num_segments' + - $ref: '#/components/parameters/indices.forcemerge::query.only_expunge_deletes' + - $ref: '#/components/parameters/indices.forcemerge::query.wait_for_completion' + responses: + '200': + $ref: '#/components/responses/indices.forcemerge@200' + /{index}/_mapping: + get: + operationId: indices.get_mapping.1 + x-operation-group: indices.get_mapping + x-version-added: '1.0' + description: Returns mappings for one or more indices. + parameters: + - $ref: '#/components/parameters/indices.get_mapping::path.index' + - $ref: '#/components/parameters/indices.get_mapping::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_mapping::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_mapping::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_mapping::query.master_timeout' + - $ref: '#/components/parameters/indices.get_mapping::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_mapping::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_mapping@200' + post: + operationId: indices.put_mapping.0 + x-operation-group: indices.put_mapping + x-version-added: '1.0' + description: Updates the index mappings. + parameters: + - $ref: '#/components/parameters/indices.put_mapping::path.index' + - $ref: '#/components/parameters/indices.put_mapping::query.timeout' + - $ref: '#/components/parameters/indices.put_mapping::query.master_timeout' + - $ref: '#/components/parameters/indices.put_mapping::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_mapping::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.put_mapping::query.allow_no_indices' + - $ref: '#/components/parameters/indices.put_mapping::query.expand_wildcards' + - $ref: '#/components/parameters/indices.put_mapping::query.write_index_only' + requestBody: + $ref: '#/components/requestBodies/indices.put_mapping' + responses: + '200': + $ref: '#/components/responses/indices.put_mapping@200' + put: + operationId: indices.put_mapping.1 + x-operation-group: indices.put_mapping + x-version-added: '1.0' + description: Updates the index mappings. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/put-mapping/ + parameters: + - $ref: '#/components/parameters/indices.put_mapping::path.index' + - $ref: '#/components/parameters/indices.put_mapping::query.timeout' + - $ref: '#/components/parameters/indices.put_mapping::query.master_timeout' + - $ref: '#/components/parameters/indices.put_mapping::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_mapping::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.put_mapping::query.allow_no_indices' + - $ref: '#/components/parameters/indices.put_mapping::query.expand_wildcards' + - $ref: '#/components/parameters/indices.put_mapping::query.write_index_only' + requestBody: + $ref: '#/components/requestBodies/indices.put_mapping' + responses: + '200': + $ref: '#/components/responses/indices.put_mapping@200' + /{index}/_mapping/field/{fields}: + get: + operationId: indices.get_field_mapping.1 + x-operation-group: indices.get_field_mapping + x-version-added: '1.0' + description: Returns mapping for one or more fields. + parameters: + - $ref: '#/components/parameters/indices.get_field_mapping::path.index' + - $ref: '#/components/parameters/indices.get_field_mapping::path.fields' + - $ref: '#/components/parameters/indices.get_field_mapping::query.include_defaults' + - $ref: '#/components/parameters/indices.get_field_mapping::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_field_mapping::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_field_mapping::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_field_mapping::query.local' + responses: + '200': + $ref: '#/components/responses/indices.get_field_mapping@200' + /{index}/_open: + post: + operationId: indices.open.0 + x-operation-group: indices.open + x-version-added: '1.0' + description: Opens an index. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/open-index/ + parameters: + - $ref: '#/components/parameters/indices.open::path.index' + - $ref: '#/components/parameters/indices.open::query.timeout' + - $ref: '#/components/parameters/indices.open::query.master_timeout' + - $ref: '#/components/parameters/indices.open::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.open::query.allow_no_indices' + - $ref: '#/components/parameters/indices.open::query.expand_wildcards' + - $ref: '#/components/parameters/indices.open::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.open::query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.open::query.wait_for_completion' + - $ref: '#/components/parameters/indices.open::query.task_execution_timeout' + responses: + '200': + $ref: '#/components/responses/indices.open@200' + /{index}/_recovery: + get: + operationId: indices.recovery.1 + x-operation-group: indices.recovery + x-version-added: '1.0' + description: Returns information about ongoing index shard recoveries. + parameters: + - $ref: '#/components/parameters/indices.recovery::path.index' + - $ref: '#/components/parameters/indices.recovery::query.detailed' + - $ref: '#/components/parameters/indices.recovery::query.active_only' + responses: + '200': + $ref: '#/components/responses/indices.recovery@200' + /{index}/_refresh: + get: + operationId: indices.refresh.2 + x-operation-group: indices.refresh + x-version-added: '1.0' + description: Performs the refresh operation in one or more indices. + parameters: + - $ref: '#/components/parameters/indices.refresh::path.index' + - $ref: '#/components/parameters/indices.refresh::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.refresh::query.allow_no_indices' + - $ref: '#/components/parameters/indices.refresh::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.refresh@200' + post: + operationId: indices.refresh.3 + x-operation-group: indices.refresh + x-version-added: '1.0' + description: Performs the refresh operation in one or more indices. + parameters: + - $ref: '#/components/parameters/indices.refresh::path.index' + - $ref: '#/components/parameters/indices.refresh::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.refresh::query.allow_no_indices' + - $ref: '#/components/parameters/indices.refresh::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.refresh@200' + /{index}/_segments: + get: + operationId: indices.segments.1 + x-operation-group: indices.segments + x-version-added: '1.0' + description: Provides low-level information about segments in a Lucene index. + parameters: + - $ref: '#/components/parameters/indices.segments::path.index' + - $ref: '#/components/parameters/indices.segments::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.segments::query.allow_no_indices' + - $ref: '#/components/parameters/indices.segments::query.expand_wildcards' + - $ref: '#/components/parameters/indices.segments::query.verbose' + responses: + '200': + $ref: '#/components/responses/indices.segments@200' + /{index}/_settings: + get: + operationId: indices.get_settings.2 + x-operation-group: indices.get_settings + x-version-added: '1.0' + description: Returns settings for one or more indices. + parameters: + - $ref: '#/components/parameters/indices.get_settings::path.index' + - $ref: '#/components/parameters/indices.get_settings::query.master_timeout' + - $ref: '#/components/parameters/indices.get_settings::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_settings::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_settings::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_settings::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_settings::query.flat_settings' + - $ref: '#/components/parameters/indices.get_settings::query.local' + - $ref: '#/components/parameters/indices.get_settings::query.include_defaults' + responses: + '200': + $ref: '#/components/responses/indices.get_settings@200' + put: + operationId: indices.put_settings.1 + x-operation-group: indices.put_settings + x-version-added: '1.0' + description: Updates the index settings. + parameters: + - $ref: '#/components/parameters/indices.put_settings::path.index' + - $ref: '#/components/parameters/indices.put_settings::query.master_timeout' + - $ref: '#/components/parameters/indices.put_settings::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.put_settings::query.timeout' + - $ref: '#/components/parameters/indices.put_settings::query.preserve_existing' + - $ref: '#/components/parameters/indices.put_settings::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.put_settings::query.allow_no_indices' + - $ref: '#/components/parameters/indices.put_settings::query.expand_wildcards' + - $ref: '#/components/parameters/indices.put_settings::query.flat_settings' + requestBody: + $ref: '#/components/requestBodies/indices.put_settings' + responses: + '200': + $ref: '#/components/responses/indices.put_settings@200' + /{index}/_settings/{name}: + get: + operationId: indices.get_settings.3 + x-operation-group: indices.get_settings + x-version-added: '1.0' + description: Returns settings for one or more indices. + parameters: + - $ref: '#/components/parameters/indices.get_settings::path.index' + - $ref: '#/components/parameters/indices.get_settings::path.name' + - $ref: '#/components/parameters/indices.get_settings::query.master_timeout' + - $ref: '#/components/parameters/indices.get_settings::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.get_settings::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_settings::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_settings::query.expand_wildcards' + - $ref: '#/components/parameters/indices.get_settings::query.flat_settings' + - $ref: '#/components/parameters/indices.get_settings::query.local' + - $ref: '#/components/parameters/indices.get_settings::query.include_defaults' + responses: + '200': + $ref: '#/components/responses/indices.get_settings@200' + /{index}/_shard_stores: + get: + operationId: indices.shard_stores.1 + x-operation-group: indices.shard_stores + x-version-added: '1.0' + description: Provides store information for shard copies of indices. + parameters: + - $ref: '#/components/parameters/indices.shard_stores::path.index' + - $ref: '#/components/parameters/indices.shard_stores::query.status' + - $ref: '#/components/parameters/indices.shard_stores::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.shard_stores::query.allow_no_indices' + - $ref: '#/components/parameters/indices.shard_stores::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.shard_stores@200' + /{index}/_shrink/{target}: + post: + operationId: indices.shrink.0 + x-operation-group: indices.shrink + x-version-added: '1.0' + description: Allow to shrink an existing index into a new index with fewer primary shards. + parameters: + - $ref: '#/components/parameters/indices.shrink::path.index' + - $ref: '#/components/parameters/indices.shrink::path.target' + - $ref: '#/components/parameters/indices.shrink::query.copy_settings' + - $ref: '#/components/parameters/indices.shrink::query.timeout' + - $ref: '#/components/parameters/indices.shrink::query.master_timeout' + - $ref: '#/components/parameters/indices.shrink::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.shrink::query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.shrink::query.wait_for_completion' + - $ref: '#/components/parameters/indices.shrink::query.task_execution_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.shrink' + responses: + '200': + $ref: '#/components/responses/indices.shrink@200' + put: + operationId: indices.shrink.1 + x-operation-group: indices.shrink + x-version-added: '1.0' + description: Allow to shrink an existing index into a new index with fewer primary shards. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/ + parameters: + - $ref: '#/components/parameters/indices.shrink::path.index' + - $ref: '#/components/parameters/indices.shrink::path.target' + - $ref: '#/components/parameters/indices.shrink::query.copy_settings' + - $ref: '#/components/parameters/indices.shrink::query.timeout' + - $ref: '#/components/parameters/indices.shrink::query.master_timeout' + - $ref: '#/components/parameters/indices.shrink::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.shrink::query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.shrink::query.wait_for_completion' + - $ref: '#/components/parameters/indices.shrink::query.task_execution_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.shrink' + responses: + '200': + $ref: '#/components/responses/indices.shrink@200' + /{index}/_split/{target}: + post: + operationId: indices.split.0 + x-operation-group: indices.split + x-version-added: '1.0' + description: Allows you to split an existing index into a new index with more primary shards. + parameters: + - $ref: '#/components/parameters/indices.split::path.index' + - $ref: '#/components/parameters/indices.split::path.target' + - $ref: '#/components/parameters/indices.split::query.copy_settings' + - $ref: '#/components/parameters/indices.split::query.timeout' + - $ref: '#/components/parameters/indices.split::query.master_timeout' + - $ref: '#/components/parameters/indices.split::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.split::query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.split::query.wait_for_completion' + - $ref: '#/components/parameters/indices.split::query.task_execution_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.split' + responses: + '200': + $ref: '#/components/responses/indices.split@200' + put: + operationId: indices.split.1 + x-operation-group: indices.split + x-version-added: '1.0' + description: Allows you to split an existing index into a new index with more primary shards. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/index-apis/split/ + parameters: + - $ref: '#/components/parameters/indices.split::path.index' + - $ref: '#/components/parameters/indices.split::path.target' + - $ref: '#/components/parameters/indices.split::query.copy_settings' + - $ref: '#/components/parameters/indices.split::query.timeout' + - $ref: '#/components/parameters/indices.split::query.master_timeout' + - $ref: '#/components/parameters/indices.split::query.cluster_manager_timeout' + - $ref: '#/components/parameters/indices.split::query.wait_for_active_shards' + - $ref: '#/components/parameters/indices.split::query.wait_for_completion' + - $ref: '#/components/parameters/indices.split::query.task_execution_timeout' + requestBody: + $ref: '#/components/requestBodies/indices.split' + responses: + '200': + $ref: '#/components/responses/indices.split@200' + /{index}/_stats: + get: + operationId: indices.stats.2 + x-operation-group: indices.stats + x-version-added: '1.0' + description: Provides statistics on operations happening in an index. + parameters: + - $ref: '#/components/parameters/indices.stats::path.index' + - $ref: '#/components/parameters/indices.stats::query.completion_fields' + - $ref: '#/components/parameters/indices.stats::query.fielddata_fields' + - $ref: '#/components/parameters/indices.stats::query.fields' + - $ref: '#/components/parameters/indices.stats::query.groups' + - $ref: '#/components/parameters/indices.stats::query.level' + - $ref: '#/components/parameters/indices.stats::query.include_segment_file_sizes' + - $ref: '#/components/parameters/indices.stats::query.include_unloaded_segments' + - $ref: '#/components/parameters/indices.stats::query.expand_wildcards' + - $ref: '#/components/parameters/indices.stats::query.forbid_closed_indices' + responses: + '200': + $ref: '#/components/responses/indices.stats@200' + /{index}/_stats/{metric}: + get: + operationId: indices.stats.3 + x-operation-group: indices.stats + x-version-added: '1.0' + description: Provides statistics on operations happening in an index. + parameters: + - $ref: '#/components/parameters/indices.stats::path.index' + - $ref: '#/components/parameters/indices.stats::path.metric' + - $ref: '#/components/parameters/indices.stats::query.completion_fields' + - $ref: '#/components/parameters/indices.stats::query.fielddata_fields' + - $ref: '#/components/parameters/indices.stats::query.fields' + - $ref: '#/components/parameters/indices.stats::query.groups' + - $ref: '#/components/parameters/indices.stats::query.level' + - $ref: '#/components/parameters/indices.stats::query.include_segment_file_sizes' + - $ref: '#/components/parameters/indices.stats::query.include_unloaded_segments' + - $ref: '#/components/parameters/indices.stats::query.expand_wildcards' + - $ref: '#/components/parameters/indices.stats::query.forbid_closed_indices' + responses: + '200': + $ref: '#/components/responses/indices.stats@200' + /{index}/_upgrade: + get: + operationId: indices.get_upgrade.1 + x-operation-group: indices.get_upgrade + x-version-added: '1.0' + description: The _upgrade API is no longer useful and will be removed. + parameters: + - $ref: '#/components/parameters/indices.get_upgrade::path.index' + - $ref: '#/components/parameters/indices.get_upgrade::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.get_upgrade::query.allow_no_indices' + - $ref: '#/components/parameters/indices.get_upgrade::query.expand_wildcards' + responses: + '200': + $ref: '#/components/responses/indices.get_upgrade@200' + post: + operationId: indices.upgrade.1 + x-operation-group: indices.upgrade + x-version-added: '1.0' + description: The _upgrade API is no longer useful and will be removed. + parameters: + - $ref: '#/components/parameters/indices.upgrade::path.index' + - $ref: '#/components/parameters/indices.upgrade::query.allow_no_indices' + - $ref: '#/components/parameters/indices.upgrade::query.expand_wildcards' + - $ref: '#/components/parameters/indices.upgrade::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.upgrade::query.wait_for_completion' + - $ref: '#/components/parameters/indices.upgrade::query.only_ancient_segments' + responses: + '200': + $ref: '#/components/responses/indices.upgrade@200' + /{index}/_validate/query: + get: + operationId: indices.validate_query.2 + x-operation-group: indices.validate_query + x-version-added: '1.0' + description: Allows a user to validate a potentially expensive query without executing it. + parameters: + - $ref: '#/components/parameters/indices.validate_query::path.index' + - $ref: '#/components/parameters/indices.validate_query::query.explain' + - $ref: '#/components/parameters/indices.validate_query::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.validate_query::query.allow_no_indices' + - $ref: '#/components/parameters/indices.validate_query::query.expand_wildcards' + - $ref: '#/components/parameters/indices.validate_query::query.q' + - $ref: '#/components/parameters/indices.validate_query::query.analyzer' + - $ref: '#/components/parameters/indices.validate_query::query.analyze_wildcard' + - $ref: '#/components/parameters/indices.validate_query::query.default_operator' + - $ref: '#/components/parameters/indices.validate_query::query.df' + - $ref: '#/components/parameters/indices.validate_query::query.lenient' + - $ref: '#/components/parameters/indices.validate_query::query.rewrite' + - $ref: '#/components/parameters/indices.validate_query::query.all_shards' + requestBody: + $ref: '#/components/requestBodies/indices.validate_query' + responses: + '200': + $ref: '#/components/responses/indices.validate_query@200' + post: + operationId: indices.validate_query.3 + x-operation-group: indices.validate_query + x-version-added: '1.0' + description: Allows a user to validate a potentially expensive query without executing it. + parameters: + - $ref: '#/components/parameters/indices.validate_query::path.index' + - $ref: '#/components/parameters/indices.validate_query::query.explain' + - $ref: '#/components/parameters/indices.validate_query::query.ignore_unavailable' + - $ref: '#/components/parameters/indices.validate_query::query.allow_no_indices' + - $ref: '#/components/parameters/indices.validate_query::query.expand_wildcards' + - $ref: '#/components/parameters/indices.validate_query::query.q' + - $ref: '#/components/parameters/indices.validate_query::query.analyzer' + - $ref: '#/components/parameters/indices.validate_query::query.analyze_wildcard' + - $ref: '#/components/parameters/indices.validate_query::query.default_operator' + - $ref: '#/components/parameters/indices.validate_query::query.df' + - $ref: '#/components/parameters/indices.validate_query::query.lenient' + - $ref: '#/components/parameters/indices.validate_query::query.rewrite' + - $ref: '#/components/parameters/indices.validate_query::query.all_shards' + requestBody: + $ref: '#/components/requestBodies/indices.validate_query' + responses: + '200': + $ref: '#/components/responses/indices.validate_query@200' +components: + requestBodies: + indices.analyze: + content: + application/json: + schema: + type: object + properties: + analyzer: + description: |- + The name of the analyzer that should be applied to the provided `text`. + This could be a built-in analyzer, or an analyzer that’s been configured in the index. + type: string + attributes: + description: Array of token attributes used to filter the output of the `explain` parameter. + type: array + items: + type: string + char_filter: + description: Array of character filters used to preprocess characters before the tokenizer. + type: array + items: + $ref: '../schemas/_common.analysis.yaml#/components/schemas/CharFilter' + explain: + description: If `true`, the response includes token attributes and additional details. + type: boolean + field: + $ref: '../schemas/_common.yaml#/components/schemas/Field' + filter: + description: Array of token filters used to apply after the tokenizer. + type: array + items: + $ref: '../schemas/_common.analysis.yaml#/components/schemas/TokenFilter' + normalizer: + description: Normalizer to use to convert text into a single token. + type: string + text: + $ref: '../schemas/indices.analyze.yaml#/components/schemas/TextToAnalyze' + tokenizer: + $ref: '../schemas/_common.analysis.yaml#/components/schemas/Tokenizer' + description: Define analyzer/tokenizer parameters and the text on which the analysis should be performed + indices.clone: + content: + application/json: + schema: + type: object + properties: + aliases: + description: Aliases for the resulting index. + type: object + additionalProperties: + $ref: '../schemas/indices._common.yaml#/components/schemas/Alias' + settings: + description: Configuration options for the target index. + type: object + additionalProperties: + type: object + description: The configuration for the target index (`settings` and `aliases`) + indices.create: + content: + application/json: + schema: + type: object + properties: + aliases: + description: Aliases for the index. + type: object + additionalProperties: + $ref: '../schemas/indices._common.yaml#/components/schemas/Alias' + mappings: + $ref: '../schemas/_common.mapping.yaml#/components/schemas/TypeMapping' + settings: + $ref: '../schemas/indices._common.yaml#/components/schemas/IndexSettings' + description: The configuration for the index (`settings` and `mappings`) + indices.create_data_stream: + content: + application/json: + schema: + type: object + description: The data stream definition + indices.put_alias: + content: + application/json: + schema: + type: object + properties: + filter: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer' + index_routing: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + is_write_index: + description: >- + If `true`, sets the write index or data stream for the alias. + + If an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests. + + If an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index. + + Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream. + type: boolean + routing: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + search_routing: + $ref: '../schemas/_common.yaml#/components/schemas/Routing' + description: The settings for the alias, such as `routing` or `filter` + indices.put_index_template: + content: + application/json: + schema: + type: object + properties: + index_patterns: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + composed_of: + description: >- + An ordered list of component template names. + + Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + type: array + items: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + template: + $ref: '../schemas/indices.put_index_template.yaml#/components/schemas/IndexTemplateMapping' + data_stream: + $ref: '../schemas/indices._common.yaml#/components/schemas/DataStreamVisibility' + priority: + description: |- + Priority to determine index template precedence when a new data stream or index is created. + The index template with the highest priority is chosen. + If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + This number is not automatically generated by Opensearch. + type: number + version: + $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' + _meta: + $ref: '../schemas/_common.yaml#/components/schemas/Metadata' + description: The template definition + required: true + indices.put_mapping: + content: + application/json: + schema: + type: object + properties: + date_detection: + description: Controls whether dynamic date detection is enabled. + type: boolean + dynamic: + $ref: '../schemas/_common.mapping.yaml#/components/schemas/DynamicMapping' + dynamic_date_formats: + description: |- + 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. + type: array + items: + type: string + dynamic_templates: + description: Specify dynamic templates for the mapping. + oneOf: + - type: object + additionalProperties: + $ref: '../schemas/_common.mapping.yaml#/components/schemas/DynamicTemplate' + - type: array + items: + type: object + additionalProperties: + $ref: '../schemas/_common.mapping.yaml#/components/schemas/DynamicTemplate' + _field_names: + $ref: '../schemas/_common.mapping.yaml#/components/schemas/FieldNamesField' + _meta: + $ref: '../schemas/_common.yaml#/components/schemas/Metadata' + numeric_detection: + description: Automatically map strings into numeric data types for all fields. + type: boolean + properties: + description: |- + Mapping for a field. For new fields, this mapping can include: + + - Field name + - Field data type + - Mapping parameters + type: object + additionalProperties: + $ref: '../schemas/_common.mapping.yaml#/components/schemas/Property' + _routing: + $ref: '../schemas/_common.mapping.yaml#/components/schemas/RoutingField' + _source: + $ref: '../schemas/_common.mapping.yaml#/components/schemas/SourceField' + runtime: + $ref: '../schemas/_common.mapping.yaml#/components/schemas/RuntimeFields' + description: The mapping definition + required: true + indices.put_settings: + content: + application/json: + schema: + $ref: '../schemas/indices._common.yaml#/components/schemas/IndexSettings' + required: true + indices.put_template: + content: + application/json: + schema: + type: object + properties: + aliases: + description: Aliases for the index. + type: object + additionalProperties: + $ref: '../schemas/indices._common.yaml#/components/schemas/Alias' + index_patterns: + description: |- + Array of wildcard expressions used to match the names + of indices during creation. + oneOf: + - type: string + - type: array + items: + type: string + mappings: + $ref: '../schemas/_common.mapping.yaml#/components/schemas/TypeMapping' + order: + description: |- + Order in which Opensearch 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. + type: number + settings: + description: Configuration options for the index. + type: object + additionalProperties: + type: object + version: + $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' + description: The template definition + required: true + indices.rollover: + content: + application/json: + schema: + type: object + properties: + aliases: + description: |- + Aliases for the target index. + Data streams do not support this parameter. + type: object + additionalProperties: + $ref: '../schemas/indices._common.yaml#/components/schemas/Alias' + conditions: + $ref: '../schemas/indices.rollover.yaml#/components/schemas/RolloverConditions' + mappings: + $ref: '../schemas/_common.mapping.yaml#/components/schemas/TypeMapping' + settings: + description: |- + Configuration options for the index. + Data streams do not support this parameter. + type: object + additionalProperties: + type: object + description: The conditions that needs to be met for executing rollover + indices.shrink: + content: + application/json: + schema: + type: object + properties: + aliases: + description: |- + The key is the alias name. + Index alias names support date math. + type: object + additionalProperties: + $ref: '../schemas/indices._common.yaml#/components/schemas/Alias' + settings: + description: Configuration options for the target index. + type: object + additionalProperties: + type: object + description: The configuration for the target index (`settings` and `aliases`) + indices.simulate_index_template: + content: + application/json: + schema: + type: object + properties: + allow_auto_create: + description: >- + This setting overrides the value of the `action.auto_create_index` cluster setting. + + If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`. + + If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. + type: boolean + index_patterns: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + composed_of: + description: >- + An ordered list of component template names. + + Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + type: array + items: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + template: + $ref: '../schemas/indices.put_index_template.yaml#/components/schemas/IndexTemplateMapping' + data_stream: + $ref: '../schemas/indices._common.yaml#/components/schemas/DataStreamVisibility' + priority: + description: |- + Priority to determine index template precedence when a new data stream or index is created. + The index template with the highest priority is chosen. + If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + This number is not automatically generated by Opensearch. + type: number + version: + $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' + _meta: + $ref: '../schemas/_common.yaml#/components/schemas/Metadata' + description: New index template definition, which will be included in the simulation, as if it already exists in the + system + indices.simulate_template: + content: + application/json: + schema: + $ref: '../schemas/indices._common.yaml#/components/schemas/IndexTemplate' + indices.split: + content: + application/json: + schema: + type: object + properties: + aliases: + description: Aliases for the resulting index. + type: object + additionalProperties: + $ref: '../schemas/indices._common.yaml#/components/schemas/Alias' + settings: + description: Configuration options for the target index. + type: object + additionalProperties: + type: object + description: The configuration for the target index (`settings` and `aliases`) + indices.update_aliases: + content: + application/json: + schema: + type: object + properties: + actions: + description: Actions to perform. + type: array + items: + $ref: '../schemas/indices.update_aliases.yaml#/components/schemas/Action' + description: The definition of `actions` to perform + required: true + indices.validate_query: + content: + application/json: + schema: + type: object + properties: + query: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/QueryContainer' + description: The query definition specified with the Query DSL + responses: + indices.add_block@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + shards_acknowledged: + type: boolean + indices: + type: array + items: + $ref: '../schemas/indices.add_block.yaml#/components/schemas/IndicesBlockStatus' + required: + - acknowledged + - shards_acknowledged + - indices + indices.analyze@200: + description: '' + content: + application/json: + schema: + type: object + properties: + detail: + $ref: '../schemas/indices.analyze.yaml#/components/schemas/AnalyzeDetail' + tokens: + type: array + items: + $ref: '../schemas/indices.analyze.yaml#/components/schemas/AnalyzeToken' + indices.clear_cache@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ShardsOperationResponseBase' + indices.clone@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + index: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + shards_acknowledged: + type: boolean + required: + - acknowledged + - index + - shards_acknowledged + indices.close@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + indices: + type: object + additionalProperties: + $ref: '../schemas/indices.close.yaml#/components/schemas/CloseIndexResult' + shards_acknowledged: + type: boolean + required: + - acknowledged + - indices + - shards_acknowledged + indices.create@200: + description: '' + content: + application/json: + schema: + type: object + properties: + index: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + shards_acknowledged: + type: boolean + acknowledged: + type: boolean + required: + - index + - shards_acknowledged + - acknowledged + indices.create_data_stream@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + indices.data_streams_stats@200: + description: '' + content: + application/json: + schema: + type: object + properties: + _shards: + $ref: '../schemas/_common.yaml#/components/schemas/ShardStatistics' + backing_indices: + description: Total number of backing indices for the selected data streams. + type: number + data_stream_count: + description: Total number of selected data streams. + type: number + data_streams: + description: Contains statistics for the selected data streams. + type: array + items: + $ref: '../schemas/indices.data_streams_stats.yaml#/components/schemas/DataStreamsStatsItem' + total_store_sizes: + $ref: '../schemas/_common.yaml#/components/schemas/ByteSize' + total_store_size_bytes: + description: Total size, in bytes, of all shards for the selected data streams. + type: number + required: + - _shards + - backing_indices + - data_stream_count + - data_streams + - total_store_size_bytes + indices.delete@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndicesResponseBase' + indices.delete_alias@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + indices.delete_data_stream@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + indices.delete_index_template@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + indices.delete_template@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + indices.exists@200: + description: '' + content: + application/json: {} + indices.exists_alias@200: + description: '' + content: + application/json: {} + indices.exists_index_template@200: + description: '' + content: + application/json: {} + indices.exists_template@200: + description: '' + content: + application/json: {} + indices.flush@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ShardsOperationResponseBase' + indices.forcemerge@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/indices.forcemerge._types.yaml#/components/schemas/ForceMergeResponseBody' + indices.get@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '../schemas/indices._common.yaml#/components/schemas/IndexState' + indices.get_alias@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '../schemas/indices.get_alias.yaml#/components/schemas/IndexAliases' + indices.get_data_stream@200: + description: '' + content: + application/json: + schema: + type: object + properties: + data_streams: + type: array + items: + $ref: '../schemas/indices._common.yaml#/components/schemas/DataStream' + required: + - data_streams + indices.get_field_mapping@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '../schemas/indices.get_field_mapping.yaml#/components/schemas/TypeFieldMappings' + indices.get_index_template@200: + description: '' + content: + application/json: + schema: + type: object + properties: + index_templates: + type: array + items: + $ref: '../schemas/indices.get_index_template.yaml#/components/schemas/IndexTemplateItem' + required: + - index_templates + indices.get_mapping@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '../schemas/indices.get_mapping.yaml#/components/schemas/IndexMappingRecord' + indices.get_settings@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '../schemas/indices._common.yaml#/components/schemas/IndexState' + indices.get_template@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '../schemas/indices._common.yaml#/components/schemas/TemplateMapping' + indices.get_upgrade@200: + description: '' + indices.open@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + shards_acknowledged: + type: boolean + required: + - acknowledged + - shards_acknowledged + indices.put_alias@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + indices.put_index_template@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + indices.put_mapping@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndicesResponseBase' + indices.put_settings@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + indices.put_template@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + indices.recovery@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '../schemas/indices.recovery.yaml#/components/schemas/RecoveryStatus' + indices.refresh@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ShardsOperationResponseBase' + indices.resolve_index@200: + description: '' + content: + application/json: + schema: + type: object + properties: + indices: + type: array + items: + $ref: '../schemas/indices.resolve_index.yaml#/components/schemas/ResolveIndexItem' + aliases: + type: array + items: + $ref: '../schemas/indices.resolve_index.yaml#/components/schemas/ResolveIndexAliasItem' + data_streams: + type: array + items: + $ref: '../schemas/indices.resolve_index.yaml#/components/schemas/ResolveIndexDataStreamsItem' + required: + - indices + - aliases + - data_streams + indices.rollover@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + conditions: + type: object + additionalProperties: + type: boolean + dry_run: + type: boolean + new_index: + type: string + old_index: + type: string + rolled_over: + type: boolean + shards_acknowledged: + type: boolean + required: + - acknowledged + - conditions + - dry_run + - new_index + - old_index + - rolled_over + - shards_acknowledged + indices.segments@200: + description: '' + content: + application/json: + schema: + type: object + properties: + indices: + type: object + additionalProperties: + $ref: '../schemas/indices.segments.yaml#/components/schemas/IndexSegment' + _shards: + $ref: '../schemas/_common.yaml#/components/schemas/ShardStatistics' + required: + - indices + - _shards + indices.shard_stores@200: + description: '' + content: + application/json: + schema: + type: object + properties: + indices: + type: object + additionalProperties: + $ref: '../schemas/indices.shard_stores.yaml#/components/schemas/IndicesShardStores' + required: + - indices + indices.shrink@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + shards_acknowledged: + type: boolean + index: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + required: + - acknowledged + - shards_acknowledged + - index + indices.simulate_index_template@200: + description: '' + content: + application/json: + schema: + type: object + indices.simulate_template@200: + description: '' + content: + application/json: + schema: + type: object + properties: + overlapping: + type: array + items: + $ref: '../schemas/indices.simulate_template.yaml#/components/schemas/Overlapping' + template: + $ref: '../schemas/indices.simulate_template.yaml#/components/schemas/Template' + required: + - template + indices.split@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + shards_acknowledged: + type: boolean + index: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + required: + - acknowledged + - shards_acknowledged + - index + indices.stats@200: + description: '' + content: + application/json: + schema: + type: object + properties: + indices: + type: object + additionalProperties: + $ref: '../schemas/indices.stats.yaml#/components/schemas/IndicesStats' + _shards: + $ref: '../schemas/_common.yaml#/components/schemas/ShardStatistics' + _all: + $ref: '../schemas/indices.stats.yaml#/components/schemas/IndicesStats' + required: + - _shards + - _all + indices.update_aliases@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + indices.upgrade@200: + description: '' + indices.validate_query@200: + description: '' + content: + application/json: + schema: + type: object + properties: + explanations: + type: array + items: + $ref: '../schemas/indices.validate_query.yaml#/components/schemas/IndicesValidationExplanation' + _shards: + $ref: '../schemas/_common.yaml#/components/schemas/ShardStatistics' + valid: + type: boolean + error: + type: string + required: + - valid + parameters: + indices.add_block::path.block: + in: path + name: block + description: The block to add (one of read, write, read_only or metadata) + required: true + schema: + $ref: '../schemas/indices.add_block.yaml#/components/schemas/IndicesBlockOptions' + style: simple + indices.add_block::path.index: + in: path + name: index + description: A comma separated list of indices to add a block to + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + indices.add_block::query.allow_no_indices: + in: query + name: allow_no_indices + 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) + schema: + type: boolean + style: form + indices.add_block::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.add_block::query.expand_wildcards: + in: query + name: expand_wildcards + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.add_block::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: Whether specified concrete indices should be ignored when unavailable (missing or closed) + schema: + type: boolean + style: form + indices.add_block::query.master_timeout: + in: query + name: master_timeout + description: Specify timeout for connection to master + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.add_block::query.timeout: + in: query + name: timeout + description: Explicit operation timeout + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + indices.analyze::path.index: + in: path + name: index + description: >- + Index used to derive the analyzer. + + If specified, the `analyzer` or field parameter overrides this value. + + If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + indices.analyze::query.index: + name: index + in: query + description: The name of the index to scope the operation. + schema: + type: string + description: The name of the index to scope the operation. + indices.clear_cache::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.clear_cache::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.clear_cache::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.clear_cache::query.fielddata: + in: query + name: fielddata + description: |- + If `true`, clears the fields cache. + Use the `fields` parameter to clear the cache of specific fields only. + schema: + type: boolean + style: form + indices.clear_cache::query.fields: + in: query + name: fields + description: Comma-separated list of field names used to limit the `fielddata` parameter. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + indices.clear_cache::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.clear_cache::query.index: + name: index + in: query + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + explode: true + indices.clear_cache::query.query: + in: query + name: query + description: If `true`, clears the query cache. + schema: + type: boolean + style: form + indices.clear_cache::query.request: + in: query + name: request + description: If `true`, clears the request cache. + schema: + type: boolean + style: form + indices.clone::path.index: + in: path + name: index + description: Name of the source index to clone. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + indices.clone::path.target: + in: path + name: target + description: Name of the target index to create. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + indices.clone::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.clone::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.clone::query.task_execution_timeout: + name: task_execution_timeout + in: query + description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + indices.clone::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + indices.clone::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' + style: form + indices.clone::query.wait_for_completion: + name: wait_for_completion + in: query + description: Should this request wait until the operation has completed before returning. + schema: + type: boolean + default: true + description: Should this request wait until the operation has completed before returning. + indices.close::path.index: + in: path + name: index + description: Comma-separated list or wildcard expression of index names used to limit the request. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.close::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.close::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.close::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.close::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.close::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.close::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + indices.close::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' + style: form + indices.create::path.index: + in: path + name: index + description: Name of the index you wish to create. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + indices.create::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.create::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.create::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + indices.create::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' + style: form + indices.create_data_stream::path.name: + in: path + name: name + description: |- + Name of the data stream, which must meet the following criteria: + Lowercase only; + Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `#`, `:`, or a space character; + Cannot start with `-`, `_`, `+`, or `.ds-`; + Cannot be `.` or `..`; + Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/DataStreamName' + style: simple + indices.data_streams_stats::path.name: + in: path + name: name + description: |- + Comma-separated list of data streams used to limit the request. + Wildcard expressions (`*`) are supported. + To target all data streams in a cluster, omit this parameter or use `*`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + indices.delete::path.index: + in: path + name: index + description: |- + Comma-separated list of indices to delete. + You cannot specify index aliases. + By default, this parameter does not support wildcards (`*`) or `_all`. + To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.delete::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.delete::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.delete::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.delete::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.delete::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.delete::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + indices.delete_alias::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams or indices used to limit the request. + Supports wildcards (`*`). + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.delete_alias::path.name: + in: path + name: name + description: |- + Comma-separated list of aliases to remove. + Supports wildcards (`*`). To remove all aliases, use `*` or `_all`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + indices.delete_alias::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.delete_alias::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.delete_alias::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + indices.delete_data_stream::path.name: + in: path + name: name + description: Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/DataStreamNames' + style: simple + indices.delete_index_template::path.name: + in: path + name: name + description: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + indices.delete_index_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.delete_index_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.delete_index_template::query.timeout: + in: query + name: timeout + description: Period to wait for a response. If no response is received before the timeout expires, the request fails and + returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + indices.delete_template::path.name: + in: path + name: name + description: |- + The name of the legacy index template to delete. + Wildcard (`*`) expressions are supported. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + indices.delete_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.delete_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.delete_template::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + indices.exists::path.index: + in: path + name: index + description: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.exists::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.exists::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.exists::query.flat_settings: + in: query + name: flat_settings + description: If `true`, returns settings in flat format. + schema: + type: boolean + style: form + indices.exists::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.exists::query.include_defaults: + in: query + name: include_defaults + description: If `true`, return all default settings in the response. + schema: + type: boolean + style: form + indices.exists::query.local: + in: query + name: local + description: If `true`, the request retrieves information from the local node only. + schema: + type: boolean + style: form + indices.exists_alias::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). + To target all data streams and indices, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.exists_alias::path.name: + in: path + name: name + description: Comma-separated list of aliases to check. Supports wildcards (`*`). + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + indices.exists_alias::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.exists_alias::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.exists_alias::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, requests that include a missing data stream or index in the target indices or data streams + return an error. + schema: + type: boolean + style: form + indices.exists_alias::query.local: + in: query + name: local + description: If `true`, the request retrieves information from the local node only. + schema: + type: boolean + style: form + indices.exists_index_template::path.name: + in: path + name: name + description: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + indices.exists_index_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.exists_index_template::query.flat_settings: + name: flat_settings + in: query + description: Return settings in flat format. + schema: + type: boolean + default: false + description: Return settings in flat format. + indices.exists_index_template::query.local: + name: local + in: query + description: Return local information, do not retrieve the state from cluster-manager node. + schema: + type: boolean + default: false + description: Return local information, do not retrieve the state from cluster-manager node. + indices.exists_index_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.exists_template::path.name: + in: path + name: name + description: The comma separated names of the index templates + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + indices.exists_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.exists_template::query.flat_settings: + in: query + name: flat_settings + description: 'Return settings in flat format (default: false)' + schema: + type: boolean + style: form + indices.exists_template::query.local: + in: query + name: local + description: 'Return local information, do not retrieve the state from master node (default: false)' + schema: + type: boolean + style: form + indices.exists_template::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.flush::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases to flush. + Supports wildcards (`*`). + To flush all data streams and indices, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.flush::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.flush::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.flush::query.force: + in: query + name: force + description: If `true`, the request forces a flush even if there are no changes to commit to the index. + schema: + type: boolean + style: form + indices.flush::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.flush::query.wait_if_ongoing: + in: query + name: wait_if_ongoing + description: |- + If `true`, the flush operation blocks until execution when another flush operation is running. + If `false`, Opensearch returns an error if you request a flush when another flush operation is running. + schema: + type: boolean + style: form + indices.forcemerge::path.index: + in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.forcemerge::query.allow_no_indices: + in: query + name: allow_no_indices + 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) + schema: + type: boolean + style: form + indices.forcemerge::query.expand_wildcards: + in: query + name: expand_wildcards + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.forcemerge::query.flush: + in: query + name: flush + description: 'Specify whether the index should be flushed after performing the operation (default: true)' + schema: + type: boolean + style: form + indices.forcemerge::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: Whether specified concrete indices should be ignored when unavailable (missing or closed) + schema: + type: boolean + style: form + indices.forcemerge::query.max_num_segments: + in: query + name: max_num_segments + description: 'The number of segments the index should be merged into (default: dynamic)' + schema: + type: number + style: form + indices.forcemerge::query.only_expunge_deletes: + in: query + name: only_expunge_deletes + description: Specify whether the operation should only expunge deleted documents + schema: + type: boolean + style: form + indices.forcemerge::query.primary_only: + name: primary_only + in: query + description: Specify whether the operation should only perform on primary shards. Defaults to false. + schema: + type: boolean + default: false + description: Specify whether the operation should only perform on primary shards. Defaults to false. + indices.forcemerge::query.wait_for_completion: + in: query + name: wait_for_completion + description: Should the request wait until the force merge is completed. + schema: + type: boolean + style: form + indices.get::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and index aliases used to limit the request. + Wildcard expressions (*) are supported. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.get::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.get::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.get::query.expand_wildcards: + in: query + name: expand_wildcards + 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.get::query.flat_settings: + in: query + name: flat_settings + description: If true, returns settings in flat format. + schema: + type: boolean + style: form + indices.get::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If false, requests that target a missing index return an error. + schema: + type: boolean + style: form + indices.get::query.include_defaults: + in: query + name: include_defaults + description: If true, return all default settings in the response. + schema: + type: boolean + style: form + indices.get::query.local: + in: query + name: local + description: If true, the request retrieves information from the local node only. Defaults to false, which means + information is retrieved from the master node. + schema: + type: boolean + style: form + indices.get::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.get_alias::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams or indices used to limit the request. + Supports wildcards (`*`). + To target all data streams and indices, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.get_alias::path.name: + in: path + name: name + description: |- + Comma-separated list of aliases to retrieve. + Supports wildcards (`*`). + To retrieve all aliases, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + indices.get_alias::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.get_alias::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.get_alias::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.get_alias::query.local: + in: query + name: local + description: If `true`, the request retrieves information from the local node only. + schema: + type: boolean + style: form + indices.get_data_stream::path.name: + in: path + name: name + description: |- + Comma-separated list of data stream names used to limit the request. + Wildcard (`*`) expressions are supported. If omitted, all data streams are returned. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/DataStreamNames' + style: simple + indices.get_field_mapping::path.fields: + in: path + name: fields + description: Comma-separated list or wildcard expression of fields used to limit returned information. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: simple + indices.get_field_mapping::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.get_field_mapping::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.get_field_mapping::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.get_field_mapping::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.get_field_mapping::query.include_defaults: + in: query + name: include_defaults + description: If `true`, return all default settings in the response. + schema: + type: boolean + style: form + indices.get_field_mapping::query.local: + in: query + name: local + description: If `true`, the request retrieves information from the local node only. + schema: + type: boolean + style: form + indices.get_index_template::path.name: + in: path + name: name + description: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + indices.get_index_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.get_index_template::query.flat_settings: + in: query + name: flat_settings + description: If true, returns settings in flat format. + schema: + type: boolean + style: form + indices.get_index_template::query.local: + in: query + name: local + description: If true, the request retrieves information from the local node only. Defaults to false, which means + information is retrieved from the master node. + schema: + type: boolean + style: form + indices.get_index_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.get_mapping::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.get_mapping::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.get_mapping::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.get_mapping::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.get_mapping::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.get_mapping::query.local: + in: query + name: local + description: If `true`, the request retrieves information from the local node only. + schema: + type: boolean + style: form + indices.get_mapping::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.get_settings::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.get_settings::path.name: + in: path + name: name + description: Comma-separated list or wildcard expression of settings to retrieve. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + indices.get_settings::query.allow_no_indices: + in: query + name: allow_no_indices + 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`. + schema: + type: boolean + style: form + indices.get_settings::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.get_settings::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.get_settings::query.flat_settings: + in: query + name: flat_settings + description: If `true`, returns settings in flat format. + schema: + type: boolean + style: form + indices.get_settings::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.get_settings::query.include_defaults: + in: query + name: include_defaults + description: If `true`, return all default settings in the response. + schema: + type: boolean + style: form + indices.get_settings::query.local: + in: query + name: local + description: |- + If `true`, the request retrieves information from the local node only. If + `false`, information is retrieved from the master node. + schema: + type: boolean + style: form + indices.get_settings::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.get_template::path.name: + in: path + name: name + description: |- + Comma-separated list of index template names used to limit the request. + Wildcard (`*`) expressions are supported. + To return all index templates, omit this parameter or use a value of `_all` or `*`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + indices.get_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.get_template::query.flat_settings: + in: query + name: flat_settings + description: If `true`, returns settings in flat format. + schema: + type: boolean + style: form + indices.get_template::query.local: + in: query + name: local + description: If `true`, the request retrieves information from the local node only. + schema: + type: boolean + style: form + indices.get_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.get_upgrade::path.index: + name: index + in: path + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + x-data-type: array + required: true + indices.get_upgrade::query.allow_no_indices: + name: allow_no_indices + in: 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). + schema: + type: boolean + 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). + indices.get_upgrade::query.expand_wildcards: + name: expand_wildcards + in: query + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + indices.get_upgrade::query.ignore_unavailable: + name: ignore_unavailable + in: query + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + schema: + type: boolean + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + indices.open::path.index: + in: path + name: index + description: >- + Comma-separated list of data streams, indices, and aliases used to limit the request. + + Supports wildcards (`*`). + + By default, you must explicitly name the indices you using to limit the request. + + To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. + + You can update this setting in the `opensearch.yml` file or using the cluster update settings API. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.open::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.open::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.open::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.open::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.open::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.open::query.task_execution_timeout: + name: task_execution_timeout + in: query + description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + indices.open::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + indices.open::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' + style: form + indices.open::query.wait_for_completion: + name: wait_for_completion + in: query + description: Should this request wait until the operation has completed before returning. + schema: + type: boolean + default: true + description: Should this request wait until the operation has completed before returning. + indices.put_alias::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams or indices to add. + Supports wildcards (`*`). + Wildcard patterns that match both data streams and indices return an error. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.put_alias::path.name: + in: path + name: name + description: |- + Alias to update. + If the alias doesn’t exist, the request creates it. + Index alias names support date math. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + indices.put_alias::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.put_alias::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.put_alias::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + indices.put_index_template::path.name: + in: path + name: name + description: Index or template name + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + indices.put_index_template::query.cause: + name: cause + in: query + description: User defined reason for creating/updating the index template. + schema: + type: string + default: 'false' + description: User defined reason for creating/updating the index template. + indices.put_index_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.put_index_template::query.create: + in: query + name: create + description: If `true`, this request cannot replace or update existing index templates. + schema: + type: boolean + style: form + indices.put_index_template::query.master_timeout: + name: master_timeout + in: query + description: Operation timeout for connection to master node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + deprecated: true + indices.put_mapping::path.index: + in: path + name: index + 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. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.put_mapping::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.put_mapping::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.put_mapping::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.put_mapping::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.put_mapping::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.put_mapping::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + indices.put_mapping::query.write_index_only: + in: query + name: write_index_only + description: If `true`, the mappings are applied only to the current write index for the target. + schema: + type: boolean + style: form + indices.put_settings::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.put_settings::query.allow_no_indices: + in: query + name: allow_no_indices + 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`. + schema: + type: boolean + style: form + indices.put_settings::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.put_settings::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.put_settings::query.flat_settings: + in: query + name: flat_settings + description: If `true`, returns settings in flat format. + schema: + type: boolean + style: form + indices.put_settings::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `true`, returns settings in flat format. + schema: + type: boolean + style: form + indices.put_settings::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.put_settings::query.preserve_existing: + in: query + name: preserve_existing + description: If `true`, existing index settings remain unchanged. + schema: + type: boolean + style: form + indices.put_settings::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. If no response is received before the + timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + indices.put_template::path.name: + in: path + name: name + description: The name of the template + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + indices.put_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.put_template::query.create: + in: query + name: create + description: If true, this request cannot replace or update existing index templates. + schema: + type: boolean + style: form + indices.put_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.put_template::query.order: + in: query + name: order + description: |- + Order in which Opensearch 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. + schema: + type: number + style: form + indices.recovery::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.recovery::query.active_only: + in: query + name: active_only + description: If `true`, the response only includes ongoing shard recoveries. + schema: + type: boolean + style: form + indices.recovery::query.detailed: + in: query + name: detailed + description: If `true`, the response includes detailed information about shard recoveries. + schema: + type: boolean + style: form + indices.refresh::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.refresh::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.refresh::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.refresh::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.resolve_index::path.name: + in: path + name: name + description: |- + Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. + Resources on remote clusters can be specified using the ``:`` syntax. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + indices.resolve_index::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.rollover::path.alias: + in: path + name: alias + description: Name of the data stream or index alias to roll over. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexAlias' + style: simple + indices.rollover::path.new_index: + in: path + name: new_index + description: |- + Name of the index to create. + Supports date math. + Data streams do not support this parameter. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + indices.rollover::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.rollover::query.dry_run: + in: query + name: dry_run + description: If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. + schema: + type: boolean + style: form + indices.rollover::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.rollover::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + indices.rollover::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' + style: form + indices.segments::path.index: + in: path + name: index + 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`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.segments::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.segments::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.segments::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.segments::query.verbose: + in: query + name: verbose + description: If `true`, the request returns a verbose response. + schema: + type: boolean + style: form + indices.shard_stores::path.index: + in: path + name: index + description: List of data streams, indices, and aliases used to limit the request. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.shard_stores::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.shard_stores::query.expand_wildcards: + in: query + name: expand_wildcards + 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. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.shard_stores::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If true, missing or closed indices are not included in the response. + schema: + type: boolean + style: form + indices.shard_stores::query.status: + in: query + name: status + description: List of shard health statuses used to limit the request. + schema: + oneOf: + - $ref: '../schemas/indices.shard_stores.yaml#/components/schemas/ShardStoreStatus' + - type: array + items: + $ref: '../schemas/indices.shard_stores.yaml#/components/schemas/ShardStoreStatus' + style: form + indices.shrink::path.index: + in: path + name: index + description: Name of the source index to shrink. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + indices.shrink::path.target: + in: path + name: target + description: Name of the target index to create. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + indices.shrink::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.shrink::query.copy_settings: + name: copy_settings + in: query + description: whether or not to copy settings from the source index. + schema: + type: boolean + default: false + description: whether or not to copy settings from the source index. + indices.shrink::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.shrink::query.task_execution_timeout: + name: task_execution_timeout + in: query + description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + indices.shrink::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + indices.shrink::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' + style: form + indices.shrink::query.wait_for_completion: + name: wait_for_completion + in: query + description: Should this request wait until the operation has completed before returning. + schema: + type: boolean + default: true + description: Should this request wait until the operation has completed before returning. + indices.simulate_index_template::path.name: + in: path + name: name + description: Index or template name to simulate + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + indices.simulate_index_template::query.cause: + name: cause + in: query + description: User defined reason for dry-run creating the new template for simulation purposes. + schema: + type: string + default: 'false' + description: User defined reason for dry-run creating the new template for simulation purposes. + indices.simulate_index_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.simulate_index_template::query.create: + in: query + name: create + 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. + schema: + type: boolean + style: form + indices.simulate_index_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.simulate_template::path.name: + in: path + name: name + 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. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + indices.simulate_template::query.cause: + name: cause + in: query + description: User defined reason for dry-run creating the new template for simulation purposes. + schema: + type: string + default: 'false' + description: User defined reason for dry-run creating the new template for simulation purposes. + indices.simulate_template::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.simulate_template::query.create: + in: query + name: create + 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. + schema: + type: boolean + style: form + indices.simulate_template::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.split::path.index: + in: path + name: index + description: Name of the source index to split. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + indices.split::path.target: + in: path + name: target + description: Name of the target index to create. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/IndexName' + style: simple + indices.split::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.split::query.copy_settings: + name: copy_settings + in: query + description: whether or not to copy settings from the source index. + schema: + type: boolean + default: false + description: whether or not to copy settings from the source index. + indices.split::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.split::query.task_execution_timeout: + name: task_execution_timeout + in: query + description: Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + indices.split::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + indices.split::query.wait_for_active_shards: + in: query + name: wait_for_active_shards + 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`). + schema: + $ref: '../schemas/_common.yaml#/components/schemas/WaitForActiveShards' + style: form + indices.split::query.wait_for_completion: + name: wait_for_completion + in: query + description: Should this request wait until the operation has completed before returning. + schema: + type: boolean + default: true + description: Should this request wait until the operation has completed before returning. + indices.stats::path.index: + in: path + name: index + description: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.stats::path.metric: + in: path + name: metric + description: Limit the information returned the specific metrics. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Metrics' + style: simple + indices.stats::query.completion_fields: + in: query + name: completion_fields + description: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + indices.stats::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.stats::query.fielddata_fields: + in: query + name: fielddata_fields + description: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + indices.stats::query.fields: + in: query + name: fields + description: Comma-separated list or wildcard expressions of fields to include in the statistics. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + indices.stats::query.forbid_closed_indices: + in: query + name: forbid_closed_indices + description: If true, statistics are not collected from closed indices. + schema: + type: boolean + style: form + indices.stats::query.groups: + in: query + name: groups + description: Comma-separated list of search groups to include in the search statistics. + schema: + oneOf: + - type: string + - type: array + items: + type: string + style: form + indices.stats::query.include_segment_file_sizes: + in: query + name: include_segment_file_sizes + description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if + segment stats are requested). + schema: + type: boolean + style: form + indices.stats::query.include_unloaded_segments: + in: query + name: include_unloaded_segments + description: If true, the response includes information from segments that are not loaded into memory. + schema: + type: boolean + style: form + indices.stats::query.level: + in: query + name: level + description: Indicates whether statistics are aggregated at the cluster, index, or shard level. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Level' + style: form + indices.update_aliases::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + indices.update_aliases::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + indices.update_aliases::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + indices.upgrade::path.index: + name: index + in: path + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + x-data-type: array + required: true + indices.upgrade::query.allow_no_indices: + name: allow_no_indices + in: 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). + schema: + type: boolean + 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). + indices.upgrade::query.expand_wildcards: + name: expand_wildcards + in: query + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + indices.upgrade::query.ignore_unavailable: + name: ignore_unavailable + in: query + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + schema: + type: boolean + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + indices.upgrade::query.only_ancient_segments: + name: only_ancient_segments + in: query + description: If true, only ancient (an older Lucene major release) segments will be upgraded. + schema: + type: boolean + description: If true, only ancient (an older Lucene major release) segments will be upgraded. + indices.upgrade::query.wait_for_completion: + name: wait_for_completion + in: query + description: Should this request wait until the operation has completed before returning. + schema: + type: boolean + default: false + description: Should this request wait until the operation has completed before returning. + indices.validate_query::path.index: + in: path + name: index + description: |- + Comma-separated list of data streams, indices, and aliases to search. + Supports wildcards (`*`). + To search all data streams or indices, omit this parameter or use `*` or `_all`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + style: simple + indices.validate_query::query.all_shards: + in: query + name: all_shards + description: If `true`, the validation is executed on all shards instead of one random shard per index. + schema: + type: boolean + style: form + indices.validate_query::query.allow_no_indices: + in: query + name: allow_no_indices + 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. + schema: + type: boolean + style: form + indices.validate_query::query.analyze_wildcard: + in: query + name: analyze_wildcard + description: If `true`, wildcard and prefix queries are analyzed. + schema: + type: boolean + style: form + indices.validate_query::query.analyzer: + in: query + name: analyzer + description: |- + Analyzer to use for the query string. + This parameter can only be used when the `q` query string parameter is specified. + schema: + type: string + style: form + indices.validate_query::query.default_operator: + in: query + name: default_operator + description: 'The default operator for query string query: `AND` or `OR`.' + schema: + $ref: '../schemas/_common.query_dsl.yaml#/components/schemas/Operator' + style: form + indices.validate_query::query.df: + in: query + name: df + description: |- + Field to use as default where no field prefix is given in the query string. + This parameter can only be used when the `q` query string parameter is specified. + schema: + type: string + style: form + indices.validate_query::query.expand_wildcards: + in: query + name: expand_wildcards + 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`. + + Valid values are: `all`, `open`, `closed`, `hidden`, `none`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + style: form + indices.validate_query::query.explain: + in: query + name: explain + description: If `true`, the response returns detailed information if an error has occurred. + schema: + type: boolean + style: form + indices.validate_query::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If `false`, the request returns an error if it targets a missing or closed index. + schema: + type: boolean + style: form + indices.validate_query::query.lenient: + in: query + name: lenient + description: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will + be ignored. + schema: + type: boolean + style: form + indices.validate_query::query.q: + in: query + name: q + description: Query in the Lucene query string syntax. + schema: + type: string + style: form + indices.validate_query::query.rewrite: + in: query + name: rewrite + description: If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. + schema: + type: boolean + style: form diff --git a/spec/namespaces/ingest.yaml b/spec/namespaces/ingest.yaml new file mode 100644 index 00000000..9dbe79bc --- /dev/null +++ b/spec/namespaces/ingest.yaml @@ -0,0 +1,344 @@ +openapi: 3.1.0 +info: + title: OpenSearch Ingest API + description: OpenSearch Ingest API + version: 1.0.0 +paths: + /_ingest/pipeline: + get: + operationId: ingest.get_pipeline.0 + x-operation-group: ingest.get_pipeline + x-version-added: '1.0' + description: Returns a pipeline. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/ingest-apis/get-ingest/ + parameters: + - $ref: '#/components/parameters/ingest.get_pipeline::query.master_timeout' + - $ref: '#/components/parameters/ingest.get_pipeline::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/ingest.get_pipeline@200' + /_ingest/pipeline/_simulate: + get: + operationId: ingest.simulate.0 + x-operation-group: ingest.simulate + x-version-added: '1.0' + description: Allows to simulate a pipeline with example documents. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/ingest-apis/simulate-ingest/ + parameters: + - $ref: '#/components/parameters/ingest.simulate::query.verbose' + requestBody: + $ref: '#/components/requestBodies/ingest.simulate' + responses: + '200': + $ref: '#/components/responses/ingest.simulate@200' + post: + operationId: ingest.simulate.1 + x-operation-group: ingest.simulate + x-version-added: '1.0' + description: Allows to simulate a pipeline with example documents. + parameters: + - $ref: '#/components/parameters/ingest.simulate::query.verbose' + requestBody: + $ref: '#/components/requestBodies/ingest.simulate' + responses: + '200': + $ref: '#/components/responses/ingest.simulate@200' + /_ingest/pipeline/{id}: + delete: + operationId: ingest.delete_pipeline.0 + x-operation-group: ingest.delete_pipeline + x-version-added: '1.0' + description: Deletes a pipeline. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/ingest-apis/delete-ingest/ + parameters: + - $ref: '#/components/parameters/ingest.delete_pipeline::path.id' + - $ref: '#/components/parameters/ingest.delete_pipeline::query.master_timeout' + - $ref: '#/components/parameters/ingest.delete_pipeline::query.cluster_manager_timeout' + - $ref: '#/components/parameters/ingest.delete_pipeline::query.timeout' + responses: + '200': + $ref: '#/components/responses/ingest.delete_pipeline@200' + get: + operationId: ingest.get_pipeline.1 + x-operation-group: ingest.get_pipeline + x-version-added: '1.0' + description: Returns a pipeline. + parameters: + - $ref: '#/components/parameters/ingest.get_pipeline::path.id' + - $ref: '#/components/parameters/ingest.get_pipeline::query.master_timeout' + - $ref: '#/components/parameters/ingest.get_pipeline::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/ingest.get_pipeline@200' + put: + operationId: ingest.put_pipeline.0 + x-operation-group: ingest.put_pipeline + x-version-added: '1.0' + description: Creates or updates a pipeline. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/ + parameters: + - $ref: '#/components/parameters/ingest.put_pipeline::path.id' + - $ref: '#/components/parameters/ingest.put_pipeline::query.master_timeout' + - $ref: '#/components/parameters/ingest.put_pipeline::query.cluster_manager_timeout' + - $ref: '#/components/parameters/ingest.put_pipeline::query.timeout' + requestBody: + $ref: '#/components/requestBodies/ingest.put_pipeline' + responses: + '200': + $ref: '#/components/responses/ingest.put_pipeline@200' + /_ingest/pipeline/{id}/_simulate: + get: + operationId: ingest.simulate.2 + x-operation-group: ingest.simulate + x-version-added: '1.0' + description: Allows to simulate a pipeline with example documents. + parameters: + - $ref: '#/components/parameters/ingest.simulate::path.id' + - $ref: '#/components/parameters/ingest.simulate::query.verbose' + requestBody: + $ref: '#/components/requestBodies/ingest.simulate' + responses: + '200': + $ref: '#/components/responses/ingest.simulate@200' + post: + operationId: ingest.simulate.3 + x-operation-group: ingest.simulate + x-version-added: '1.0' + description: Allows to simulate a pipeline with example documents. + parameters: + - $ref: '#/components/parameters/ingest.simulate::path.id' + - $ref: '#/components/parameters/ingest.simulate::query.verbose' + requestBody: + $ref: '#/components/requestBodies/ingest.simulate' + responses: + '200': + $ref: '#/components/responses/ingest.simulate@200' + /_ingest/processor/grok: + get: + operationId: ingest.processor_grok.0 + x-operation-group: ingest.processor_grok + x-version-added: '1.0' + description: Returns a list of the built-in patterns. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: [] + responses: + '200': + $ref: '#/components/responses/ingest.processor_grok@200' +components: + requestBodies: + ingest.put_pipeline: + content: + application/json: + schema: + type: object + properties: + _meta: + $ref: '../schemas/_common.yaml#/components/schemas/Metadata' + description: + description: Description of the ingest pipeline. + type: string + on_failure: + description: Processors to run immediately after a processor failure. Each processor supports a processor-level + `on_failure` value. If a processor without an `on_failure` value fails, Opensearch uses this + pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order + specified. Opensearch will not attempt to run the pipeline's remaining processors. + type: array + items: + $ref: '../schemas/ingest._common.yaml#/components/schemas/ProcessorContainer' + processors: + description: Processors used to perform transformations on documents before indexing. Processors run sequentially in the + order specified. + type: array + items: + $ref: '../schemas/ingest._common.yaml#/components/schemas/ProcessorContainer' + version: + $ref: '../schemas/_common.yaml#/components/schemas/VersionNumber' + description: The ingest definition + required: true + ingest.simulate: + content: + application/json: + schema: + type: object + properties: + docs: + description: Sample documents to test in the pipeline. + type: array + items: + $ref: '../schemas/ingest.simulate.yaml#/components/schemas/Document' + pipeline: + $ref: '../schemas/ingest._common.yaml#/components/schemas/Pipeline' + description: The simulate definition + required: true + responses: + ingest.delete_pipeline@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + ingest.get_pipeline@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '../schemas/ingest._common.yaml#/components/schemas/Pipeline' + ingest.processor_grok@200: + description: '' + content: + application/json: + schema: + type: object + properties: + patterns: + type: object + additionalProperties: + type: string + required: + - patterns + ingest.put_pipeline@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + ingest.simulate@200: + description: '' + content: + application/json: + schema: + type: object + properties: + docs: + type: array + items: + $ref: '../schemas/ingest.simulate.yaml#/components/schemas/PipelineSimulation' + required: + - docs + parameters: + ingest.delete_pipeline::path.id: + in: path + name: id + description: |- + Pipeline ID or wildcard expression of pipeline IDs used to limit the request. + To delete all ingest pipelines in a cluster, use a value of `*`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + ingest.delete_pipeline::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + ingest.delete_pipeline::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + ingest.delete_pipeline::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + ingest.get_pipeline::path.id: + in: path + name: id + description: |- + Comma-separated list of pipeline IDs to retrieve. + Wildcard (`*`) expressions are supported. + To get all ingest pipelines, omit this parameter or use `*`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + ingest.get_pipeline::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + ingest.get_pipeline::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + ingest.put_pipeline::path.id: + in: path + name: id + description: ID of the ingest pipeline to create or update. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + ingest.put_pipeline::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + ingest.put_pipeline::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + ingest.put_pipeline::query.timeout: + in: query + name: timeout + description: Period to wait for a response. If no response is received before the timeout expires, the request fails and + returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + ingest.simulate::path.id: + in: path + name: id + description: |- + Pipeline to test. + If you don’t specify a `pipeline` in the request body, this parameter is required. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + ingest.simulate::query.verbose: + in: query + name: verbose + description: If `true`, the response includes output data for each processor in the executed pipeline. + schema: + type: boolean + style: form diff --git a/spec/namespaces/knn.yaml b/spec/namespaces/knn.yaml new file mode 100644 index 00000000..b8618f38 --- /dev/null +++ b/spec/namespaces/knn.yaml @@ -0,0 +1,734 @@ +openapi: 3.1.0 +info: + title: OpenSearch Knn API + description: OpenSearch Knn API + version: 1.0.0 +paths: + /_plugins/_knn/models/_search: + get: + operationId: knn.search_models.0 + x-operation-group: knn.search_models + x-version-added: '1.0' + description: Use an OpenSearch query to search for models in the index. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/knn/api/#search-model + parameters: + - $ref: '#/components/parameters/knn.search_models::query.analyzer' + - $ref: '#/components/parameters/knn.search_models::query.analyze_wildcard' + - $ref: '#/components/parameters/knn.search_models::query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/knn.search_models::query.default_operator' + - $ref: '#/components/parameters/knn.search_models::query.df' + - $ref: '#/components/parameters/knn.search_models::query.explain' + - $ref: '#/components/parameters/knn.search_models::query.stored_fields' + - $ref: '#/components/parameters/knn.search_models::query.docvalue_fields' + - $ref: '#/components/parameters/knn.search_models::query.from' + - $ref: '#/components/parameters/knn.search_models::query.ignore_unavailable' + - $ref: '#/components/parameters/knn.search_models::query.ignore_throttled' + - $ref: '#/components/parameters/knn.search_models::query.allow_no_indices' + - $ref: '#/components/parameters/knn.search_models::query.expand_wildcards' + - $ref: '#/components/parameters/knn.search_models::query.lenient' + - $ref: '#/components/parameters/knn.search_models::query.preference' + - $ref: '#/components/parameters/knn.search_models::query.q' + - $ref: '#/components/parameters/knn.search_models::query.routing' + - $ref: '#/components/parameters/knn.search_models::query.scroll' + - $ref: '#/components/parameters/knn.search_models::query.search_type' + - $ref: '#/components/parameters/knn.search_models::query.size' + - $ref: '#/components/parameters/knn.search_models::query.sort' + - $ref: '#/components/parameters/knn.search_models::query._source' + - $ref: '#/components/parameters/knn.search_models::query._source_excludes' + - $ref: '#/components/parameters/knn.search_models::query._source_includes' + - $ref: '#/components/parameters/knn.search_models::query.terminate_after' + - $ref: '#/components/parameters/knn.search_models::query.stats' + - $ref: '#/components/parameters/knn.search_models::query.suggest_field' + - $ref: '#/components/parameters/knn.search_models::query.suggest_mode' + - $ref: '#/components/parameters/knn.search_models::query.suggest_size' + - $ref: '#/components/parameters/knn.search_models::query.suggest_text' + - $ref: '#/components/parameters/knn.search_models::query.timeout' + - $ref: '#/components/parameters/knn.search_models::query.track_scores' + - $ref: '#/components/parameters/knn.search_models::query.track_total_hits' + - $ref: '#/components/parameters/knn.search_models::query.allow_partial_search_results' + - $ref: '#/components/parameters/knn.search_models::query.typed_keys' + - $ref: '#/components/parameters/knn.search_models::query.version' + - $ref: '#/components/parameters/knn.search_models::query.seq_no_primary_term' + - $ref: '#/components/parameters/knn.search_models::query.request_cache' + - $ref: '#/components/parameters/knn.search_models::query.batched_reduce_size' + - $ref: '#/components/parameters/knn.search_models::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/knn.search_models::query.pre_filter_shard_size' + - $ref: '#/components/parameters/knn.search_models::query.rest_total_hits_as_int' + responses: + '200': + $ref: '#/components/responses/knn.search_models@200' + post: + operationId: knn.search_models.1 + x-operation-group: knn.search_models + x-version-added: '1.0' + description: Use an OpenSearch query to search for models in the index. + parameters: + - $ref: '#/components/parameters/knn.search_models::query.analyzer' + - $ref: '#/components/parameters/knn.search_models::query.analyze_wildcard' + - $ref: '#/components/parameters/knn.search_models::query.ccs_minimize_roundtrips' + - $ref: '#/components/parameters/knn.search_models::query.default_operator' + - $ref: '#/components/parameters/knn.search_models::query.df' + - $ref: '#/components/parameters/knn.search_models::query.explain' + - $ref: '#/components/parameters/knn.search_models::query.stored_fields' + - $ref: '#/components/parameters/knn.search_models::query.docvalue_fields' + - $ref: '#/components/parameters/knn.search_models::query.from' + - $ref: '#/components/parameters/knn.search_models::query.ignore_unavailable' + - $ref: '#/components/parameters/knn.search_models::query.ignore_throttled' + - $ref: '#/components/parameters/knn.search_models::query.allow_no_indices' + - $ref: '#/components/parameters/knn.search_models::query.expand_wildcards' + - $ref: '#/components/parameters/knn.search_models::query.lenient' + - $ref: '#/components/parameters/knn.search_models::query.preference' + - $ref: '#/components/parameters/knn.search_models::query.q' + - $ref: '#/components/parameters/knn.search_models::query.routing' + - $ref: '#/components/parameters/knn.search_models::query.scroll' + - $ref: '#/components/parameters/knn.search_models::query.search_type' + - $ref: '#/components/parameters/knn.search_models::query.size' + - $ref: '#/components/parameters/knn.search_models::query.sort' + - $ref: '#/components/parameters/knn.search_models::query._source' + - $ref: '#/components/parameters/knn.search_models::query._source_excludes' + - $ref: '#/components/parameters/knn.search_models::query._source_includes' + - $ref: '#/components/parameters/knn.search_models::query.terminate_after' + - $ref: '#/components/parameters/knn.search_models::query.stats' + - $ref: '#/components/parameters/knn.search_models::query.suggest_field' + - $ref: '#/components/parameters/knn.search_models::query.suggest_mode' + - $ref: '#/components/parameters/knn.search_models::query.suggest_size' + - $ref: '#/components/parameters/knn.search_models::query.suggest_text' + - $ref: '#/components/parameters/knn.search_models::query.timeout' + - $ref: '#/components/parameters/knn.search_models::query.track_scores' + - $ref: '#/components/parameters/knn.search_models::query.track_total_hits' + - $ref: '#/components/parameters/knn.search_models::query.allow_partial_search_results' + - $ref: '#/components/parameters/knn.search_models::query.typed_keys' + - $ref: '#/components/parameters/knn.search_models::query.version' + - $ref: '#/components/parameters/knn.search_models::query.seq_no_primary_term' + - $ref: '#/components/parameters/knn.search_models::query.request_cache' + - $ref: '#/components/parameters/knn.search_models::query.batched_reduce_size' + - $ref: '#/components/parameters/knn.search_models::query.max_concurrent_shard_requests' + - $ref: '#/components/parameters/knn.search_models::query.pre_filter_shard_size' + - $ref: '#/components/parameters/knn.search_models::query.rest_total_hits_as_int' + requestBody: + $ref: '#/components/requestBodies/knn.search_models' + responses: + '200': + $ref: '#/components/responses/knn.search_models@200' + /_plugins/_knn/models/_train: + post: + operationId: knn.train_model.0 + x-operation-group: knn.train_model + x-version-added: '1.0' + description: Create and train a model that can be used for initializing k-NN native library indexes during indexing. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/knn/api/#train-model + parameters: + - $ref: '#/components/parameters/knn.train_model::query.preference' + requestBody: + $ref: '#/components/requestBodies/knn.train_model' + responses: + '200': + $ref: '#/components/responses/knn.train_model@200' + /_plugins/_knn/models/{model_id}: + delete: + operationId: knn.delete_model.0 + x-operation-group: knn.delete_model + x-version-added: '1.0' + description: Used to delete a particular model in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/knn/api/#delete-model + parameters: + - $ref: '#/components/parameters/knn.delete_model::path.model_id' + responses: + '200': + $ref: '#/components/responses/knn.delete_model@200' + get: + operationId: knn.get_model.0 + x-operation-group: knn.get_model + x-version-added: '1.0' + description: Used to retrieve information about models present in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/knn/api/#get-model + parameters: + - $ref: '#/components/parameters/knn.get_model::path.model_id' + responses: + '200': + $ref: '#/components/responses/knn.get_model@200' + /_plugins/_knn/models/{model_id}/_train: + post: + operationId: knn.train_model.1 + x-operation-group: knn.train_model + x-version-added: '1.0' + description: Create and train a model that can be used for initializing k-NN native library indexes during indexing. + parameters: + - $ref: '#/components/parameters/knn.train_model::path.model_id' + - $ref: '#/components/parameters/knn.train_model::query.preference' + requestBody: + $ref: '#/components/requestBodies/knn.train_model' + responses: + '200': + $ref: '#/components/responses/knn.train_model@200' + /_plugins/_knn/stats: + get: + operationId: knn.stats.0 + x-operation-group: knn.stats + x-version-added: '1.0' + description: Provides information about the current status of the k-NN plugin. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/knn/api/#stats + parameters: + - $ref: '#/components/parameters/knn.stats::query.timeout' + responses: + '200': + $ref: '#/components/responses/knn.stats@200' + /_plugins/_knn/stats/{stat}: + get: + operationId: knn.stats.1 + x-operation-group: knn.stats + x-version-added: '1.0' + description: Provides information about the current status of the k-NN plugin. + parameters: + - $ref: '#/components/parameters/knn.stats::path.stat' + - $ref: '#/components/parameters/knn.stats::query.timeout' + responses: + '200': + $ref: '#/components/responses/knn.stats@200' + /_plugins/_knn/warmup/{index}: + get: + operationId: knn.warmup.0 + x-operation-group: knn.warmup + x-version-added: '1.0' + description: Preloads native library files into memory, reducing initial search latency for specified indexes + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/knn/api/#warmup-operation + parameters: + - $ref: '#/components/parameters/knn.warmup::path.index' + responses: + '200': + $ref: '#/components/responses/knn.warmup@200' + /_plugins/_knn/{node_id}/stats: + get: + operationId: knn.stats.2 + x-operation-group: knn.stats + x-version-added: '1.0' + description: Provides information about the current status of the k-NN plugin. + parameters: + - $ref: '#/components/parameters/knn.stats::path.node_id' + - $ref: '#/components/parameters/knn.stats::query.timeout' + responses: + '200': + $ref: '#/components/responses/knn.stats@200' + /_plugins/_knn/{node_id}/stats/{stat}: + get: + operationId: knn.stats.3 + x-operation-group: knn.stats + x-version-added: '1.0' + description: Provides information about the current status of the k-NN plugin. + parameters: + - $ref: '#/components/parameters/knn.stats::path.node_id' + - $ref: '#/components/parameters/knn.stats::path.stat' + - $ref: '#/components/parameters/knn.stats::query.timeout' + responses: + '200': + $ref: '#/components/responses/knn.stats@200' +components: + requestBodies: + knn.search_models: + content: + application/json: + schema: + type: object + knn.train_model: + content: + application/json: + schema: + type: object + properties: + training_index: + type: string + training_field: + type: string + dimension: + type: integer + format: int32 + max_training_vector_count: + type: integer + format: int32 + search_size: + type: integer + format: int32 + description: + type: string + method: + type: string + required: + - dimension + - method + - training_field + - training_index + required: true + responses: + knn.delete_model@200: + description: '' + knn.get_model@200: + description: '' + knn.search_models@200: + description: '' + knn.stats@200: + description: '' + knn.train_model@200: + description: '' + knn.warmup@200: + description: '' + parameters: + knn.delete_model::path.model_id: + name: model_id + in: path + description: The id of the model. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: The id of the model. + required: true + knn.get_model::path.model_id: + name: model_id + in: path + description: The id of the model. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: The id of the model. + required: true + knn.search_models::query._source: + name: _source + in: query + description: True or false to return the _source field or not, or a list of fields to return. + style: form + schema: + type: array + items: + type: string + description: True or false to return the _source field or not, or a list of fields to return. + explode: true + knn.search_models::query._source_excludes: + name: _source_excludes + in: query + description: List of fields to exclude from the returned _source field. + style: form + schema: + type: array + items: + type: string + description: List of fields to exclude from the returned _source field. + explode: true + knn.search_models::query._source_includes: + name: _source_includes + in: query + description: List of fields to extract and return from the _source field. + style: form + schema: + type: array + items: + type: string + description: List of fields to extract and return from the _source field. + explode: true + knn.search_models::query.allow_no_indices: + name: allow_no_indices + in: 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). + schema: + type: boolean + 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). + knn.search_models::query.allow_partial_search_results: + name: allow_partial_search_results + in: query + description: Indicate if an error should be returned if there is a partial search failure or timeout. + schema: + type: boolean + default: true + description: Indicate if an error should be returned if there is a partial search failure or timeout. + knn.search_models::query.analyze_wildcard: + name: analyze_wildcard + in: query + description: Specify whether wildcard and prefix queries should be analyzed. + schema: + type: boolean + default: false + description: Specify whether wildcard and prefix queries should be analyzed. + knn.search_models::query.analyzer: + name: analyzer + in: query + description: The analyzer to use for the query string. + schema: + type: string + description: The analyzer to use for the query string. + knn.search_models::query.batched_reduce_size: + name: batched_reduce_size + in: query + 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. + schema: + type: integer + default: 512 + 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. + format: int32 + knn.search_models::query.ccs_minimize_roundtrips: + name: ccs_minimize_roundtrips + in: query + description: Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution. + schema: + type: boolean + default: true + description: Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution. + knn.search_models::query.default_operator: + name: default_operator + in: query + description: The default operator for query string query (AND or OR). + schema: + $ref: '../schemas/knn._common.yaml#/components/schemas/DefaultOperator' + knn.search_models::query.df: + name: df + in: query + description: The field to use as default where no field prefix is given in the query string. + schema: + type: string + description: The field to use as default where no field prefix is given in the query string. + knn.search_models::query.docvalue_fields: + name: docvalue_fields + in: query + description: Comma-separated list of fields to return as the docvalue representation of a field for each hit. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of fields to return as the docvalue representation of a field for each hit. + explode: true + knn.search_models::query.expand_wildcards: + name: expand_wildcards + in: query + description: Whether to expand wildcard expression to concrete indices that are open, closed or both. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/ExpandWildcards' + knn.search_models::query.explain: + name: explain + in: query + description: Specify whether to return detailed information about score computation as part of a hit. + schema: + type: boolean + description: Specify whether to return detailed information about score computation as part of a hit. + knn.search_models::query.from: + name: from + in: query + description: Starting offset. + schema: + type: integer + default: 0 + description: Starting offset. + format: int32 + knn.search_models::query.ignore_throttled: + name: ignore_throttled + in: query + description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + schema: + type: boolean + description: Whether specified concrete, expanded or aliased indices should be ignored when throttled. + knn.search_models::query.ignore_unavailable: + name: ignore_unavailable + in: query + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + schema: + type: boolean + description: Whether specified concrete indices should be ignored when unavailable (missing or closed). + knn.search_models::query.lenient: + name: lenient + in: query + description: Specify whether format-based query failures (such as providing text to a numeric field) should be ignored. + schema: + type: boolean + description: Specify whether format-based query failures (such as providing text to a numeric field) should be ignored. + knn.search_models::query.max_concurrent_shard_requests: + name: max_concurrent_shard_requests + in: query + 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. + schema: + type: integer + default: 5 + 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. + format: int32 + knn.search_models::query.pre_filter_shard_size: + name: pre_filter_shard_size + in: query + description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the + number of shards the search request expands to exceeds the threshold. This filter round-trip 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. + schema: + type: integer + description: Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the + number of shards the search request expands to exceeds the threshold. This filter round-trip 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. + format: int32 + knn.search_models::query.preference: + name: preference + in: query + description: Specify the node or shard the operation should be performed on. + schema: + type: string + default: random + description: Specify the node or shard the operation should be performed on. + knn.search_models::query.q: + name: q + in: query + description: Query in the Lucene query string syntax. + schema: + type: string + description: Query in the Lucene query string syntax. + knn.search_models::query.request_cache: + name: request_cache + in: query + description: Specify if request cache should be used for this request or not, defaults to index level setting. + schema: + type: boolean + description: Specify if request cache should be used for this request or not, defaults to index level setting. + knn.search_models::query.rest_total_hits_as_int: + name: rest_total_hits_as_int + in: query + description: Indicates whether hits.total should be rendered as an integer or an object in the rest search response. + schema: + type: boolean + default: false + description: Indicates whether hits.total should be rendered as an integer or an object in the rest search response. + knn.search_models::query.routing: + name: routing + in: query + description: Comma-separated list of specific routing values. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of specific routing values. + explode: true + knn.search_models::query.scroll: + name: scroll + in: query + description: Specify how long a consistent view of the index should be maintained for scrolled search. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + knn.search_models::query.search_type: + name: search_type + in: query + description: Search operation type. + schema: + $ref: '../schemas/knn._common.yaml#/components/schemas/SearchType' + knn.search_models::query.seq_no_primary_term: + name: seq_no_primary_term + in: query + description: Specify whether to return sequence number and primary term of the last modification of each hit. + schema: + type: boolean + description: Specify whether to return sequence number and primary term of the last modification of each hit. + knn.search_models::query.size: + name: size + in: query + description: Number of hits to return. + schema: + type: integer + default: 10 + description: Number of hits to return. + format: int32 + knn.search_models::query.sort: + name: sort + in: query + description: Comma-separated list of : pairs. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of : pairs. + explode: true + knn.search_models::query.stats: + name: stats + in: query + description: Specific 'tag' of the request for logging and statistical purposes. + style: form + schema: + type: array + items: + type: string + description: Specific 'tag' of the request for logging and statistical purposes. + explode: true + knn.search_models::query.stored_fields: + name: stored_fields + in: query + description: Comma-separated list of stored fields to return. + style: form + schema: + type: array + items: + type: string + description: Comma-separated list of stored fields to return. + explode: true + knn.search_models::query.suggest_field: + name: suggest_field + in: query + description: Specify which field to use for suggestions. + schema: + type: string + description: Specify which field to use for suggestions. + knn.search_models::query.suggest_mode: + name: suggest_mode + in: query + description: Specify suggest mode. + schema: + $ref: '../schemas/knn._common.yaml#/components/schemas/SuggestMode' + knn.search_models::query.suggest_size: + name: suggest_size + in: query + description: How many suggestions to return in response. + schema: + type: integer + description: How many suggestions to return in response. + format: int32 + knn.search_models::query.suggest_text: + name: suggest_text + in: query + description: The source text for which the suggestions should be returned. + schema: + type: string + description: The source text for which the suggestions should be returned. + knn.search_models::query.terminate_after: + name: terminate_after + in: query + description: The maximum number of documents to collect for each shard, upon reaching which the query execution will + terminate early. + schema: + type: integer + description: The maximum number of documents to collect for each shard, upon reaching which the query execution will + terminate early. + format: int32 + knn.search_models::query.timeout: + name: timeout + in: query + description: Operation timeout. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + knn.search_models::query.track_scores: + name: track_scores + in: query + description: Whether to calculate and return scores even if they are not used for sorting. + schema: + type: boolean + description: Whether to calculate and return scores even if they are not used for sorting. + knn.search_models::query.track_total_hits: + name: track_total_hits + in: query + description: Indicate if the number of documents that match the query should be tracked. + schema: + type: boolean + description: Indicate if the number of documents that match the query should be tracked. + knn.search_models::query.typed_keys: + name: typed_keys + in: query + description: Specify whether aggregation and suggester names should be prefixed by their respective types in the response. + schema: + type: boolean + description: Specify whether aggregation and suggester names should be prefixed by their respective types in the response. + knn.search_models::query.version: + name: version + in: query + description: Whether to return document version as part of a hit. + schema: + type: boolean + description: Whether to return document version as part of a hit. + knn.stats::path.node_id: + name: node_id + in: path + description: 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. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: 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. + x-data-type: array + required: true + knn.stats::path.stat: + name: stat + in: path + description: Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats. + x-enum-options: + - circuit_breaker_triggered + - total_load_time + - eviction_count + - hit_count + - miss_count + - graph_memory_usage + - graph_memory_usage_percentage + - graph_index_requests + - graph_index_errors + - graph_query_requests + - graph_query_errors + - knn_query_requests + - cache_capacity_reached + - load_success_count + - load_exception_count + - indices_in_cache + - script_compilations + - script_compilation_errors + - script_query_requests + - script_query_errors + - nmslib_initialized + - faiss_initialized + - model_index_status + - indexing_from_model_degraded + - training_requests + - training_errors + - training_memory_usage + - training_memory_usage_percentage + x-data-type: array + required: true + knn.stats::query.timeout: + name: timeout + in: query + description: Operation timeout. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + knn.train_model::path.model_id: + name: model_id + in: path + description: The id of the model. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: The id of the model. + required: true + knn.train_model::query.preference: + name: preference + in: query + description: Preferred node to execute training. + schema: + type: string + description: Preferred node to execute training. + knn.warmup::path.index: + name: index + in: path + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: Comma-separated list of indices; use `_all` or empty string to perform the operation on all indices. + x-data-type: array + required: true diff --git a/spec/namespaces/nodes.yaml b/spec/namespaces/nodes.yaml new file mode 100644 index 00000000..cea63474 --- /dev/null +++ b/spec/namespaces/nodes.yaml @@ -0,0 +1,661 @@ +openapi: 3.1.0 +info: + title: OpenSearch Nodes API + description: OpenSearch Nodes API + version: 1.0.0 +paths: + /_cluster/nodes/hot_threads: + get: + operationId: nodes.hot_threads.0 + x-operation-group: nodes.hot_threads + x-ignorable: true + deprecated: true + x-deprecation-message: The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Returns information about hot threads on each node in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/ + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_cluster/nodes/hotthreads: + get: + operationId: nodes.hot_threads.1 + x-operation-group: nodes.hot_threads + x-ignorable: true + deprecated: true + x-deprecation-message: The hot threads API accepts `hotthreads` but only `hot_threads` is documented + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_cluster/nodes/{node_id}/hot_threads: + get: + operationId: nodes.hot_threads.2 + x-operation-group: nodes.hot_threads + x-ignorable: true + deprecated: true + x-deprecation-message: The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_cluster/nodes/{node_id}/hotthreads: + get: + operationId: nodes.hot_threads.3 + x-operation-group: nodes.hot_threads + x-ignorable: true + deprecated: true + x-deprecation-message: The hot threads API accepts `hotthreads` but only `hot_threads` is documented + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_nodes: + get: + operationId: nodes.info.0 + x-operation-group: nodes.info + x-version-added: '1.0' + description: Returns information about nodes in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/ + parameters: + - $ref: '#/components/parameters/nodes.info::query.flat_settings' + - $ref: '#/components/parameters/nodes.info::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.info@200' + /_nodes/hot_threads: + get: + operationId: nodes.hot_threads.4 + x-operation-group: nodes.hot_threads + x-version-added: '1.0' + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_nodes/hotthreads: + get: + operationId: nodes.hot_threads.5 + x-operation-group: nodes.hot_threads + x-ignorable: true + deprecated: true + x-deprecation-message: The hot threads API accepts `hotthreads` but only `hot_threads` is documented + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_nodes/reload_secure_settings: + post: + operationId: nodes.reload_secure_settings.0 + x-operation-group: nodes.reload_secure_settings + x-version-added: '1.0' + description: Reloads secure settings. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/ + parameters: + - $ref: '#/components/parameters/nodes.reload_secure_settings::query.timeout' + requestBody: + $ref: '#/components/requestBodies/nodes.reload_secure_settings' + responses: + '200': + $ref: '#/components/responses/nodes.reload_secure_settings@200' + /_nodes/stats: + get: + operationId: nodes.stats.0 + x-operation-group: nodes.stats + x-version-added: '1.0' + description: Returns statistical information about nodes in the cluster. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/ + parameters: + - $ref: '#/components/parameters/nodes.stats::query.completion_fields' + - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats::query.fields' + - $ref: '#/components/parameters/nodes.stats::query.groups' + - $ref: '#/components/parameters/nodes.stats::query.level' + - $ref: '#/components/parameters/nodes.stats::query.types' + - $ref: '#/components/parameters/nodes.stats::query.timeout' + - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + responses: + '200': + $ref: '#/components/responses/nodes.stats@200' + /_nodes/stats/{metric}: + get: + operationId: nodes.stats.1 + x-operation-group: nodes.stats + x-version-added: '1.0' + description: Returns statistical information about nodes in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.stats::path.metric' + - $ref: '#/components/parameters/nodes.stats::query.completion_fields' + - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats::query.fields' + - $ref: '#/components/parameters/nodes.stats::query.groups' + - $ref: '#/components/parameters/nodes.stats::query.level' + - $ref: '#/components/parameters/nodes.stats::query.types' + - $ref: '#/components/parameters/nodes.stats::query.timeout' + - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + responses: + '200': + $ref: '#/components/responses/nodes.stats@200' + /_nodes/stats/{metric}/{index_metric}: + get: + operationId: nodes.stats.2 + x-operation-group: nodes.stats + x-version-added: '1.0' + description: Returns statistical information about nodes in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.stats::path.metric' + - $ref: '#/components/parameters/nodes.stats::path.index_metric' + - $ref: '#/components/parameters/nodes.stats::query.completion_fields' + - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats::query.fields' + - $ref: '#/components/parameters/nodes.stats::query.groups' + - $ref: '#/components/parameters/nodes.stats::query.level' + - $ref: '#/components/parameters/nodes.stats::query.types' + - $ref: '#/components/parameters/nodes.stats::query.timeout' + - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + responses: + '200': + $ref: '#/components/responses/nodes.stats@200' + /_nodes/usage: + get: + operationId: nodes.usage.0 + x-operation-group: nodes.usage + x-version-added: '1.0' + description: Returns low-level information about REST actions usage on nodes. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/nodes.usage::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.usage@200' + /_nodes/usage/{metric}: + get: + operationId: nodes.usage.1 + x-operation-group: nodes.usage + x-version-added: '1.0' + description: Returns low-level information about REST actions usage on nodes. + parameters: + - $ref: '#/components/parameters/nodes.usage::path.metric' + - $ref: '#/components/parameters/nodes.usage::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.usage@200' + /_nodes/{node_id}: + get: + operationId: nodes.info.1 + x-operation-group: nodes.info + x-version-added: '1.0' + description: Returns information about nodes in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.info::path.node_id' + - $ref: '#/components/parameters/nodes.info::query.flat_settings' + - $ref: '#/components/parameters/nodes.info::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.info@200' + /_nodes/{node_id}/hot_threads: + get: + operationId: nodes.hot_threads.6 + x-operation-group: nodes.hot_threads + x-version-added: '1.0' + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_nodes/{node_id}/hotthreads: + get: + operationId: nodes.hot_threads.7 + x-operation-group: nodes.hot_threads + x-ignorable: true + deprecated: true + x-deprecation-message: The hot threads API accepts `hotthreads` but only `hot_threads` is documented + x-version-added: '1.0' + x-version-deprecated: '1.0' + description: Returns information about hot threads on each node in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.hot_threads::path.node_id' + - $ref: '#/components/parameters/nodes.hot_threads::query.interval' + - $ref: '#/components/parameters/nodes.hot_threads::query.snapshots' + - $ref: '#/components/parameters/nodes.hot_threads::query.threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.ignore_idle_threads' + - $ref: '#/components/parameters/nodes.hot_threads::query.type' + - $ref: '#/components/parameters/nodes.hot_threads::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.hot_threads@200' + /_nodes/{node_id}/reload_secure_settings: + post: + operationId: nodes.reload_secure_settings.1 + x-operation-group: nodes.reload_secure_settings + x-version-added: '1.0' + description: Reloads secure settings. + parameters: + - $ref: '#/components/parameters/nodes.reload_secure_settings::path.node_id' + - $ref: '#/components/parameters/nodes.reload_secure_settings::query.timeout' + requestBody: + $ref: '#/components/requestBodies/nodes.reload_secure_settings' + responses: + '200': + $ref: '#/components/responses/nodes.reload_secure_settings@200' + /_nodes/{node_id}/stats: + get: + operationId: nodes.stats.3 + x-operation-group: nodes.stats + x-version-added: '1.0' + description: Returns statistical information about nodes in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.stats::path.node_id' + - $ref: '#/components/parameters/nodes.stats::query.completion_fields' + - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats::query.fields' + - $ref: '#/components/parameters/nodes.stats::query.groups' + - $ref: '#/components/parameters/nodes.stats::query.level' + - $ref: '#/components/parameters/nodes.stats::query.types' + - $ref: '#/components/parameters/nodes.stats::query.timeout' + - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + responses: + '200': + $ref: '#/components/responses/nodes.stats@200' + /_nodes/{node_id}/stats/{metric}: + get: + operationId: nodes.stats.4 + x-operation-group: nodes.stats + x-version-added: '1.0' + description: Returns statistical information about nodes in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.stats::path.metric' + - $ref: '#/components/parameters/nodes.stats::path.node_id' + - $ref: '#/components/parameters/nodes.stats::query.completion_fields' + - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats::query.fields' + - $ref: '#/components/parameters/nodes.stats::query.groups' + - $ref: '#/components/parameters/nodes.stats::query.level' + - $ref: '#/components/parameters/nodes.stats::query.types' + - $ref: '#/components/parameters/nodes.stats::query.timeout' + - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + responses: + '200': + $ref: '#/components/responses/nodes.stats@200' + /_nodes/{node_id}/stats/{metric}/{index_metric}: + get: + operationId: nodes.stats.5 + x-operation-group: nodes.stats + x-version-added: '1.0' + description: Returns statistical information about nodes in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.stats::path.metric' + - $ref: '#/components/parameters/nodes.stats::path.index_metric' + - $ref: '#/components/parameters/nodes.stats::path.node_id' + - $ref: '#/components/parameters/nodes.stats::query.completion_fields' + - $ref: '#/components/parameters/nodes.stats::query.fielddata_fields' + - $ref: '#/components/parameters/nodes.stats::query.fields' + - $ref: '#/components/parameters/nodes.stats::query.groups' + - $ref: '#/components/parameters/nodes.stats::query.level' + - $ref: '#/components/parameters/nodes.stats::query.types' + - $ref: '#/components/parameters/nodes.stats::query.timeout' + - $ref: '#/components/parameters/nodes.stats::query.include_segment_file_sizes' + responses: + '200': + $ref: '#/components/responses/nodes.stats@200' + /_nodes/{node_id}/usage: + get: + operationId: nodes.usage.2 + x-operation-group: nodes.usage + x-version-added: '1.0' + description: Returns low-level information about REST actions usage on nodes. + parameters: + - $ref: '#/components/parameters/nodes.usage::path.node_id' + - $ref: '#/components/parameters/nodes.usage::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.usage@200' + /_nodes/{node_id}/usage/{metric}: + get: + operationId: nodes.usage.3 + x-operation-group: nodes.usage + x-version-added: '1.0' + description: Returns low-level information about REST actions usage on nodes. + parameters: + - $ref: '#/components/parameters/nodes.usage::path.metric' + - $ref: '#/components/parameters/nodes.usage::path.node_id' + - $ref: '#/components/parameters/nodes.usage::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.usage@200' + /_nodes/{node_id}/{metric}: + get: + operationId: nodes.info.2 + x-operation-group: nodes.info + x-version-added: '1.0' + description: Returns information about nodes in the cluster. + parameters: + - $ref: '#/components/parameters/nodes.info::path.node_id' + - $ref: '#/components/parameters/nodes.info::path.metric' + - $ref: '#/components/parameters/nodes.info::query.flat_settings' + - $ref: '#/components/parameters/nodes.info::query.timeout' + responses: + '200': + $ref: '#/components/responses/nodes.info@200' +components: + requestBodies: + nodes.reload_secure_settings: + content: + application/json: + schema: + type: object + properties: + secure_settings_password: + $ref: '../schemas/_common.yaml#/components/schemas/Password' + description: An object containing the password for the opensearch keystore + responses: + nodes.hot_threads@200: + description: '' + nodes.info@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/nodes.info.yaml#/components/schemas/ResponseBase' + nodes.reload_secure_settings@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/nodes.reload_secure_settings.yaml#/components/schemas/ResponseBase' + nodes.stats@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/nodes.stats.yaml#/components/schemas/ResponseBase' + nodes.usage@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/nodes.usage.yaml#/components/schemas/ResponseBase' + parameters: + nodes.hot_threads::path.node_id: + name: node_id + in: path + description: 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. + schema: + type: string + pattern: ^(?!_|template|query|field|point|clear|usage|stats|hot|reload|painless).+$ + description: 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. + x-data-type: array + required: true + nodes.hot_threads::query.ignore_idle_threads: + name: ignore_idle_threads + in: query + description: Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an + empty task queue. + schema: + type: boolean + default: true + description: Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an + empty task queue. + nodes.hot_threads::query.interval: + name: interval + in: query + description: The interval for the second sampling of threads. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + nodes.hot_threads::query.snapshots: + name: snapshots + in: query + description: Number of samples of thread stacktrace. + schema: + type: integer + default: 10 + description: Number of samples of thread stacktrace. + format: int32 + nodes.hot_threads::query.threads: + name: threads + in: query + description: Specify the number of threads to provide information for. + schema: + type: integer + default: 3 + description: Specify the number of threads to provide information for. + format: int32 + nodes.hot_threads::query.timeout: + name: timeout + in: query + description: Operation timeout. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + nodes.hot_threads::query.type: + name: type + in: query + description: The type to sample. + schema: + $ref: '../schemas/nodes._common.yaml#/components/schemas/SampleType' + nodes.info::path.metric: + in: path + name: metric + description: Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Metrics' + style: simple + nodes.info::path.node_id: + in: path + name: node_id + description: Comma-separated list of node IDs or names used to limit returned information. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/NodeIds' + style: simple + nodes.info::query.flat_settings: + in: query + name: flat_settings + description: If true, returns settings in flat format. + schema: + type: boolean + style: form + nodes.info::query.timeout: + in: query + name: timeout + description: Period to wait for a response. If no response is received before the timeout expires, the request fails and + returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + nodes.reload_secure_settings::path.node_id: + in: path + name: node_id + description: The names of particular nodes in the cluster to target. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/NodeIds' + style: simple + nodes.reload_secure_settings::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + nodes.stats::path.index_metric: + in: path + name: index_metric + description: Limit the information returned for indices metric to the specific index metrics. It can be used only if + indices (or all) metric is specified. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Metrics' + style: simple + nodes.stats::path.metric: + in: path + name: metric + description: Limit the information returned to the specified metrics + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Metrics' + style: simple + nodes.stats::path.node_id: + in: path + name: node_id + description: Comma-separated list of node IDs or names used to limit returned information. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/NodeIds' + style: simple + nodes.stats::query.completion_fields: + in: query + name: completion_fields + description: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + nodes.stats::query.fielddata_fields: + in: query + name: fielddata_fields + description: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + nodes.stats::query.fields: + in: query + name: fields + description: Comma-separated list or wildcard expressions of fields to include in the statistics. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Fields' + style: form + nodes.stats::query.groups: + in: query + name: groups + description: Comma-separated list of search groups to include in the search statistics. + schema: + type: boolean + style: form + nodes.stats::query.include_segment_file_sizes: + in: query + name: include_segment_file_sizes + description: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if + segment stats are requested). + schema: + type: boolean + style: form + nodes.stats::query.level: + in: query + name: level + description: Indicates whether statistics are aggregated at the cluster, index, or shard level. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Level' + style: form + nodes.stats::query.timeout: + in: query + name: timeout + description: Period to wait for a response. If no response is received before the timeout expires, the request fails and + returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + nodes.stats::query.types: + in: query + name: types + description: A comma-separated list of document types for the indexing index metric. + schema: + type: array + items: + type: string + style: form + nodes.usage::path.metric: + in: path + name: metric + description: |- + Limits the information returned to the specific metrics. + A comma-separated list of the following options: `_all`, `rest_actions`. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Metrics' + style: simple + nodes.usage::path.node_id: + in: path + name: node_id + 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 + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/NodeIds' + style: simple + nodes.usage::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form diff --git a/spec/namespaces/notifications.yaml b/spec/namespaces/notifications.yaml new file mode 100644 index 00000000..30f08e14 --- /dev/null +++ b/spec/namespaces/notifications.yaml @@ -0,0 +1,479 @@ +openapi: 3.1.0 +info: + title: OpenSearch Notifications API + description: OpenSearch Notifications API + version: 1.0.0 +paths: + /_plugins/_notifications/configs: + delete: + operationId: notifications.delete_config.0 + x-operation-group: notifications.delete_config + x-version-added: '2.2' + description: Delete channel configuration. + parameters: + - $ref: '#/components/parameters/notifications.delete_config::query.config_id' + - $ref: '#/components/parameters/notifications.delete_config::query.config_id_list' + responses: + '200': + $ref: '#/components/responses/notifications.delete_config@200' + get: + operationId: notifications.get_config.0 + x-operation-group: notifications.get_config + x-version-added: '2.0' + description: Get channel configuration. + externalDocs: + url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#get-channel-configuration + parameters: + - $ref: '#/components/parameters/notifications.get_config::query.last_updated_time_ms' + - $ref: '#/components/parameters/notifications.get_config::query.created_time_ms' + - $ref: '#/components/parameters/notifications.get_config::query.config_type' + - $ref: '#/components/parameters/notifications.get_config::query.email.email_account_id' + - $ref: '#/components/parameters/notifications.get_config::query.email.email_group_id_list' + - $ref: '#/components/parameters/notifications.get_config::query.smtp_account.method' + - $ref: '#/components/parameters/notifications.get_config::query.ses_account.region' + - $ref: '#/components/parameters/notifications.get_config::query.name' + - $ref: '#/components/parameters/notifications.get_config::query.name.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.description' + - $ref: '#/components/parameters/notifications.get_config::query.description.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.slack.url' + - $ref: '#/components/parameters/notifications.get_config::query.slack.url.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.chime.url' + - $ref: '#/components/parameters/notifications.get_config::query.chime.url.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.microsoft_teams.url' + - $ref: '#/components/parameters/notifications.get_config::query.microsoft_teams.url.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.webhook.url' + - $ref: '#/components/parameters/notifications.get_config::query.webhook.url.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.smtp_account.host' + - $ref: '#/components/parameters/notifications.get_config::query.smtp_account.host.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.smtp_account.from_address' + - $ref: '#/components/parameters/notifications.get_config::query.smtp_account.from_address.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.sns.topic_arn' + - $ref: '#/components/parameters/notifications.get_config::query.sns.topic_arn.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.sns.role_arn' + - $ref: '#/components/parameters/notifications.get_config::query.sns.role_arn.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.ses_account.role_arn' + - $ref: '#/components/parameters/notifications.get_config::query.ses_account.role_arn.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.ses_account.from_address' + - $ref: '#/components/parameters/notifications.get_config::query.ses_account.from_address.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.is_enabled' + - $ref: '#/components/parameters/notifications.get_config::query.email.recipient_list.recipient' + - $ref: '#/components/parameters/notifications.get_config::query.email.recipient_list.recipient.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.email_group.recipient_list.recipient' + - $ref: '#/components/parameters/notifications.get_config::query.email_group.recipient_list.recipient.keyword' + - $ref: '#/components/parameters/notifications.get_config::query.query' + - $ref: '#/components/parameters/notifications.get_config::query.text_query' + requestBody: + $ref: '#/components/requestBodies/notifications.get_config' + responses: + '200': + $ref: '#/components/responses/notifications.get_config@200' + post: + operationId: notifications.create_config.0 + x-operation-group: notifications.create_config + x-version-added: '2.0' + description: Create channel configuration. + externalDocs: + url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#create-channel-configuration + requestBody: + $ref: '#/components/requestBodies/notifications.create_config' + responses: + '200': + $ref: '#/components/responses/notifications.create_config@200' + /_plugins/_notifications/configs/{config_id}: + delete: + operationId: notifications.delete_config.1 + x-operation-group: notifications.delete_config + x-version-added: '2.0' + description: Delete channel configuration. + externalDocs: + url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#delete-channel-configuration + parameters: + - $ref: '#/components/parameters/notifications.delete_config::path.config_id' + responses: + '200': + $ref: '#/components/responses/notifications.delete_config@200' + get: + operationId: notifications.get_config.1 + x-operation-group: notifications.get_config + x-version-added: '2.0' + description: Get channel configuration. + parameters: + - $ref: '#/components/parameters/notifications.get_config::path.config_id' + responses: + '200': + $ref: '#/components/responses/notifications.get_config@200' + put: + operationId: notifications.update_config.0 + x-operation-group: notifications.update_config + x-version-added: '2.0' + description: Update channel configuration. + externalDocs: + url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#update-channel-configuration + parameters: + - $ref: '#/components/parameters/notifications.update_config::path.config_id' + requestBody: + $ref: '#/components/requestBodies/notifications.update_config' + responses: + '200': + $ref: '#/components/responses/notifications.update_config@200' + /_plugins/_notifications/feature/test/{config_id}: + get: + operationId: notifications.send_test.0 + x-operation-group: notifications.send_test + deprecated: true + x-deprecation-message: Use the POST method instead. + x-version-added: '2.0' + x-version-deprecated: '2.3' + description: Send a test notification. + externalDocs: + url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#send-test-notification + parameters: + - $ref: '#/components/parameters/notifications.send_test::path.config_id' + responses: + '200': + $ref: '#/components/responses/notifications.send_test@200' + post: + operationId: notifications.send_test.1 + x-operation-group: notifications.send_test + x-version-added: '2.0' + description: Send a test notification. + parameters: + - $ref: '#/components/parameters/notifications.send_test::path.config_id' + responses: + '200': + $ref: '#/components/responses/notifications.send_test@200' + /_plugins/_notifications/features: + get: + operationId: notifications.list_features.0 + x-operation-group: notifications.list_features + x-version-added: '2.0' + description: List supported channel configurations. + externalDocs: + url: https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-supported-channel-configurations + responses: + '200': + $ref: '#/components/responses/notifications.list_features@200' +components: + requestBodies: + notifications.create_config: + content: + application/json: + schema: + $ref: '../schemas/notifications._common.yaml#/components/schemas/NotificationsConfig' + required: true + notifications.get_config: + content: + application/json: + schema: + $ref: '../schemas/notifications._common.yaml#/components/schemas/NotificationsConfigs_GetRequestContent' + notifications.update_config: + content: + application/json: + schema: + $ref: '../schemas/notifications._common.yaml#/components/schemas/NotificationsConfig' + required: true + responses: + notifications.create_config@200: + description: '' + content: + application/json: + schema: + type: object + properties: + config_id: + type: string + notifications.delete_config@200: + description: '' + content: + application/json: + schema: + type: object + properties: + delete_response_list: + $ref: '../schemas/notifications._common.yaml#/components/schemas/DeleteResponseList' + notifications.get_config@200: + description: '' + content: + application/json: + schema: + type: object + properties: + start_index: + type: integer + format: int64 + total_hits: + type: integer + format: int64 + total_hit_relation: + $ref: '../schemas/notifications._common.yaml#/components/schemas/TotalHitRelation' + config_list: + type: array + items: + $ref: '../schemas/notifications._common.yaml#/components/schemas/NotificationsConfigsOutputItem' + notifications.list_features@200: + description: '' + content: + application/json: + schema: + type: object + properties: + allowed_config_type_list: + type: array + items: + $ref: '../schemas/notifications._common.yaml#/components/schemas/NotificationConfigType' + plugin_features: + $ref: '../schemas/notifications._common.yaml#/components/schemas/NotificationsPluginFeaturesMap' + notifications.send_test@200: + description: '' + content: + application/json: + schema: + type: object + properties: + event_source: + $ref: '../schemas/notifications._common.yaml#/components/schemas/EventSource' + status_list: + type: array + items: + $ref: '../schemas/notifications._common.yaml#/components/schemas/EventStatus' + notifications.update_config@200: + description: '' + content: + application/json: + schema: + type: object + properties: + config_id: + type: string + parameters: + notifications.delete_config::path.config_id: + name: config_id + in: path + schema: + type: string + required: true + notifications.delete_config::query.config_id: + name: config_id + in: query + description: A channel ID. + schema: + type: string + description: A channel ID. + notifications.delete_config::query.config_id_list: + name: config_id_list + in: query + description: A comma-separated list of channel IDs. + schema: + type: string + description: A comma-separated list of channel IDs. + notifications.get_config::path.config_id: + name: config_id + in: path + schema: + type: string + required: true + notifications.get_config::query.chime.url: + name: chime.url + in: query + schema: + type: string + notifications.get_config::query.chime.url.keyword: + name: chime.url.keyword + in: query + schema: + type: string + notifications.get_config::query.config_type: + name: config_type + in: query + description: Type of notification configuration. + schema: + $ref: '../schemas/notifications._common.yaml#/components/schemas/NotificationConfigType' + notifications.get_config::query.created_time_ms: + name: created_time_ms + in: query + schema: + type: integer + format: int64 + notifications.get_config::query.description: + name: description + in: query + schema: + type: string + notifications.get_config::query.description.keyword: + name: description.keyword + in: query + schema: + type: string + notifications.get_config::query.email.email_account_id: + name: email.email_account_id + in: query + schema: + type: string + notifications.get_config::query.email.email_group_id_list: + name: email.email_group_id_list + in: query + schema: + type: string + notifications.get_config::query.email.recipient_list.recipient: + name: email.recipient_list.recipient + in: query + schema: + type: string + notifications.get_config::query.email.recipient_list.recipient.keyword: + name: email.recipient_list.recipient.keyword + in: query + schema: + type: string + notifications.get_config::query.email_group.recipient_list.recipient: + name: email_group.recipient_list.recipient + in: query + schema: + type: string + notifications.get_config::query.email_group.recipient_list.recipient.keyword: + name: email_group.recipient_list.recipient.keyword + in: query + schema: + type: string + notifications.get_config::query.is_enabled: + name: is_enabled + in: query + schema: + type: boolean + notifications.get_config::query.last_updated_time_ms: + name: last_updated_time_ms + in: query + schema: + type: integer + format: int64 + notifications.get_config::query.microsoft_teams.url: + name: microsoft_teams.url + in: query + schema: + type: string + notifications.get_config::query.microsoft_teams.url.keyword: + name: microsoft_teams.url.keyword + in: query + schema: + type: string + notifications.get_config::query.name: + name: name + in: query + schema: + type: string + notifications.get_config::query.name.keyword: + name: name.keyword + in: query + schema: + type: string + notifications.get_config::query.query: + name: query + in: query + schema: + type: string + notifications.get_config::query.ses_account.from_address: + name: ses_account.from_address + in: query + schema: + type: string + notifications.get_config::query.ses_account.from_address.keyword: + name: ses_account.from_address.keyword + in: query + schema: + type: string + notifications.get_config::query.ses_account.region: + name: ses_account.region + in: query + schema: + type: string + notifications.get_config::query.ses_account.role_arn: + name: ses_account.role_arn + in: query + schema: + type: string + notifications.get_config::query.ses_account.role_arn.keyword: + name: ses_account.role_arn.keyword + in: query + schema: + type: string + notifications.get_config::query.slack.url: + name: slack.url + in: query + schema: + type: string + notifications.get_config::query.slack.url.keyword: + name: slack.url.keyword + in: query + schema: + type: string + notifications.get_config::query.smtp_account.from_address: + name: smtp_account.from_address + in: query + schema: + type: string + notifications.get_config::query.smtp_account.from_address.keyword: + name: smtp_account.from_address.keyword + in: query + schema: + type: string + notifications.get_config::query.smtp_account.host: + name: smtp_account.host + in: query + schema: + type: string + notifications.get_config::query.smtp_account.host.keyword: + name: smtp_account.host.keyword + in: query + schema: + type: string + notifications.get_config::query.smtp_account.method: + name: smtp_account.method + in: query + schema: + type: string + notifications.get_config::query.sns.role_arn: + name: sns.role_arn + in: query + schema: + type: string + notifications.get_config::query.sns.role_arn.keyword: + name: sns.role_arn.keyword + in: query + schema: + type: string + notifications.get_config::query.sns.topic_arn: + name: sns.topic_arn + in: query + schema: + type: string + notifications.get_config::query.sns.topic_arn.keyword: + name: sns.topic_arn.keyword + in: query + schema: + type: string + notifications.get_config::query.text_query: + name: text_query + in: query + schema: + type: string + notifications.get_config::query.webhook.url: + name: webhook.url + in: query + schema: + type: string + notifications.get_config::query.webhook.url.keyword: + name: webhook.url.keyword + in: query + schema: + type: string + notifications.send_test::path.config_id: + name: config_id + in: path + schema: + type: string + required: true + notifications.update_config::path.config_id: + name: config_id + in: path + schema: + type: string + required: true diff --git a/spec/namespaces/remote_store.yaml b/spec/namespaces/remote_store.yaml new file mode 100644 index 00000000..6a57acd8 --- /dev/null +++ b/spec/namespaces/remote_store.yaml @@ -0,0 +1,85 @@ +openapi: 3.1.0 +info: + title: OpenSearch Remote_store API + description: OpenSearch Remote_store API + version: 1.0.0 +paths: + /_remotestore/_restore: + post: + operationId: remote_store.restore.0 + x-operation-group: remote_store.restore + x-version-added: '1.0' + description: Restores from remote store. + externalDocs: + url: https://opensearch.org/docs/latest/opensearch/remote/#restoring-from-a-backup + parameters: + - $ref: '#/components/parameters/remote_store.restore::query.cluster_manager_timeout' + - $ref: '#/components/parameters/remote_store.restore::query.wait_for_completion' + requestBody: + $ref: '#/components/requestBodies/remote_store.restore' + responses: + '200': + $ref: '#/components/responses/remote_store.restore@200' +components: + requestBodies: + remote_store.restore: + content: + application/json: + schema: + type: object + description: Comma-separated list of index IDs + properties: + indices: + type: array + items: + type: string + required: + - indices + examples: + RemoteStoreRestore_example1: + summary: Examples for Post Remote Storage Restore Operation. + description: '' + value: + indices: + - books + required: true + responses: + remote_store.restore@200: + description: '' + content: + application/json: + schema: + type: object + properties: + accepted: + type: boolean + remote_store: + $ref: '../schemas/remote_store._common.yaml#/components/schemas/RemoteStoreRestoreInfo' + examples: + RemoteStoreRestore_example1: + summary: Examples for Post Remote Storage Restore Operation. + description: '' + value: + remote_store: + indices: + - books + shards: + total: 1 + failed: 0 + successful: 1 + parameters: + remote_store.restore::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + remote_store.restore::query.wait_for_completion: + name: wait_for_completion + in: query + description: Should this request wait until the operation has completed before returning. + schema: + type: boolean + default: false + description: Should this request wait until the operation has completed before returning. diff --git a/spec/namespaces/search_pipeline.yaml b/spec/namespaces/search_pipeline.yaml new file mode 100644 index 00000000..9381241d --- /dev/null +++ b/spec/namespaces/search_pipeline.yaml @@ -0,0 +1,68 @@ +openapi: 3.1.0 +info: + title: OpenSearch Search_pipeline API + description: OpenSearch Search_pipeline API + version: 1.0.0 +paths: + /_search/pipeline/{pipeline}: + get: + operationId: search_pipeline.get.0 + x-operation-group: search_pipeline.get + x-version-added: '2.9' + description: Retrieves information about a specified search pipeline. + parameters: + - $ref: '#/components/parameters/search_pipeline.get::path.pipeline' + responses: + '200': + $ref: '#/components/responses/search_pipeline.get@200' + put: + operationId: search_pipeline.create.0 + x-operation-group: search_pipeline.create + x-version-added: '2.9' + description: Creates or replaces the specified search pipeline. + externalDocs: + url: https://opensearch.org/docs/latest/search-plugins/search-pipelines/creating-search-pipeline/ + parameters: + - $ref: '#/components/parameters/search_pipeline.create::path.pipeline' + requestBody: + $ref: '#/components/requestBodies/search_pipeline.create' + responses: + '200': + $ref: '#/components/responses/search_pipeline.create@200' +components: + requestBodies: + search_pipeline.create: + content: + application/json: + schema: + $ref: '../schemas/search_pipeline._common.yaml#/components/schemas/SearchPipelineStructure' + required: true + responses: + search_pipeline.create@200: + description: '' + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + search_pipeline.get@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/search_pipeline._common.yaml#/components/schemas/SearchPipelineMap' + parameters: + search_pipeline.create::path.pipeline: + name: pipeline + in: path + schema: + type: string + required: true + search_pipeline.get::path.pipeline: + name: pipeline + in: path + schema: + type: string + required: true diff --git a/spec/namespaces/security.yaml b/spec/namespaces/security.yaml new file mode 100644 index 00000000..6df210ad --- /dev/null +++ b/spec/namespaces/security.yaml @@ -0,0 +1,1406 @@ +openapi: 3.1.0 +info: + title: OpenSearch Security API + description: OpenSearch Security API + version: 1.0.0 +paths: + /_plugins/_security/api/account: + get: + operationId: security.get_account_details.0 + x-operation-group: security.get_account_details + x-version-added: '1.0' + description: Returns account details for the current user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-account-details + responses: + '200': + $ref: '#/components/responses/security.get_account_details@200' + put: + operationId: security.change_password.0 + x-operation-group: security.change_password + x-version-added: '1.0' + description: Changes the password for the current user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#change-password + requestBody: + $ref: '#/components/requestBodies/security.change_password' + responses: + '200': + $ref: '#/components/responses/security.change_password@200' + /_plugins/_security/api/actiongroups: + get: + operationId: security.get_action_groups.0 + x-operation-group: security.get_action_groups + x-version-added: '1.0' + description: Retrieves all action groups. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-action-groups + responses: + '200': + $ref: '#/components/responses/security.get_action_groups@200' + patch: + operationId: security.patch_action_groups.0 + x-operation-group: security.patch_action_groups + x-version-added: '1.0' + description: Creates, updates, or deletes multiple action groups in a single call. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-action-groups + requestBody: + $ref: '#/components/requestBodies/security.patch_action_groups' + responses: + '200': + $ref: '#/components/responses/security.patch_action_groups@200' + /_plugins/_security/api/actiongroups/{action_group}: + delete: + operationId: security.delete_action_group.0 + x-operation-group: security.delete_action_group + x-version-added: '1.0' + description: Delete a specified action group. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group + parameters: + - $ref: '#/components/parameters/security.delete_action_group::path.action_group' + responses: + '200': + $ref: '#/components/responses/security.delete_action_group@200' + get: + operationId: security.get_action_group.0 + x-operation-group: security.get_action_group + x-version-added: '1.0' + description: Retrieves one action group. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-action-group + parameters: + - $ref: '#/components/parameters/security.get_action_group::path.action_group' + responses: + '200': + $ref: '#/components/responses/security.get_action_group@200' + patch: + operationId: security.patch_action_group.0 + x-operation-group: security.patch_action_group + x-version-added: '1.0' + description: Updates individual attributes of an action group. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-action-group + parameters: + - $ref: '#/components/parameters/security.patch_action_group::path.action_group' + requestBody: + $ref: '#/components/requestBodies/security.patch_action_group' + responses: + '200': + $ref: '#/components/responses/security.patch_action_group@200' + put: + operationId: security.create_action_group.0 + x-operation-group: security.create_action_group + x-version-added: '1.0' + description: Creates or replaces the specified action group. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#create-action-group + parameters: + - $ref: '#/components/parameters/security.create_action_group::path.action_group' + requestBody: + $ref: '#/components/requestBodies/security.create_action_group' + responses: + '200': + $ref: '#/components/responses/security.create_action_group@200' + /_plugins/_security/api/audit: + get: + operationId: security.get_audit_configuration.0 + x-operation-group: security.get_audit_configuration + x-version-added: '1.0' + description: Retrieves the audit configuration. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs + responses: + '200': + $ref: '#/components/responses/security.get_audit_configuration@200' + patch: + operationId: security.patch_audit_configuration.0 + x-operation-group: security.patch_audit_configuration + x-version-added: '1.0' + description: A PATCH call is used to update specified fields in the audit configuration. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs + requestBody: + $ref: '#/components/requestBodies/security.patch_audit_configuration' + responses: + '200': + $ref: '#/components/responses/security.patch_audit_configuration@200' + /_plugins/_security/api/audit/config: + put: + operationId: security.update_audit_configuration.0 + x-operation-group: security.update_audit_configuration + x-version-added: '1.0' + description: Updates the audit configuration. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#audit-logs + requestBody: + $ref: '#/components/requestBodies/security.update_audit_configuration' + responses: + '200': + $ref: '#/components/responses/security.update_audit_configuration@200' + /_plugins/_security/api/cache: + delete: + operationId: security.flush_cache.0 + x-operation-group: security.flush_cache + x-version-added: '1.0' + description: Flushes the Security plugin user, authentication, and authorization cache. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#flush-cache + responses: + '200': + $ref: '#/components/responses/security.flush_cache@200' + /_plugins/_security/api/internalusers: + get: + operationId: security.get_users.0 + x-operation-group: security.get_users + x-version-added: '1.0' + description: Retrieve all internal users. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-users + responses: + '200': + $ref: '#/components/responses/security.get_users@200' + patch: + operationId: security.patch_users.0 + x-operation-group: security.patch_users + x-version-added: '1.0' + description: Creates, updates, or deletes multiple internal users in a single call. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-users + requestBody: + $ref: '#/components/requestBodies/security.patch_users' + responses: + '200': + $ref: '#/components/responses/security.patch_users@200' + /_plugins/_security/api/internalusers/{username}: + delete: + operationId: security.delete_user.0 + x-operation-group: security.delete_user + x-version-added: '1.0' + description: Delete the specified user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-user + parameters: + - $ref: '#/components/parameters/security.delete_user::path.username' + responses: + '200': + $ref: '#/components/responses/security.delete_user@200' + get: + operationId: security.get_user.0 + x-operation-group: security.get_user + x-version-added: '1.0' + description: Retrieve one internal user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-user + parameters: + - $ref: '#/components/parameters/security.get_user::path.username' + responses: + '200': + $ref: '#/components/responses/security.get_user@200' + patch: + operationId: security.patch_user.0 + x-operation-group: security.patch_user + x-version-added: '1.0' + description: Updates individual attributes of an internal user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-user + parameters: + - $ref: '#/components/parameters/security.patch_user::path.username' + requestBody: + $ref: '#/components/requestBodies/security.patch_user' + responses: + '200': + $ref: '#/components/responses/security.patch_user@200' + put: + operationId: security.create_user.0 + x-operation-group: security.create_user + x-version-added: '1.0' + description: Creates or replaces the specified user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#create-user + parameters: + - $ref: '#/components/parameters/security.create_user::path.username' + requestBody: + $ref: '#/components/requestBodies/security.create_user' + responses: + '200': + $ref: '#/components/responses/security.create_user@200' + /_plugins/_security/api/nodesdn: + get: + operationId: security.get_distinguished_names.0 + x-operation-group: security.get_distinguished_names + x-version-added: '1.0' + description: Retrieves all distinguished names in the allow list. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names + responses: + '200': + $ref: '#/components/responses/security.get_distinguished_names@200' + patch: + operationId: security.patch_distinguished_names.0 + x-operation-group: security.patch_distinguished_names + x-version-added: '1.0' + description: Bulk update of distinguished names. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#update-all-distinguished-names + requestBody: + $ref: '#/components/requestBodies/security.patch_distinguished_names' + responses: + '200': + $ref: '#/components/responses/security.patch_distinguished_names@200' + /_plugins/_security/api/nodesdn/{cluster_name}: + delete: + operationId: security.delete_distinguished_names.0 + x-operation-group: security.delete_distinguished_names + x-version-added: '1.0' + description: Deletes all distinguished names in the specified cluster’s or node’s allow list. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names + parameters: + - $ref: '#/components/parameters/security.delete_distinguished_names::path.cluster_name' + responses: + '200': + $ref: '#/components/responses/security.delete_distinguished_names@200' + get: + operationId: security.get_distinguished_names.1 + x-operation-group: security.get_distinguished_names + x-version-added: '1.0' + description: Retrieve distinguished names of a specified cluster. + parameters: + - $ref: '#/components/parameters/security.get_distinguished_names::path.cluster_name' + responses: + '200': + $ref: '#/components/responses/security.get_distinguished_names@200' + put: + operationId: security.update_distinguished_names.0 + x-operation-group: security.update_distinguished_names + x-version-added: '1.0' + description: Adds or updates the specified distinguished names in the cluster’s or node’s allow list. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names + parameters: + - $ref: '#/components/parameters/security.update_distinguished_names::path.cluster_name' + requestBody: + $ref: '#/components/requestBodies/security.update_distinguished_names' + responses: + '200': + $ref: '#/components/responses/security.update_distinguished_names@200' + /_plugins/_security/api/roles: + patch: + operationId: security.patch_roles.0 + x-operation-group: security.patch_roles + x-version-added: '1.0' + description: Creates, updates, or deletes multiple roles in a single call. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-roles + requestBody: + $ref: '#/components/requestBodies/security.patch_roles' + responses: + '200': + $ref: '#/components/responses/security.patch_roles@200' + /_plugins/_security/api/roles/: + get: + operationId: security.get_roles.0 + x-operation-group: security.get_roles + x-version-added: '1.0' + description: Retrieves all roles. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-roles + responses: + '200': + $ref: '#/components/responses/security.get_roles@200' + /_plugins/_security/api/roles/{role}: + delete: + operationId: security.delete_role.0 + x-operation-group: security.delete_role + x-version-added: '1.0' + description: Delete the specified role. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role + parameters: + - $ref: '#/components/parameters/security.delete_role::path.role' + responses: + '200': + $ref: '#/components/responses/security.delete_role@200' + get: + operationId: security.get_role.0 + x-operation-group: security.get_role + x-version-added: '1.0' + description: Retrieves one role. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-role + parameters: + - $ref: '#/components/parameters/security.get_role::path.role' + responses: + '200': + $ref: '#/components/responses/security.get_role@200' + patch: + operationId: security.patch_role.0 + x-operation-group: security.patch_role + x-version-added: '1.0' + description: Updates individual attributes of a role. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role + parameters: + - $ref: '#/components/parameters/security.patch_role::path.role' + requestBody: + $ref: '#/components/requestBodies/security.patch_role' + responses: + '200': + $ref: '#/components/responses/security.patch_role@200' + put: + operationId: security.create_role.0 + x-operation-group: security.create_role + x-version-added: '1.0' + description: Creates or replaces the specified role. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#create-role + parameters: + - $ref: '#/components/parameters/security.create_role::path.role' + requestBody: + $ref: '#/components/requestBodies/security.create_role' + responses: + '200': + $ref: '#/components/responses/security.create_role@200' + /_plugins/_security/api/rolesmapping: + get: + operationId: security.get_role_mappings.0 + x-operation-group: security.get_role_mappings + x-version-added: '1.0' + description: Retrieves all role mappings. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-role-mappings + responses: + '200': + $ref: '#/components/responses/security.get_role_mappings@200' + patch: + operationId: security.patch_role_mappings.0 + x-operation-group: security.patch_role_mappings + x-version-added: '1.0' + description: Creates or updates multiple role mappings in a single call. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mappings + requestBody: + $ref: '#/components/requestBodies/security.patch_role_mappings' + responses: + '200': + $ref: '#/components/responses/security.patch_role_mappings@200' + /_plugins/_security/api/rolesmapping/{role}: + delete: + operationId: security.delete_role_mapping.0 + x-operation-group: security.delete_role_mapping + x-version-added: '1.0' + description: Deletes the specified role mapping. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping + parameters: + - $ref: '#/components/parameters/security.delete_role_mapping::path.role' + responses: + '200': + $ref: '#/components/responses/security.delete_role_mapping@200' + get: + operationId: security.get_role_mapping.0 + x-operation-group: security.get_role_mapping + x-version-added: '1.0' + description: Retrieves one role mapping. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping + parameters: + - $ref: '#/components/parameters/security.get_role_mapping::path.role' + responses: + '200': + $ref: '#/components/responses/security.get_role_mapping@200' + patch: + operationId: security.patch_role_mapping.0 + x-operation-group: security.patch_role_mapping + x-version-added: '1.0' + description: Updates individual attributes of a role mapping. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mapping + parameters: + - $ref: '#/components/parameters/security.patch_role_mapping::path.role' + requestBody: + $ref: '#/components/requestBodies/security.patch_role_mapping' + responses: + '200': + $ref: '#/components/responses/security.patch_role_mapping@200' + put: + operationId: security.create_role_mapping.0 + x-operation-group: security.create_role_mapping + x-version-added: '1.0' + description: Creates or replaces the specified role mapping. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping + parameters: + - $ref: '#/components/parameters/security.create_role_mapping::path.role' + requestBody: + $ref: '#/components/requestBodies/security.create_role_mapping' + responses: + '200': + $ref: '#/components/responses/security.create_role_mapping@200' + /_plugins/_security/api/securityconfig: + get: + operationId: security.get_configuration.0 + x-operation-group: security.get_configuration + x-version-added: '1.0' + description: Returns the current Security plugin configuration in JSON format. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#get-configuration + responses: + '200': + $ref: '#/components/responses/security.get_configuration@200' + patch: + operationId: security.patch_configuration.0 + x-operation-group: security.patch_configuration + x-version-added: '1.0' + description: A PATCH call is used to update the existing configuration using the REST API. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#patch-configuration + requestBody: + $ref: '#/components/requestBodies/security.patch_configuration' + responses: + '200': + $ref: '#/components/responses/security.patch_configuration@200' + /_plugins/_security/api/securityconfig/config: + put: + operationId: security.update_configuration.0 + x-operation-group: security.update_configuration + x-version-added: '1.0' + description: Adds or updates the existing configuration using the REST API. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#update-configuration + requestBody: + $ref: '#/components/requestBodies/security.update_configuration' + responses: + '200': + $ref: '#/components/responses/security.update_configuration@200' + /_plugins/_security/api/ssl/certs: + get: + operationId: security.get_certificates.0 + x-operation-group: security.get_certificates + x-version-added: '1.0' + description: Retrieves the cluster’s security certificates. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#get-certificates + responses: + '200': + $ref: '#/components/responses/security.get_certificates@200' + /_plugins/_security/api/ssl/http/reloadcerts: + put: + operationId: security.reload_http_certificates.0 + x-operation-group: security.reload_http_certificates + x-version-added: '1.0' + description: Reload HTTP layer communication certificates. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates + responses: + '200': + $ref: '#/components/responses/security.reload_http_certificates@200' + /_plugins/_security/api/ssl/transport/reloadcerts: + put: + operationId: security.reload_transport_certificates.0 + x-operation-group: security.reload_transport_certificates + x-version-added: '1.0' + description: Reload transport layer communication certificates. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates + responses: + '200': + $ref: '#/components/responses/security.reload_transport_certificates@200' + /_plugins/_security/api/tenants/: + get: + operationId: security.get_tenants.0 + x-operation-group: security.get_tenants + x-version-added: '1.0' + description: Retrieves all tenants. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#get-tenants + responses: + '200': + $ref: '#/components/responses/security.get_tenants@200' + patch: + operationId: security.patch_tenants.0 + x-operation-group: security.patch_tenants + x-version-added: '1.0' + description: Add, delete, or modify multiple tenants in a single call. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#patch-tenants + requestBody: + $ref: '#/components/requestBodies/security.patch_tenants' + responses: + '200': + $ref: '#/components/responses/security.patch_tenants@200' + /_plugins/_security/api/tenants/{tenant}: + delete: + operationId: security.delete_tenant.0 + x-operation-group: security.delete_tenant + x-version-added: '1.0' + description: Delete the specified tenant. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group + parameters: + - $ref: '#/components/parameters/security.delete_tenant::path.tenant' + responses: + '200': + $ref: '#/components/responses/security.delete_tenant@200' + get: + operationId: security.get_tenant.0 + x-operation-group: security.get_tenant + x-version-added: '1.0' + description: Retrieves one tenant. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#get-tenant + parameters: + - $ref: '#/components/parameters/security.get_tenant::path.tenant' + responses: + '200': + $ref: '#/components/responses/security.get_tenant@200' + patch: + operationId: security.patch_tenant.0 + x-operation-group: security.patch_tenant + x-version-added: '1.0' + description: Add, delete, or modify a single tenant. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#patch-tenant + parameters: + - $ref: '#/components/parameters/security.patch_tenant::path.tenant' + requestBody: + $ref: '#/components/requestBodies/security.patch_tenant' + responses: + '200': + $ref: '#/components/responses/security.patch_tenant@200' + put: + operationId: security.create_tenant.0 + x-operation-group: security.create_tenant + x-version-added: '1.0' + description: Creates or replaces the specified tenant. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#create-tenant + parameters: + - $ref: '#/components/parameters/security.create_tenant::path.tenant' + requestBody: + $ref: '#/components/requestBodies/security.create_tenant' + responses: + '200': + $ref: '#/components/responses/security.create_tenant@200' + /_plugins/_security/health: + get: + operationId: security.health.0 + x-operation-group: security.health + x-version-added: '1.0' + description: Checks to see if the Security plugin is up and running. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#health-check + responses: + '200': + $ref: '#/components/responses/security.health@200' +components: + requestBodies: + security.change_password: + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/ChangePasswordRequestContent' + required: true + security.create_action_group: + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/Action_Group' + required: true + security.create_role: + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/Role' + required: true + security.create_role_mapping: + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/RoleMapping' + required: true + security.create_tenant: + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/CreateTenantParams' + required: true + security.create_user: + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/User' + required: true + security.patch_action_group: + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/security._common.yaml#/components/schemas/PatchOperation' + required: true + security.patch_action_groups: + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/security._common.yaml#/components/schemas/PatchOperation' + required: true + security.patch_audit_configuration: + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/security._common.yaml#/components/schemas/PatchOperation' + required: true + security.patch_configuration: + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/security._common.yaml#/components/schemas/PatchOperation' + required: true + security.patch_distinguished_names: + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/security._common.yaml#/components/schemas/PatchOperation' + required: true + security.patch_role: + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/security._common.yaml#/components/schemas/PatchOperation' + required: true + security.patch_role_mapping: + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/security._common.yaml#/components/schemas/PatchOperation' + required: true + security.patch_role_mappings: + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/security._common.yaml#/components/schemas/PatchOperation' + required: true + security.patch_roles: + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/security._common.yaml#/components/schemas/PatchOperation' + required: true + security.patch_tenant: + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/security._common.yaml#/components/schemas/PatchOperation' + required: true + security.patch_tenants: + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/security._common.yaml#/components/schemas/PatchOperation' + required: true + security.patch_user: + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/security._common.yaml#/components/schemas/PatchOperation' + required: true + security.patch_users: + content: + application/json: + schema: + type: array + items: + $ref: '../schemas/security._common.yaml#/components/schemas/PatchOperation' + required: true + security.update_audit_configuration: + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/AuditConfig' + required: true + security.update_configuration: + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/DynamicConfig' + required: true + security.update_distinguished_names: + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/DistinguishedNames' + responses: + security.change_password@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.create_action_group@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.create_role@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.create_role_mapping@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.create_tenant@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.create_user@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.delete_action_group@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.delete_distinguished_names@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.delete_role@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.delete_role_mapping@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.delete_tenant@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.delete_user@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.flush_cache@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.get_account_details@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/AccountDetails' + security.get_action_group@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/ActionGroupsMap' + security.get_action_groups@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/ActionGroupsMap' + security.get_audit_configuration@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/AuditConfigWithReadOnly' + security.get_certificates@200: + description: '' + content: + application/json: + schema: + type: object + properties: + http_certificates_list: + type: array + items: + $ref: '../schemas/security._common.yaml#/components/schemas/CertificatesDetail' + transport_certificates_list: + type: array + items: + $ref: '../schemas/security._common.yaml#/components/schemas/CertificatesDetail' + security.get_configuration@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/DynamicConfig' + security.get_distinguished_names@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/DistinguishedNamesMap' + security.get_role@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/RolesMap' + security.get_role_mapping@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/RoleMappings' + security.get_role_mappings@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/RoleMappings' + security.get_roles@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/RolesMap' + security.get_tenant@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/TenantsMap' + security.get_tenants@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/TenantsMap' + security.get_user@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/UsersMap' + security.get_users@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/security._common.yaml#/components/schemas/UsersMap' + security.health@200: + description: '' + content: + application/json: + schema: + type: object + properties: + message: + type: string + mode: + type: string + status: + type: string + security.patch_action_group@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_action_groups@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_audit_configuration@200: + description: '' + security.patch_configuration@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_distinguished_names@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_role@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_role_mapping@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_role_mappings@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_roles@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_tenant@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_tenants@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_user@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.patch_users@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.reload_http_certificates@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.reload_transport_certificates@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.update_audit_configuration@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.update_configuration@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + security.update_distinguished_names@200: + description: '' + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Security Operation Status + message: + type: string + description: Security Operation Message + parameters: + security.create_action_group::path.action_group: + name: action_group + in: path + description: The name of the action group to create or replace + schema: + type: string + description: The name of the action group to create or replace + required: true + security.create_role::path.role: + name: role + in: path + schema: + type: string + required: true + security.create_role_mapping::path.role: + name: role + in: path + schema: + type: string + required: true + security.create_tenant::path.tenant: + name: tenant + in: path + schema: + type: string + required: true + security.create_user::path.username: + name: username + in: path + schema: + type: string + required: true + security.delete_action_group::path.action_group: + name: action_group + in: path + description: Action group to delete. + schema: + type: string + description: Action group to delete. + required: true + security.delete_distinguished_names::path.cluster_name: + name: cluster_name + in: path + schema: + type: string + required: true + security.delete_role::path.role: + name: role + in: path + schema: + type: string + required: true + security.delete_role_mapping::path.role: + name: role + in: path + schema: + type: string + required: true + security.delete_tenant::path.tenant: + name: tenant + in: path + schema: + type: string + required: true + security.delete_user::path.username: + name: username + in: path + schema: + type: string + required: true + security.get_action_group::path.action_group: + name: action_group + in: path + description: Action group to retrieve. + schema: + type: string + description: Action group to retrieve. + required: true + security.get_distinguished_names::path.cluster_name: + name: cluster_name + in: path + schema: + type: string + required: true + security.get_role::path.role: + name: role + in: path + schema: + type: string + required: true + security.get_role_mapping::path.role: + name: role + in: path + schema: + type: string + required: true + security.get_tenant::path.tenant: + name: tenant + in: path + schema: + type: string + required: true + security.get_user::path.username: + name: username + in: path + schema: + type: string + required: true + security.patch_action_group::path.action_group: + name: action_group + in: path + schema: + type: string + required: true + security.patch_role::path.role: + name: role + in: path + schema: + type: string + required: true + security.patch_role_mapping::path.role: + name: role + in: path + schema: + type: string + required: true + security.patch_tenant::path.tenant: + name: tenant + in: path + schema: + type: string + required: true + security.patch_user::path.username: + name: username + in: path + schema: + type: string + required: true + security.update_distinguished_names::path.cluster_name: + name: cluster_name + in: path + schema: + type: string + required: true diff --git a/spec/namespaces/snapshot.yaml b/spec/namespaces/snapshot.yaml new file mode 100644 index 00000000..aeac463e --- /dev/null +++ b/spec/namespaces/snapshot.yaml @@ -0,0 +1,898 @@ +openapi: 3.1.0 +info: + title: OpenSearch Snapshot API + description: OpenSearch Snapshot API + version: 1.0.0 +paths: + /_snapshot: + get: + operationId: snapshot.get_repository.0 + x-operation-group: snapshot.get_repository + x-version-added: '1.0' + description: Returns information about a repository. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/ + parameters: + - $ref: '#/components/parameters/snapshot.get_repository::query.master_timeout' + - $ref: '#/components/parameters/snapshot.get_repository::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.get_repository::query.local' + responses: + '200': + $ref: '#/components/responses/snapshot.get_repository@200' + /_snapshot/_status: + get: + operationId: snapshot.status.0 + x-operation-group: snapshot.status + x-version-added: '1.0' + description: Returns information about the status of a snapshot. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/ + parameters: + - $ref: '#/components/parameters/snapshot.status::query.master_timeout' + - $ref: '#/components/parameters/snapshot.status::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.status::query.ignore_unavailable' + responses: + '200': + $ref: '#/components/responses/snapshot.status@200' + /_snapshot/{repository}: + delete: + operationId: snapshot.delete_repository.0 + x-operation-group: snapshot.delete_repository + x-version-added: '1.0' + description: Deletes a repository. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/ + parameters: + - $ref: '#/components/parameters/snapshot.delete_repository::path.repository' + - $ref: '#/components/parameters/snapshot.delete_repository::query.master_timeout' + - $ref: '#/components/parameters/snapshot.delete_repository::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.delete_repository::query.timeout' + responses: + '200': + $ref: '#/components/responses/snapshot.delete_repository@200' + get: + operationId: snapshot.get_repository.1 + x-operation-group: snapshot.get_repository + x-version-added: '1.0' + description: Returns information about a repository. + parameters: + - $ref: '#/components/parameters/snapshot.get_repository::path.repository' + - $ref: '#/components/parameters/snapshot.get_repository::query.master_timeout' + - $ref: '#/components/parameters/snapshot.get_repository::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.get_repository::query.local' + responses: + '200': + $ref: '#/components/responses/snapshot.get_repository@200' + post: + operationId: snapshot.create_repository.0 + x-operation-group: snapshot.create_repository + x-version-added: '1.0' + description: Creates a repository. + parameters: + - $ref: '#/components/parameters/snapshot.create_repository::path.repository' + - $ref: '#/components/parameters/snapshot.create_repository::query.master_timeout' + - $ref: '#/components/parameters/snapshot.create_repository::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.create_repository::query.timeout' + - $ref: '#/components/parameters/snapshot.create_repository::query.verify' + requestBody: + $ref: '#/components/requestBodies/snapshot.create_repository' + responses: + '200': + $ref: '#/components/responses/snapshot.create_repository@200' + put: + operationId: snapshot.create_repository.1 + x-operation-group: snapshot.create_repository + x-version-added: '1.0' + description: Creates a repository. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/snapshots/create-repository/ + parameters: + - $ref: '#/components/parameters/snapshot.create_repository::path.repository' + - $ref: '#/components/parameters/snapshot.create_repository::query.master_timeout' + - $ref: '#/components/parameters/snapshot.create_repository::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.create_repository::query.timeout' + - $ref: '#/components/parameters/snapshot.create_repository::query.verify' + requestBody: + $ref: '#/components/requestBodies/snapshot.create_repository' + responses: + '200': + $ref: '#/components/responses/snapshot.create_repository@200' + /_snapshot/{repository}/_cleanup: + post: + operationId: snapshot.cleanup_repository.0 + x-operation-group: snapshot.cleanup_repository + x-version-added: '1.0' + description: Removes stale data from repository. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/snapshot.cleanup_repository::path.repository' + - $ref: '#/components/parameters/snapshot.cleanup_repository::query.master_timeout' + - $ref: '#/components/parameters/snapshot.cleanup_repository::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.cleanup_repository::query.timeout' + responses: + '200': + $ref: '#/components/responses/snapshot.cleanup_repository@200' + /_snapshot/{repository}/_status: + get: + operationId: snapshot.status.1 + x-operation-group: snapshot.status + x-version-added: '1.0' + description: Returns information about the status of a snapshot. + parameters: + - $ref: '#/components/parameters/snapshot.status::path.repository' + - $ref: '#/components/parameters/snapshot.status::query.master_timeout' + - $ref: '#/components/parameters/snapshot.status::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.status::query.ignore_unavailable' + responses: + '200': + $ref: '#/components/responses/snapshot.status@200' + /_snapshot/{repository}/_verify: + post: + operationId: snapshot.verify_repository.0 + x-operation-group: snapshot.verify_repository + x-version-added: '1.0' + description: Verifies a repository. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/ + parameters: + - $ref: '#/components/parameters/snapshot.verify_repository::path.repository' + - $ref: '#/components/parameters/snapshot.verify_repository::query.master_timeout' + - $ref: '#/components/parameters/snapshot.verify_repository::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.verify_repository::query.timeout' + responses: + '200': + $ref: '#/components/responses/snapshot.verify_repository@200' + /_snapshot/{repository}/{snapshot}: + delete: + operationId: snapshot.delete.0 + x-operation-group: snapshot.delete + x-version-added: '1.0' + description: Deletes a snapshot. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/ + parameters: + - $ref: '#/components/parameters/snapshot.delete::path.repository' + - $ref: '#/components/parameters/snapshot.delete::path.snapshot' + - $ref: '#/components/parameters/snapshot.delete::query.master_timeout' + - $ref: '#/components/parameters/snapshot.delete::query.cluster_manager_timeout' + responses: + '200': + $ref: '#/components/responses/snapshot.delete@200' + get: + operationId: snapshot.get.0 + x-operation-group: snapshot.get + x-version-added: '1.0' + description: Returns information about a snapshot. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/snapshot.get::path.repository' + - $ref: '#/components/parameters/snapshot.get::path.snapshot' + - $ref: '#/components/parameters/snapshot.get::query.master_timeout' + - $ref: '#/components/parameters/snapshot.get::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.get::query.ignore_unavailable' + - $ref: '#/components/parameters/snapshot.get::query.verbose' + responses: + '200': + $ref: '#/components/responses/snapshot.get@200' + post: + operationId: snapshot.create.0 + x-operation-group: snapshot.create + x-version-added: '1.0' + description: Creates a snapshot in a repository. + parameters: + - $ref: '#/components/parameters/snapshot.create::path.repository' + - $ref: '#/components/parameters/snapshot.create::path.snapshot' + - $ref: '#/components/parameters/snapshot.create::query.master_timeout' + - $ref: '#/components/parameters/snapshot.create::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.create::query.wait_for_completion' + requestBody: + $ref: '#/components/requestBodies/snapshot.create' + responses: + '200': + $ref: '#/components/responses/snapshot.create@200' + put: + operationId: snapshot.create.1 + x-operation-group: snapshot.create + x-version-added: '1.0' + description: Creates a snapshot in a repository. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/snapshots/create-snapshot/ + parameters: + - $ref: '#/components/parameters/snapshot.create::path.repository' + - $ref: '#/components/parameters/snapshot.create::path.snapshot' + - $ref: '#/components/parameters/snapshot.create::query.master_timeout' + - $ref: '#/components/parameters/snapshot.create::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.create::query.wait_for_completion' + requestBody: + $ref: '#/components/requestBodies/snapshot.create' + responses: + '200': + $ref: '#/components/responses/snapshot.create@200' + /_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}: + put: + operationId: snapshot.clone.0 + x-operation-group: snapshot.clone + x-version-added: '1.0' + description: Clones indices from one snapshot into another snapshot in the same repository. + externalDocs: + url: https://opensearch.org/docs/latest + parameters: + - $ref: '#/components/parameters/snapshot.clone::path.repository' + - $ref: '#/components/parameters/snapshot.clone::path.snapshot' + - $ref: '#/components/parameters/snapshot.clone::path.target_snapshot' + - $ref: '#/components/parameters/snapshot.clone::query.master_timeout' + - $ref: '#/components/parameters/snapshot.clone::query.cluster_manager_timeout' + requestBody: + $ref: '#/components/requestBodies/snapshot.clone' + responses: + '200': + $ref: '#/components/responses/snapshot.clone@200' + /_snapshot/{repository}/{snapshot}/_restore: + post: + operationId: snapshot.restore.0 + x-operation-group: snapshot.restore + x-version-added: '1.0' + description: Restores a snapshot. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot/ + parameters: + - $ref: '#/components/parameters/snapshot.restore::path.repository' + - $ref: '#/components/parameters/snapshot.restore::path.snapshot' + - $ref: '#/components/parameters/snapshot.restore::query.master_timeout' + - $ref: '#/components/parameters/snapshot.restore::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.restore::query.wait_for_completion' + requestBody: + $ref: '#/components/requestBodies/snapshot.restore' + responses: + '200': + $ref: '#/components/responses/snapshot.restore@200' + /_snapshot/{repository}/{snapshot}/_status: + get: + operationId: snapshot.status.2 + x-operation-group: snapshot.status + x-version-added: '1.0' + description: Returns information about the status of a snapshot. + parameters: + - $ref: '#/components/parameters/snapshot.status::path.repository' + - $ref: '#/components/parameters/snapshot.status::path.snapshot' + - $ref: '#/components/parameters/snapshot.status::query.master_timeout' + - $ref: '#/components/parameters/snapshot.status::query.cluster_manager_timeout' + - $ref: '#/components/parameters/snapshot.status::query.ignore_unavailable' + responses: + '200': + $ref: '#/components/responses/snapshot.status@200' +components: + requestBodies: + snapshot.clone: + content: + application/json: + schema: + type: object + properties: + indices: + type: string + required: + - indices + description: The snapshot clone definition + required: true + snapshot.create: + content: + application/json: + schema: + type: object + properties: + ignore_unavailable: + 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. + type: boolean + include_global_state: + 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`). + type: boolean + indices: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + feature_states: + 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. + type: array + items: + type: string + metadata: + $ref: '../schemas/_common.yaml#/components/schemas/Metadata' + partial: + 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. + type: boolean + description: The snapshot definition + snapshot.create_repository: + content: + application/json: + schema: + type: object + properties: + repository: + $ref: '../schemas/snapshot._common.yaml#/components/schemas/Repository' + type: + type: string + settings: + $ref: '../schemas/snapshot._common.yaml#/components/schemas/RepositorySettings' + required: + - type + - settings + description: The repository definition + required: true + snapshot.restore: + content: + application/json: + schema: + type: object + properties: + feature_states: + type: array + items: + type: string + ignore_index_settings: + type: array + items: + type: string + ignore_unavailable: + type: boolean + include_aliases: + type: boolean + include_global_state: + type: boolean + index_settings: + $ref: '../schemas/indices._common.yaml#/components/schemas/IndexSettings' + indices: + $ref: '../schemas/_common.yaml#/components/schemas/Indices' + partial: + type: boolean + rename_pattern: + type: string + rename_replacement: + type: string + description: Details of what to restore + responses: + snapshot.cleanup_repository@200: + description: '' + content: + application/json: + schema: + type: object + properties: + results: + $ref: '../schemas/snapshot.cleanup_repository.yaml#/components/schemas/CleanupRepositoryResults' + required: + - results + snapshot.clone@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + snapshot.create@200: + description: '' + content: + application/json: + schema: + type: object + properties: + accepted: + description: Equals `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to + `false` + type: boolean + snapshot: + $ref: '../schemas/snapshot._common.yaml#/components/schemas/SnapshotInfo' + snapshot.create_repository@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + snapshot.delete@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + snapshot.delete_repository@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase' + snapshot.get@200: + description: '' + content: + application/json: + schema: + type: object + properties: + responses: + type: array + items: + $ref: '../schemas/snapshot.get.yaml#/components/schemas/SnapshotResponseItem' + snapshots: + type: array + items: + $ref: '../schemas/snapshot._common.yaml#/components/schemas/SnapshotInfo' + total: + description: The total number of snapshots that match the request when ignoring size limit or after query parameter. + type: number + remaining: + 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. + type: number + required: + - total + - remaining + snapshot.get_repository@200: + description: '' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '../schemas/snapshot._common.yaml#/components/schemas/Repository' + snapshot.restore@200: + description: '' + content: + application/json: + schema: + type: object + properties: + snapshot: + $ref: '../schemas/snapshot.restore.yaml#/components/schemas/SnapshotRestore' + required: + - snapshot + snapshot.status@200: + description: '' + content: + application/json: + schema: + type: object + properties: + snapshots: + type: array + items: + $ref: '../schemas/snapshot._common.yaml#/components/schemas/Status' + required: + - snapshots + snapshot.verify_repository@200: + description: '' + content: + application/json: + schema: + type: object + properties: + nodes: + type: object + additionalProperties: + $ref: '../schemas/snapshot.verify_repository.yaml#/components/schemas/CompactNodeInfo' + required: + - nodes + parameters: + snapshot.cleanup_repository::path.repository: + in: path + name: repository + description: Snapshot repository to clean up. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + snapshot.cleanup_repository::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + snapshot.cleanup_repository::query.master_timeout: + in: query + name: master_timeout + description: Period to wait for a connection to the master node. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.cleanup_repository::query.timeout: + in: query + name: timeout + description: Period to wait for a response. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + snapshot.clone::path.repository: + in: path + name: repository + description: A repository name + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + snapshot.clone::path.snapshot: + in: path + name: snapshot + description: The name of the snapshot to clone from + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + snapshot.clone::path.target_snapshot: + in: path + name: target_snapshot + description: The name of the cloned snapshot to create + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + snapshot.clone::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + snapshot.clone::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.create::path.repository: + in: path + name: repository + description: Repository for the snapshot. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + snapshot.create::path.snapshot: + in: path + name: snapshot + description: Name of the snapshot. Must be unique in the repository. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + snapshot.create::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + snapshot.create::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.create::query.wait_for_completion: + in: query + name: wait_for_completion + description: If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a + response when the snapshot initializes. + schema: + type: boolean + style: form + snapshot.create_repository::path.repository: + in: path + name: repository + description: A repository name + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + snapshot.create_repository::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + snapshot.create_repository::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.create_repository::query.timeout: + in: query + name: timeout + description: Explicit operation timeout + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + snapshot.create_repository::query.verify: + in: query + name: verify + description: Whether to verify the repository after creation + schema: + type: boolean + style: form + snapshot.delete::path.repository: + in: path + name: repository + description: A repository name + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + snapshot.delete::path.snapshot: + in: path + name: snapshot + description: A comma-separated list of snapshot names + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + snapshot.delete::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + snapshot.delete::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.delete_repository::path.repository: + in: path + name: repository + description: Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + snapshot.delete_repository::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + snapshot.delete_repository::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.delete_repository::query.timeout: + in: query + name: timeout + description: Explicit operation timeout + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + snapshot.get::path.repository: + in: path + name: repository + description: Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are + supported. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + snapshot.get::path.snapshot: + in: path + name: snapshot + description: |- + 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. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + snapshot.get::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + snapshot.get::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: If false, the request returns an error for any snapshots that are unavailable. + schema: + type: boolean + style: form + snapshot.get::query.master_timeout: + in: query + name: master_timeout + 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. + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.get::query.verbose: + in: query + name: verbose + description: If true, returns additional information about each snapshot such as the version of Opensearch which took + the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. + schema: + type: boolean + style: form + snapshot.get_repository::path.repository: + in: path + name: repository + description: A comma-separated list of repository names + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + snapshot.get_repository::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + snapshot.get_repository::query.local: + in: query + name: local + description: 'Return local information, do not retrieve the state from master node (default: false)' + schema: + type: boolean + style: form + snapshot.get_repository::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.restore::path.repository: + in: path + name: repository + description: A repository name + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + snapshot.restore::path.snapshot: + in: path + name: snapshot + description: A snapshot name + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + snapshot.restore::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + snapshot.restore::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.restore::query.wait_for_completion: + in: query + name: wait_for_completion + description: Should this request wait until the operation has completed before returning + schema: + type: boolean + style: form + snapshot.status::path.repository: + in: path + name: repository + description: A repository name + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + snapshot.status::path.snapshot: + in: path + name: snapshot + description: A comma-separated list of snapshot names + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Names' + style: simple + snapshot.status::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + snapshot.status::query.ignore_unavailable: + in: query + name: ignore_unavailable + description: Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown + schema: + type: boolean + style: form + snapshot.status::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.verify_repository::path.repository: + in: path + name: repository + description: A repository name + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Name' + style: simple + snapshot.verify_repository::query.cluster_manager_timeout: + name: cluster_manager_timeout + in: query + description: Operation timeout for connection to cluster-manager node. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + x-version-added: 2.0.0 + snapshot.verify_repository::query.master_timeout: + in: query + name: master_timeout + description: Explicit operation timeout for connection to master node + deprecated: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + x-version-deprecated: 2.0.0 + x-deprecation-message: To promote inclusive language, use 'cluster_manager_timeout' instead. + snapshot.verify_repository::query.timeout: + in: query + name: timeout + description: Explicit operation timeout + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form diff --git a/spec/namespaces/tasks.yaml b/spec/namespaces/tasks.yaml new file mode 100644 index 00000000..99411aec --- /dev/null +++ b/spec/namespaces/tasks.yaml @@ -0,0 +1,233 @@ +openapi: 3.1.0 +info: + title: OpenSearch Tasks API + description: OpenSearch Tasks API + version: 1.0.0 +paths: + /_tasks: + get: + operationId: tasks.list.0 + x-operation-group: tasks.list + x-version-added: '1.0' + description: Returns a list of tasks. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/tasks/ + parameters: + - $ref: '#/components/parameters/tasks.list::query.nodes' + - $ref: '#/components/parameters/tasks.list::query.actions' + - $ref: '#/components/parameters/tasks.list::query.detailed' + - $ref: '#/components/parameters/tasks.list::query.parent_task_id' + - $ref: '#/components/parameters/tasks.list::query.wait_for_completion' + - $ref: '#/components/parameters/tasks.list::query.group_by' + - $ref: '#/components/parameters/tasks.list::query.timeout' + responses: + '200': + $ref: '#/components/responses/tasks.list@200' + /_tasks/_cancel: + post: + operationId: tasks.cancel.0 + x-operation-group: tasks.cancel + x-version-added: '1.0' + description: Cancels a task, if it can be cancelled through an API. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/tasks/#task-canceling + parameters: + - $ref: '#/components/parameters/tasks.cancel::query.nodes' + - $ref: '#/components/parameters/tasks.cancel::query.actions' + - $ref: '#/components/parameters/tasks.cancel::query.parent_task_id' + - $ref: '#/components/parameters/tasks.cancel::query.wait_for_completion' + responses: + '200': + $ref: '#/components/responses/tasks.cancel@200' + /_tasks/{task_id}: + get: + operationId: tasks.get.0 + x-operation-group: tasks.get + x-version-added: '1.0' + description: Returns information about a task. + externalDocs: + url: https://opensearch.org/docs/latest/api-reference/tasks/ + parameters: + - $ref: '#/components/parameters/tasks.get::path.task_id' + - $ref: '#/components/parameters/tasks.get::query.wait_for_completion' + - $ref: '#/components/parameters/tasks.get::query.timeout' + responses: + '200': + $ref: '#/components/responses/tasks.get@200' + /_tasks/{task_id}/_cancel: + post: + operationId: tasks.cancel.1 + x-operation-group: tasks.cancel + x-version-added: '1.0' + description: Cancels a task, if it can be cancelled through an API. + parameters: + - $ref: '#/components/parameters/tasks.cancel::path.task_id' + - $ref: '#/components/parameters/tasks.cancel::query.nodes' + - $ref: '#/components/parameters/tasks.cancel::query.actions' + - $ref: '#/components/parameters/tasks.cancel::query.parent_task_id' + - $ref: '#/components/parameters/tasks.cancel::query.wait_for_completion' + responses: + '200': + $ref: '#/components/responses/tasks.cancel@200' +components: + requestBodies: {} + responses: + tasks.cancel@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/tasks._common.yaml#/components/schemas/TaskListResponseBase' + tasks.get@200: + description: '' + content: + application/json: + schema: + type: object + properties: + completed: + type: boolean + task: + $ref: '../schemas/tasks._common.yaml#/components/schemas/TaskInfo' + response: + type: object + error: + $ref: '../schemas/_common.yaml#/components/schemas/ErrorCause' + required: + - completed + - task + tasks.list@200: + description: '' + content: + application/json: + schema: + $ref: '../schemas/tasks._common.yaml#/components/schemas/TaskListResponseBase' + parameters: + tasks.cancel::path.task_id: + in: path + name: task_id + description: ID of the task. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/TaskId' + style: simple + tasks.cancel::query.actions: + in: query + name: actions + description: Comma-separated list or wildcard expression of actions used to limit the request. + schema: + oneOf: + - type: string + - type: array + items: + type: string + style: form + tasks.cancel::query.nodes: + in: query + name: nodes + description: Comma-separated list of node IDs or names used to limit the request. + schema: + type: array + items: + type: string + style: form + tasks.cancel::query.parent_task_id: + in: query + name: parent_task_id + description: Parent task ID used to limit the tasks. + schema: + type: string + style: form + tasks.cancel::query.wait_for_completion: + in: query + name: wait_for_completion + description: Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults + to false + schema: + type: boolean + style: form + tasks.get::path.task_id: + in: path + name: task_id + description: ID of the task. + required: true + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: simple + tasks.get::query.timeout: + in: query + name: timeout + description: |- + Period to wait for a response. + If no response is received before the timeout expires, the request fails and returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + tasks.get::query.wait_for_completion: + in: query + name: wait_for_completion + description: If `true`, the request blocks until the task has completed. + schema: + type: boolean + style: form + tasks.list::query.actions: + in: query + name: actions + description: Comma-separated list or wildcard expression of actions used to limit the request. + schema: + oneOf: + - type: string + - type: array + items: + type: string + style: form + tasks.list::query.detailed: + in: query + name: detailed + description: If `true`, the response includes detailed information about shard recoveries. + schema: + type: boolean + style: form + tasks.list::query.group_by: + in: query + name: group_by + description: Key used to group tasks in the response. + schema: + $ref: '../schemas/tasks._common.yaml#/components/schemas/GroupBy' + style: form + tasks.list::query.nodes: + name: nodes + in: query + description: 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. + style: form + schema: + type: array + items: + type: string + description: 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. + explode: true + tasks.list::query.parent_task_id: + in: query + name: parent_task_id + description: Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value + of `-1`. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Id' + style: form + tasks.list::query.timeout: + in: query + name: timeout + description: Period to wait for a response. If no response is received before the timeout expires, the request fails and + returns an error. + schema: + $ref: '../schemas/_common.yaml#/components/schemas/Duration' + style: form + tasks.list::query.wait_for_completion: + in: query + name: wait_for_completion + description: If `true`, the request blocks until the operation is complete. + schema: + type: boolean + style: form diff --git a/spec/schemas/_common.aggregations.yaml b/spec/schemas/_common.aggregations.yaml new file mode 100644 index 00000000..316a8b57 --- /dev/null +++ b/spec/schemas/_common.aggregations.yaml @@ -0,0 +1,3658 @@ +openapi: 3.1.0 +info: + title: Schemas of _common.aggregations category + description: Schemas of _common.aggregations category + version: 1.0.0 +paths: {} +components: + schemas: + Aggregate: + oneOf: + - $ref: '#/components/schemas/CardinalityAggregate' + - $ref: '#/components/schemas/HdrPercentilesAggregate' + - $ref: '#/components/schemas/HdrPercentileRanksAggregate' + - $ref: '#/components/schemas/TDigestPercentilesAggregate' + - $ref: '#/components/schemas/TDigestPercentileRanksAggregate' + - $ref: '#/components/schemas/PercentilesBucketAggregate' + - $ref: '#/components/schemas/MedianAbsoluteDeviationAggregate' + - $ref: '#/components/schemas/MinAggregate' + - $ref: '#/components/schemas/MaxAggregate' + - $ref: '#/components/schemas/SumAggregate' + - $ref: '#/components/schemas/AvgAggregate' + - $ref: '#/components/schemas/WeightedAvgAggregate' + - $ref: '#/components/schemas/ValueCountAggregate' + - $ref: '#/components/schemas/SimpleValueAggregate' + - $ref: '#/components/schemas/DerivativeAggregate' + - $ref: '#/components/schemas/BucketMetricValueAggregate' + - $ref: '#/components/schemas/StatsAggregate' + - $ref: '#/components/schemas/StatsBucketAggregate' + - $ref: '#/components/schemas/ExtendedStatsAggregate' + - $ref: '#/components/schemas/ExtendedStatsBucketAggregate' + - $ref: '#/components/schemas/GeoBoundsAggregate' + - $ref: '#/components/schemas/GeoCentroidAggregate' + - $ref: '#/components/schemas/HistogramAggregate' + - $ref: '#/components/schemas/DateHistogramAggregate' + - $ref: '#/components/schemas/AutoDateHistogramAggregate' + - $ref: '#/components/schemas/VariableWidthHistogramAggregate' + - $ref: '#/components/schemas/StringTermsAggregate' + - $ref: '#/components/schemas/LongTermsAggregate' + - $ref: '#/components/schemas/DoubleTermsAggregate' + - $ref: '#/components/schemas/UnmappedTermsAggregate' + - $ref: '#/components/schemas/LongRareTermsAggregate' + - $ref: '#/components/schemas/StringRareTermsAggregate' + - $ref: '#/components/schemas/UnmappedRareTermsAggregate' + - $ref: '#/components/schemas/MultiTermsAggregate' + - $ref: '#/components/schemas/MissingAggregate' + - $ref: '#/components/schemas/NestedAggregate' + - $ref: '#/components/schemas/ReverseNestedAggregate' + - $ref: '#/components/schemas/GlobalAggregate' + - $ref: '#/components/schemas/FilterAggregate' + - $ref: '#/components/schemas/ChildrenAggregate' + - $ref: '#/components/schemas/ParentAggregate' + - $ref: '#/components/schemas/SamplerAggregate' + - $ref: '#/components/schemas/UnmappedSamplerAggregate' + - $ref: '#/components/schemas/GeoHashGridAggregate' + - $ref: '#/components/schemas/GeoTileGridAggregate' + - $ref: '#/components/schemas/GeoHexGridAggregate' + - $ref: '#/components/schemas/RangeAggregate' + - $ref: '#/components/schemas/DateRangeAggregate' + - $ref: '#/components/schemas/GeoDistanceAggregate' + - $ref: '#/components/schemas/IpRangeAggregate' + - $ref: '#/components/schemas/IpPrefixAggregate' + - $ref: '#/components/schemas/FiltersAggregate' + - $ref: '#/components/schemas/AdjacencyMatrixAggregate' + - $ref: '#/components/schemas/SignificantLongTermsAggregate' + - $ref: '#/components/schemas/SignificantStringTermsAggregate' + - $ref: '#/components/schemas/UnmappedSignificantTermsAggregate' + - $ref: '#/components/schemas/CompositeAggregate' + - $ref: '#/components/schemas/FrequentItemSetsAggregate' + - $ref: '#/components/schemas/ScriptedMetricAggregate' + - $ref: '#/components/schemas/TopHitsAggregate' + - $ref: '#/components/schemas/InferenceAggregate' + - $ref: '#/components/schemas/StringStatsAggregate' + - $ref: '#/components/schemas/BoxPlotAggregate' + - $ref: '#/components/schemas/TopMetricsAggregate' + - $ref: '#/components/schemas/TTestAggregate' + - $ref: '#/components/schemas/RateAggregate' + - $ref: '#/components/schemas/CumulativeCardinalityAggregate' + - $ref: '#/components/schemas/MatrixStatsAggregate' + - $ref: '#/components/schemas/GeoLineAggregate' + CardinalityAggregate: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + value: + type: number + required: + - value + AggregateBase: + type: object + properties: + meta: + $ref: '_common.yaml#/components/schemas/Metadata' + HdrPercentilesAggregate: + allOf: + - $ref: '#/components/schemas/PercentilesAggregateBase' + - type: object + PercentilesAggregateBase: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + values: + $ref: '#/components/schemas/Percentiles' + required: + - values + Percentiles: + oneOf: + - $ref: '#/components/schemas/KeyedPercentiles' + - type: array + items: + $ref: '#/components/schemas/ArrayPercentilesItem' + KeyedPercentiles: + type: object + additionalProperties: + oneOf: + - type: string + - type: number + - nullable: true + type: string + ArrayPercentilesItem: + type: object + properties: + key: + type: string + value: + oneOf: + - type: number + - nullable: true + type: string + value_as_string: + type: string + required: + - key + - value + HdrPercentileRanksAggregate: + allOf: + - $ref: '#/components/schemas/PercentilesAggregateBase' + - type: object + TDigestPercentilesAggregate: + allOf: + - $ref: '#/components/schemas/PercentilesAggregateBase' + - type: object + TDigestPercentileRanksAggregate: + allOf: + - $ref: '#/components/schemas/PercentilesAggregateBase' + - type: object + PercentilesBucketAggregate: + allOf: + - $ref: '#/components/schemas/PercentilesAggregateBase' + - type: object + MedianAbsoluteDeviationAggregate: + allOf: + - $ref: '#/components/schemas/SingleMetricAggregateBase' + - type: object + SingleMetricAggregateBase: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + value: + description: |- + The metric value. A missing value generally means that there was no data to aggregate, + unless specified otherwise. + oneOf: + - type: number + - nullable: true + type: string + value_as_string: + type: string + required: + - value + MinAggregate: + allOf: + - $ref: '#/components/schemas/SingleMetricAggregateBase' + - type: object + MaxAggregate: + allOf: + - $ref: '#/components/schemas/SingleMetricAggregateBase' + - type: object + SumAggregate: + allOf: + - $ref: '#/components/schemas/SingleMetricAggregateBase' + - type: object + AvgAggregate: + allOf: + - $ref: '#/components/schemas/SingleMetricAggregateBase' + - type: object + WeightedAvgAggregate: + allOf: + - $ref: '#/components/schemas/SingleMetricAggregateBase' + - type: object + ValueCountAggregate: + allOf: + - $ref: '#/components/schemas/SingleMetricAggregateBase' + - type: object + SimpleValueAggregate: + allOf: + - $ref: '#/components/schemas/SingleMetricAggregateBase' + - type: object + DerivativeAggregate: + allOf: + - $ref: '#/components/schemas/SingleMetricAggregateBase' + - type: object + properties: + normalized_value: + type: number + normalized_value_as_string: + type: string + BucketMetricValueAggregate: + allOf: + - $ref: '#/components/schemas/SingleMetricAggregateBase' + - type: object + properties: + keys: + type: array + items: + type: string + required: + - keys + StatsAggregate: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + count: + type: number + min: + oneOf: + - type: number + - nullable: true + type: string + max: + oneOf: + - type: number + - nullable: true + type: string + avg: + oneOf: + - type: number + - nullable: true + type: string + sum: + type: number + min_as_string: + type: string + max_as_string: + type: string + avg_as_string: + type: string + sum_as_string: + type: string + required: + - count + - min + - max + - avg + - sum + StatsBucketAggregate: + allOf: + - $ref: '#/components/schemas/StatsAggregate' + - type: object + ExtendedStatsAggregate: + allOf: + - $ref: '#/components/schemas/StatsAggregate' + - type: object + properties: + sum_of_squares: + oneOf: + - type: number + - nullable: true + type: string + variance: + oneOf: + - type: number + - nullable: true + type: string + variance_population: + oneOf: + - type: number + - nullable: true + type: string + variance_sampling: + oneOf: + - type: number + - nullable: true + type: string + std_deviation: + oneOf: + - type: number + - nullable: true + type: string + std_deviation_population: + oneOf: + - type: number + - nullable: true + type: string + std_deviation_sampling: + oneOf: + - type: number + - nullable: true + type: string + std_deviation_bounds: + $ref: '#/components/schemas/StandardDeviationBounds' + sum_of_squares_as_string: + type: string + variance_as_string: + type: string + variance_population_as_string: + type: string + variance_sampling_as_string: + type: string + std_deviation_as_string: + type: string + std_deviation_bounds_as_string: + $ref: '#/components/schemas/StandardDeviationBoundsAsString' + required: + - sum_of_squares + - variance + - variance_population + - variance_sampling + - std_deviation + - std_deviation_population + - std_deviation_sampling + StandardDeviationBounds: + type: object + properties: + upper: + oneOf: + - type: number + - nullable: true + type: string + lower: + oneOf: + - type: number + - nullable: true + type: string + upper_population: + oneOf: + - type: number + - nullable: true + type: string + lower_population: + oneOf: + - type: number + - nullable: true + type: string + upper_sampling: + oneOf: + - type: number + - nullable: true + type: string + lower_sampling: + oneOf: + - type: number + - nullable: true + type: string + required: + - upper + - lower + - upper_population + - lower_population + - upper_sampling + - lower_sampling + StandardDeviationBoundsAsString: + type: object + properties: + upper: + type: string + lower: + type: string + upper_population: + type: string + lower_population: + type: string + upper_sampling: + type: string + lower_sampling: + type: string + required: + - upper + - lower + - upper_population + - lower_population + - upper_sampling + - lower_sampling + ExtendedStatsBucketAggregate: + allOf: + - $ref: '#/components/schemas/ExtendedStatsAggregate' + - type: object + GeoBoundsAggregate: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + bounds: + $ref: '_common.yaml#/components/schemas/GeoBounds' + GeoCentroidAggregate: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + count: + type: number + location: + $ref: '_common.yaml#/components/schemas/GeoLocation' + required: + - count + HistogramAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseHistogramBucket' + - type: object + MultiBucketAggregateBaseHistogramBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsHistogramBucket' + required: + - buckets + BucketsHistogramBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/HistogramBucket' + - type: array + items: + $ref: '#/components/schemas/HistogramBucket' + HistogramBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + key_as_string: + type: string + key: + type: number + required: + - key + MultiBucketBase: + type: object + properties: + doc_count: + type: number + required: + - doc_count + DateHistogramAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseDateHistogramBucket' + - type: object + MultiBucketAggregateBaseDateHistogramBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsDateHistogramBucket' + required: + - buckets + BucketsDateHistogramBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/DateHistogramBucket' + - type: array + items: + $ref: '#/components/schemas/DateHistogramBucket' + DateHistogramBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + key_as_string: + type: string + key: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + required: + - key + AutoDateHistogramAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseDateHistogramBucket' + - type: object + properties: + interval: + $ref: '_common.yaml#/components/schemas/DurationLarge' + required: + - interval + VariableWidthHistogramAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseVariableWidthHistogramBucket' + - type: object + MultiBucketAggregateBaseVariableWidthHistogramBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsVariableWidthHistogramBucket' + required: + - buckets + BucketsVariableWidthHistogramBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/VariableWidthHistogramBucket' + - type: array + items: + $ref: '#/components/schemas/VariableWidthHistogramBucket' + VariableWidthHistogramBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + min: + type: number + key: + type: number + max: + type: number + min_as_string: + type: string + key_as_string: + type: string + max_as_string: + type: string + required: + - min + - key + - max + StringTermsAggregate: + allOf: + - $ref: '#/components/schemas/TermsAggregateBaseStringTermsBucket' + - type: object + TermsAggregateBaseStringTermsBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseStringTermsBucket' + - type: object + properties: + doc_count_error_upper_bound: + type: number + sum_other_doc_count: + type: number + MultiBucketAggregateBaseStringTermsBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsStringTermsBucket' + required: + - buckets + BucketsStringTermsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/StringTermsBucket' + - type: array + items: + $ref: '#/components/schemas/StringTermsBucket' + StringTermsBucket: + allOf: + - $ref: '#/components/schemas/TermsBucketBase' + - type: object + properties: + key: + $ref: '_common.yaml#/components/schemas/FieldValue' + required: + - key + TermsBucketBase: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + doc_count_error: + type: number + LongTermsAggregate: + allOf: + - $ref: '#/components/schemas/TermsAggregateBaseLongTermsBucket' + - type: object + TermsAggregateBaseLongTermsBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseLongTermsBucket' + - type: object + properties: + doc_count_error_upper_bound: + type: number + sum_other_doc_count: + type: number + MultiBucketAggregateBaseLongTermsBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsLongTermsBucket' + required: + - buckets + BucketsLongTermsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/LongTermsBucket' + - type: array + items: + $ref: '#/components/schemas/LongTermsBucket' + LongTermsBucket: + allOf: + - $ref: '#/components/schemas/TermsBucketBase' + - type: object + properties: + key: + type: number + key_as_string: + type: string + required: + - key + DoubleTermsAggregate: + allOf: + - $ref: '#/components/schemas/TermsAggregateBaseDoubleTermsBucket' + - type: object + TermsAggregateBaseDoubleTermsBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseDoubleTermsBucket' + - type: object + properties: + doc_count_error_upper_bound: + type: number + sum_other_doc_count: + type: number + MultiBucketAggregateBaseDoubleTermsBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsDoubleTermsBucket' + required: + - buckets + BucketsDoubleTermsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/DoubleTermsBucket' + - type: array + items: + $ref: '#/components/schemas/DoubleTermsBucket' + DoubleTermsBucket: + allOf: + - $ref: '#/components/schemas/TermsBucketBase' + - type: object + properties: + key: + type: number + key_as_string: + type: string + required: + - key + UnmappedTermsAggregate: + allOf: + - $ref: '#/components/schemas/TermsAggregateBaseVoid' + - type: object + TermsAggregateBaseVoid: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseVoid' + - type: object + properties: + doc_count_error_upper_bound: + type: number + sum_other_doc_count: + type: number + MultiBucketAggregateBaseVoid: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsVoid' + required: + - buckets + BucketsVoid: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '_common.yaml#/components/schemas/Void' + - type: array + items: + $ref: '_common.yaml#/components/schemas/Void' + LongRareTermsAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseLongRareTermsBucket' + - type: object + MultiBucketAggregateBaseLongRareTermsBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsLongRareTermsBucket' + required: + - buckets + BucketsLongRareTermsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/LongRareTermsBucket' + - type: array + items: + $ref: '#/components/schemas/LongRareTermsBucket' + LongRareTermsBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + key: + type: number + key_as_string: + type: string + required: + - key + StringRareTermsAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseStringRareTermsBucket' + - type: object + MultiBucketAggregateBaseStringRareTermsBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsStringRareTermsBucket' + required: + - buckets + BucketsStringRareTermsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/StringRareTermsBucket' + - type: array + items: + $ref: '#/components/schemas/StringRareTermsBucket' + StringRareTermsBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + key: + type: string + required: + - key + UnmappedRareTermsAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseVoid' + - type: object + MultiTermsAggregate: + allOf: + - $ref: '#/components/schemas/TermsAggregateBaseMultiTermsBucket' + - type: object + TermsAggregateBaseMultiTermsBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseMultiTermsBucket' + - type: object + properties: + doc_count_error_upper_bound: + type: number + sum_other_doc_count: + type: number + MultiBucketAggregateBaseMultiTermsBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsMultiTermsBucket' + required: + - buckets + BucketsMultiTermsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/MultiTermsBucket' + - type: array + items: + $ref: '#/components/schemas/MultiTermsBucket' + MultiTermsBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + key: + type: array + items: + $ref: '_common.yaml#/components/schemas/FieldValue' + key_as_string: + type: string + doc_count_error_upper_bound: + type: number + required: + - key + MissingAggregate: + allOf: + - $ref: '#/components/schemas/SingleBucketAggregateBase' + - type: object + SingleBucketAggregateBase: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + doc_count: + type: number + required: + - doc_count + NestedAggregate: + allOf: + - $ref: '#/components/schemas/SingleBucketAggregateBase' + - type: object + ReverseNestedAggregate: + allOf: + - $ref: '#/components/schemas/SingleBucketAggregateBase' + - type: object + GlobalAggregate: + allOf: + - $ref: '#/components/schemas/SingleBucketAggregateBase' + - type: object + FilterAggregate: + allOf: + - $ref: '#/components/schemas/SingleBucketAggregateBase' + - type: object + ChildrenAggregate: + allOf: + - $ref: '#/components/schemas/SingleBucketAggregateBase' + - type: object + ParentAggregate: + allOf: + - $ref: '#/components/schemas/SingleBucketAggregateBase' + - type: object + SamplerAggregate: + allOf: + - $ref: '#/components/schemas/SingleBucketAggregateBase' + - type: object + UnmappedSamplerAggregate: + allOf: + - $ref: '#/components/schemas/SingleBucketAggregateBase' + - type: object + GeoHashGridAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseGeoHashGridBucket' + - type: object + MultiBucketAggregateBaseGeoHashGridBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsGeoHashGridBucket' + required: + - buckets + BucketsGeoHashGridBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/GeoHashGridBucket' + - type: array + items: + $ref: '#/components/schemas/GeoHashGridBucket' + GeoHashGridBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + key: + $ref: '_common.yaml#/components/schemas/GeoHash' + required: + - key + GeoTileGridAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseGeoTileGridBucket' + - type: object + MultiBucketAggregateBaseGeoTileGridBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsGeoTileGridBucket' + required: + - buckets + BucketsGeoTileGridBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/GeoTileGridBucket' + - type: array + items: + $ref: '#/components/schemas/GeoTileGridBucket' + GeoTileGridBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + key: + $ref: '_common.yaml#/components/schemas/GeoTile' + required: + - key + GeoHexGridAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseGeoHexGridBucket' + - type: object + MultiBucketAggregateBaseGeoHexGridBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsGeoHexGridBucket' + required: + - buckets + BucketsGeoHexGridBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/GeoHexGridBucket' + - type: array + items: + $ref: '#/components/schemas/GeoHexGridBucket' + GeoHexGridBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + key: + $ref: '_common.yaml#/components/schemas/GeoHexCell' + required: + - key + RangeAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseRangeBucket' + - type: object + MultiBucketAggregateBaseRangeBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsRangeBucket' + required: + - buckets + BucketsRangeBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/RangeBucket' + - type: array + items: + $ref: '#/components/schemas/RangeBucket' + RangeBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + from: + type: number + to: + type: number + from_as_string: + type: string + to_as_string: + type: string + key: + description: The bucket key. Present if the aggregation is _not_ keyed + type: string + DateRangeAggregate: + allOf: + - $ref: '#/components/schemas/RangeAggregate' + - type: object + GeoDistanceAggregate: + allOf: + - $ref: '#/components/schemas/RangeAggregate' + - type: object + IpRangeAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseIpRangeBucket' + - type: object + MultiBucketAggregateBaseIpRangeBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsIpRangeBucket' + required: + - buckets + BucketsIpRangeBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/IpRangeBucket' + - type: array + items: + $ref: '#/components/schemas/IpRangeBucket' + IpRangeBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + key: + type: string + from: + type: string + to: + type: string + IpPrefixAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseIpPrefixBucket' + - type: object + MultiBucketAggregateBaseIpPrefixBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsIpPrefixBucket' + required: + - buckets + BucketsIpPrefixBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/IpPrefixBucket' + - type: array + items: + $ref: '#/components/schemas/IpPrefixBucket' + IpPrefixBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + is_ipv6: + type: boolean + key: + type: string + prefix_length: + type: number + netmask: + type: string + required: + - is_ipv6 + - key + - prefix_length + FiltersAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseFiltersBucket' + - type: object + MultiBucketAggregateBaseFiltersBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsFiltersBucket' + required: + - buckets + BucketsFiltersBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/FiltersBucket' + - type: array + items: + $ref: '#/components/schemas/FiltersBucket' + FiltersBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + AdjacencyMatrixAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseAdjacencyMatrixBucket' + - type: object + MultiBucketAggregateBaseAdjacencyMatrixBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsAdjacencyMatrixBucket' + required: + - buckets + BucketsAdjacencyMatrixBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/AdjacencyMatrixBucket' + - type: array + items: + $ref: '#/components/schemas/AdjacencyMatrixBucket' + AdjacencyMatrixBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + key: + type: string + required: + - key + SignificantLongTermsAggregate: + allOf: + - $ref: '#/components/schemas/SignificantTermsAggregateBaseSignificantLongTermsBucket' + - type: object + SignificantTermsAggregateBaseSignificantLongTermsBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseSignificantLongTermsBucket' + - type: object + properties: + bg_count: + type: number + doc_count: + type: number + MultiBucketAggregateBaseSignificantLongTermsBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsSignificantLongTermsBucket' + required: + - buckets + BucketsSignificantLongTermsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/SignificantLongTermsBucket' + - type: array + items: + $ref: '#/components/schemas/SignificantLongTermsBucket' + SignificantLongTermsBucket: + allOf: + - $ref: '#/components/schemas/SignificantTermsBucketBase' + - type: object + properties: + key: + type: number + key_as_string: + type: string + required: + - key + SignificantTermsBucketBase: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + score: + type: number + bg_count: + type: number + required: + - score + - bg_count + SignificantStringTermsAggregate: + allOf: + - $ref: '#/components/schemas/SignificantTermsAggregateBaseSignificantStringTermsBucket' + - type: object + SignificantTermsAggregateBaseSignificantStringTermsBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseSignificantStringTermsBucket' + - type: object + properties: + bg_count: + type: number + doc_count: + type: number + MultiBucketAggregateBaseSignificantStringTermsBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsSignificantStringTermsBucket' + required: + - buckets + BucketsSignificantStringTermsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/SignificantStringTermsBucket' + - type: array + items: + $ref: '#/components/schemas/SignificantStringTermsBucket' + SignificantStringTermsBucket: + allOf: + - $ref: '#/components/schemas/SignificantTermsBucketBase' + - type: object + properties: + key: + type: string + required: + - key + UnmappedSignificantTermsAggregate: + allOf: + - $ref: '#/components/schemas/SignificantTermsAggregateBaseVoid' + - type: object + SignificantTermsAggregateBaseVoid: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseVoid' + - type: object + properties: + bg_count: + type: number + doc_count: + type: number + CompositeAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseCompositeBucket' + - type: object + properties: + after_key: + $ref: '#/components/schemas/CompositeAggregateKey' + CompositeAggregateKey: + type: object + additionalProperties: + $ref: '_common.yaml#/components/schemas/FieldValue' + MultiBucketAggregateBaseCompositeBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsCompositeBucket' + required: + - buckets + BucketsCompositeBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/CompositeBucket' + - type: array + items: + $ref: '#/components/schemas/CompositeBucket' + CompositeBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + key: + $ref: '#/components/schemas/CompositeAggregateKey' + required: + - key + FrequentItemSetsAggregate: + allOf: + - $ref: '#/components/schemas/MultiBucketAggregateBaseFrequentItemSetsBucket' + - type: object + MultiBucketAggregateBaseFrequentItemSetsBucket: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + buckets: + $ref: '#/components/schemas/BucketsFrequentItemSetsBucket' + required: + - buckets + BucketsFrequentItemSetsBucket: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '#/components/schemas/FrequentItemSetsBucket' + - type: array + items: + $ref: '#/components/schemas/FrequentItemSetsBucket' + FrequentItemSetsBucket: + allOf: + - $ref: '#/components/schemas/MultiBucketBase' + - type: object + properties: + key: + type: object + additionalProperties: + type: array + items: + type: string + support: + type: number + required: + - key + - support + ScriptedMetricAggregate: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + value: + type: object + required: + - value + TopHitsAggregate: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + hits: + $ref: '_core.search.yaml#/components/schemas/HitsMetadata' + required: + - hits + InferenceAggregate: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + value: + $ref: '_common.yaml#/components/schemas/FieldValue' + feature_importance: + type: array + items: + $ref: '#/components/schemas/InferenceFeatureImportance' + top_classes: + type: array + items: + $ref: '#/components/schemas/InferenceTopClassEntry' + warning: + type: string + InferenceFeatureImportance: + type: object + properties: + feature_name: + type: string + importance: + type: number + classes: + type: array + items: + $ref: '#/components/schemas/InferenceClassImportance' + required: + - feature_name + InferenceClassImportance: + type: object + properties: + class_name: + type: string + importance: + type: number + required: + - class_name + - importance + InferenceTopClassEntry: + type: object + properties: + class_name: + $ref: '_common.yaml#/components/schemas/FieldValue' + class_probability: + type: number + class_score: + type: number + required: + - class_name + - class_probability + - class_score + StringStatsAggregate: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + count: + type: number + min_length: + oneOf: + - type: number + - nullable: true + type: string + max_length: + oneOf: + - type: number + - nullable: true + type: string + avg_length: + oneOf: + - type: number + - nullable: true + type: string + entropy: + oneOf: + - type: number + - nullable: true + type: string + distribution: + oneOf: + - type: object + additionalProperties: + type: number + - nullable: true + type: string + min_length_as_string: + type: string + max_length_as_string: + type: string + avg_length_as_string: + type: string + required: + - count + - min_length + - max_length + - avg_length + - entropy + BoxPlotAggregate: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + min: + type: number + max: + type: number + q1: + type: number + q2: + type: number + q3: + type: number + lower: + type: number + upper: + type: number + min_as_string: + type: string + max_as_string: + type: string + q1_as_string: + type: string + q2_as_string: + type: string + q3_as_string: + type: string + lower_as_string: + type: string + upper_as_string: + type: string + required: + - min + - max + - q1 + - q2 + - q3 + - lower + - upper + TopMetricsAggregate: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + top: + type: array + items: + $ref: '#/components/schemas/TopMetrics' + required: + - top + TopMetrics: + type: object + properties: + sort: + type: array + items: + oneOf: + - $ref: '_common.yaml#/components/schemas/FieldValue' + - nullable: true + type: string + metrics: + type: object + additionalProperties: + oneOf: + - $ref: '_common.yaml#/components/schemas/FieldValue' + - nullable: true + type: string + required: + - sort + - metrics + TTestAggregate: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + value: + oneOf: + - type: number + - nullable: true + type: string + value_as_string: + type: string + required: + - value + RateAggregate: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + value: + type: number + value_as_string: + type: string + required: + - value + CumulativeCardinalityAggregate: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + value: + type: number + value_as_string: + type: string + required: + - value + MatrixStatsAggregate: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + doc_count: + type: number + fields: + type: array + items: + $ref: '#/components/schemas/MatrixStatsFields' + required: + - doc_count + MatrixStatsFields: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Field' + count: + type: number + mean: + type: number + variance: + type: number + skewness: + type: number + kurtosis: + type: number + covariance: + type: object + additionalProperties: + type: number + correlation: + type: object + additionalProperties: + type: number + required: + - name + - count + - mean + - variance + - skewness + - kurtosis + - covariance + - correlation + GeoLineAggregate: + allOf: + - $ref: '#/components/schemas/AggregateBase' + - type: object + properties: + type: + type: string + geometry: + $ref: '_common.yaml#/components/schemas/GeoLine' + properties: + type: object + required: + - type + - geometry + - properties + AggregationContainer: + allOf: + - type: object + properties: + aggregations: + description: |- + Sub-aggregations for this aggregation. + Only applies to bucket aggregations. + type: object + additionalProperties: + $ref: '#/components/schemas/AggregationContainer' + meta: + $ref: '_common.yaml#/components/schemas/Metadata' + - type: object + properties: + adjacency_matrix: + $ref: '#/components/schemas/AdjacencyMatrixAggregation' + auto_date_histogram: + $ref: '#/components/schemas/AutoDateHistogramAggregation' + avg: + $ref: '#/components/schemas/AverageAggregation' + avg_bucket: + $ref: '#/components/schemas/AverageBucketAggregation' + boxplot: + $ref: '#/components/schemas/BoxplotAggregation' + bucket_script: + $ref: '#/components/schemas/BucketScriptAggregation' + bucket_selector: + $ref: '#/components/schemas/BucketSelectorAggregation' + bucket_sort: + $ref: '#/components/schemas/BucketSortAggregation' + bucket_count_ks_test: + $ref: '#/components/schemas/BucketKsAggregation' + bucket_correlation: + $ref: '#/components/schemas/BucketCorrelationAggregation' + cardinality: + $ref: '#/components/schemas/CardinalityAggregation' + categorize_text: + $ref: '#/components/schemas/CategorizeTextAggregation' + children: + $ref: '#/components/schemas/ChildrenAggregation' + composite: + $ref: '#/components/schemas/CompositeAggregation' + cumulative_cardinality: + $ref: '#/components/schemas/CumulativeCardinalityAggregation' + cumulative_sum: + $ref: '#/components/schemas/CumulativeSumAggregation' + date_histogram: + $ref: '#/components/schemas/DateHistogramAggregation' + date_range: + $ref: '#/components/schemas/DateRangeAggregation' + derivative: + $ref: '#/components/schemas/DerivativeAggregation' + diversified_sampler: + $ref: '#/components/schemas/DiversifiedSamplerAggregation' + extended_stats: + $ref: '#/components/schemas/ExtendedStatsAggregation' + extended_stats_bucket: + $ref: '#/components/schemas/ExtendedStatsBucketAggregation' + frequent_item_sets: + $ref: '#/components/schemas/FrequentItemSetsAggregation' + filter: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + filters: + $ref: '#/components/schemas/FiltersAggregation' + geo_bounds: + $ref: '#/components/schemas/GeoBoundsAggregation' + geo_centroid: + $ref: '#/components/schemas/GeoCentroidAggregation' + geo_distance: + $ref: '#/components/schemas/GeoDistanceAggregation' + geohash_grid: + $ref: '#/components/schemas/GeoHashGridAggregation' + geo_line: + $ref: '#/components/schemas/GeoLineAggregation' + geotile_grid: + $ref: '#/components/schemas/GeoTileGridAggregation' + geohex_grid: + $ref: '#/components/schemas/GeohexGridAggregation' + global: + $ref: '#/components/schemas/GlobalAggregation' + histogram: + $ref: '#/components/schemas/HistogramAggregation' + ip_range: + $ref: '#/components/schemas/IpRangeAggregation' + ip_prefix: + $ref: '#/components/schemas/IpPrefixAggregation' + inference: + $ref: '#/components/schemas/InferenceAggregation' + line: + $ref: '#/components/schemas/GeoLineAggregation' + matrix_stats: + $ref: '#/components/schemas/MatrixStatsAggregation' + max: + $ref: '#/components/schemas/MaxAggregation' + max_bucket: + $ref: '#/components/schemas/MaxBucketAggregation' + median_absolute_deviation: + $ref: '#/components/schemas/MedianAbsoluteDeviationAggregation' + min: + $ref: '#/components/schemas/MinAggregation' + min_bucket: + $ref: '#/components/schemas/MinBucketAggregation' + missing: + $ref: '#/components/schemas/MissingAggregation' + moving_avg: + $ref: '#/components/schemas/MovingAverageAggregation' + moving_percentiles: + $ref: '#/components/schemas/MovingPercentilesAggregation' + moving_fn: + $ref: '#/components/schemas/MovingFunctionAggregation' + multi_terms: + $ref: '#/components/schemas/MultiTermsAggregation' + nested: + $ref: '#/components/schemas/NestedAggregation' + normalize: + $ref: '#/components/schemas/NormalizeAggregation' + parent: + $ref: '#/components/schemas/ParentAggregation' + percentile_ranks: + $ref: '#/components/schemas/PercentileRanksAggregation' + percentiles: + $ref: '#/components/schemas/PercentilesAggregation' + percentiles_bucket: + $ref: '#/components/schemas/PercentilesBucketAggregation' + range: + $ref: '#/components/schemas/RangeAggregation' + rare_terms: + $ref: '#/components/schemas/RareTermsAggregation' + rate: + $ref: '#/components/schemas/RateAggregation' + reverse_nested: + $ref: '#/components/schemas/ReverseNestedAggregation' + sampler: + $ref: '#/components/schemas/SamplerAggregation' + scripted_metric: + $ref: '#/components/schemas/ScriptedMetricAggregation' + serial_diff: + $ref: '#/components/schemas/SerialDifferencingAggregation' + significant_terms: + $ref: '#/components/schemas/SignificantTermsAggregation' + significant_text: + $ref: '#/components/schemas/SignificantTextAggregation' + stats: + $ref: '#/components/schemas/StatsAggregation' + stats_bucket: + $ref: '#/components/schemas/StatsBucketAggregation' + string_stats: + $ref: '#/components/schemas/StringStatsAggregation' + sum: + $ref: '#/components/schemas/SumAggregation' + sum_bucket: + $ref: '#/components/schemas/SumBucketAggregation' + terms: + $ref: '#/components/schemas/TermsAggregation' + top_hits: + $ref: '#/components/schemas/TopHitsAggregation' + t_test: + $ref: '#/components/schemas/TTestAggregation' + top_metrics: + $ref: '#/components/schemas/TopMetricsAggregation' + value_count: + $ref: '#/components/schemas/ValueCountAggregation' + weighted_avg: + $ref: '#/components/schemas/WeightedAverageAggregation' + variable_width_histogram: + $ref: '#/components/schemas/VariableWidthHistogramAggregation' + minProperties: 1 + maxProperties: 1 + AdjacencyMatrixAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + filters: + description: |- + Filters used to create buckets. + At least one filter is required. + type: object + additionalProperties: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + BucketAggregationBase: + allOf: + - $ref: '#/components/schemas/Aggregation' + - type: object + Aggregation: + type: object + properties: + meta: + $ref: '_common.yaml#/components/schemas/Metadata' + name: + type: string + AutoDateHistogramAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + buckets: + description: The target number of buckets. + type: number + field: + $ref: '_common.yaml#/components/schemas/Field' + format: + description: |- + The date format used to format `key_as_string` in the response. + If no `format` is specified, the first date format specified in the field mapping is used. + type: string + minimum_interval: + $ref: '#/components/schemas/MinimumInterval' + missing: + $ref: '_common.yaml#/components/schemas/DateTime' + offset: + description: Time zone specified as a ISO 8601 UTC offset. + type: string + params: + type: object + additionalProperties: + type: object + script: + $ref: '_common.yaml#/components/schemas/Script' + time_zone: + $ref: '_common.yaml#/components/schemas/TimeZone' + MinimumInterval: + type: string + enum: + - second + - minute + - hour + - day + - month + - year + AverageAggregation: + allOf: + - $ref: '#/components/schemas/FormatMetricAggregationBase' + - type: object + FormatMetricAggregationBase: + allOf: + - $ref: '#/components/schemas/MetricAggregationBase' + - type: object + properties: + format: + type: string + MetricAggregationBase: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + missing: + $ref: '#/components/schemas/Missing' + script: + $ref: '_common.yaml#/components/schemas/Script' + Missing: + oneOf: + - type: string + - type: number + - type: number + - type: boolean + AverageBucketAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + PipelineAggregationBase: + allOf: + - $ref: '#/components/schemas/BucketPathAggregation' + - type: object + properties: + format: + description: |- + `DecimalFormat` pattern for the output value. + If specified, the formatted value is returned in the aggregation’s `value_as_string` property. + type: string + gap_policy: + $ref: '#/components/schemas/GapPolicy' + GapPolicy: + type: string + enum: + - skip + - insert_zeros + - keep_values + BucketPathAggregation: + allOf: + - $ref: '#/components/schemas/Aggregation' + - type: object + properties: + buckets_path: + $ref: '#/components/schemas/BucketsPath' + BucketsPath: + description: |- + 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. + oneOf: + - type: string + - type: array + items: + type: string + - type: object + additionalProperties: + type: string + BoxplotAggregation: + allOf: + - $ref: '#/components/schemas/MetricAggregationBase' + - type: object + properties: + compression: + description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling + control of memory usage and approximation error. + type: number + BucketScriptAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + properties: + script: + $ref: '_common.yaml#/components/schemas/Script' + BucketSelectorAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + properties: + script: + $ref: '_common.yaml#/components/schemas/Script' + BucketSortAggregation: + allOf: + - $ref: '#/components/schemas/Aggregation' + - type: object + properties: + from: + description: Buckets in positions prior to `from` will be truncated. + type: number + gap_policy: + $ref: '#/components/schemas/GapPolicy' + size: + description: |- + The number of buckets to return. + Defaults to all buckets of the parent aggregation. + type: number + sort: + $ref: '_common.yaml#/components/schemas/Sort' + BucketKsAggregation: + allOf: + - $ref: '#/components/schemas/BucketPathAggregation' + - type: object + properties: + alternative: + description: |- + A list of string values indicating which K-S test alternative to calculate. The valid values + are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used + when calculating the K-S test. Default value is all possible alternative hypotheses. + type: array + items: + type: string + fractions: + description: >- + A list of doubles indicating the distribution of the samples with which to compare to the `buckets_path` + results. + + In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual + + document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall + + documents are uniformly distributed on these buckets, which they would be if one used equal percentiles of a + + metric to define the bucket end points. + type: array + items: + type: number + sampling_method: + description: >- + Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned + values. + + This determines the cumulative distribution function (CDF) points used comparing the two samples. Default is + + `upper_tail`, which emphasizes the upper end of the CDF points. Valid options are: `upper_tail`, `uniform`, + + and `lower_tail`. + type: string + BucketCorrelationAggregation: + allOf: + - $ref: '#/components/schemas/BucketPathAggregation' + - type: object + properties: + function: + $ref: '#/components/schemas/BucketCorrelationFunction' + required: + - function + BucketCorrelationFunction: + type: object + properties: + count_correlation: + $ref: '#/components/schemas/BucketCorrelationFunctionCountCorrelation' + required: + - count_correlation + BucketCorrelationFunctionCountCorrelation: + type: object + properties: + indicator: + $ref: '#/components/schemas/BucketCorrelationFunctionCountCorrelationIndicator' + required: + - indicator + BucketCorrelationFunctionCountCorrelationIndicator: + type: object + properties: + doc_count: + description: |- + The total number of documents that initially created the expectations. It’s required to be greater + than or equal to the sum of all values in the buckets_path as this is the originating superset of data + to which the term values are correlated. + type: number + expectations: + description: |- + An array of numbers with which to correlate the configured `bucket_path` values. + The length of this value must always equal the number of buckets returned by the `bucket_path`. + type: array + items: + type: number + fractions: + description: |- + An array of fractions to use when averaging and calculating variance. This should be used if + the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided, + must equal expectations. + type: array + items: + type: number + required: + - doc_count + - expectations + CardinalityAggregation: + allOf: + - $ref: '#/components/schemas/MetricAggregationBase' + - type: object + properties: + precision_threshold: + description: |- + A unique count below which counts are expected to be close to accurate. + This allows to trade memory for accuracy. + type: number + rehash: + type: boolean + execution_hint: + $ref: '#/components/schemas/CardinalityExecutionMode' + CardinalityExecutionMode: + type: string + enum: + - global_ordinals + - segment_ordinals + - direct + - save_memory_heuristic + - save_time_heuristic + CategorizeTextAggregation: + allOf: + - $ref: '#/components/schemas/Aggregation' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + max_unique_tokens: + description: |- + The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1. + Smaller values use less memory and create fewer categories. Larger values will use more memory and + create narrower categories. Max allowed value is 100. + type: number + max_matched_tokens: + description: |- + The maximum number of token positions to match on before attempting to merge categories. Larger + values will use more memory and create narrower categories. Max allowed value is 100. + type: number + similarity_threshold: + description: >- + The minimum percentage of tokens that must match for text to be added to the category bucket. Must + + be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory + + usage and create narrower categories. + type: number + categorization_filters: + description: >- + 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. + type: array + items: + type: string + categorization_analyzer: + $ref: '#/components/schemas/CategorizeTextAnalyzer' + shard_size: + description: The number of categorization buckets to return from each shard before merging all the results. + type: number + size: + description: The number of buckets to return. + type: number + min_doc_count: + description: The minimum number of documents in a bucket to be returned to the results. + type: number + shard_min_doc_count: + description: The minimum number of documents in a bucket to be returned from the shard before merging. + type: number + required: + - field + CategorizeTextAnalyzer: + oneOf: + - type: string + - $ref: '#/components/schemas/CustomCategorizeTextAnalyzer' + CustomCategorizeTextAnalyzer: + type: object + properties: + char_filter: + type: array + items: + type: string + tokenizer: + type: string + filter: + type: array + items: + type: string + ChildrenAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + type: + $ref: '_common.yaml#/components/schemas/RelationName' + CompositeAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + after: + $ref: '#/components/schemas/CompositeAggregateKey' + size: + description: The number of composite buckets that should be returned. + type: number + sources: + description: |- + The value sources used to build composite buckets. + Keys are returned in the order of the `sources` definition. + type: array + items: + type: object + additionalProperties: + $ref: '#/components/schemas/CompositeAggregationSource' + CompositeAggregationSource: + type: object + properties: + terms: + $ref: '#/components/schemas/CompositeTermsAggregation' + histogram: + $ref: '#/components/schemas/CompositeHistogramAggregation' + date_histogram: + $ref: '#/components/schemas/CompositeDateHistogramAggregation' + geotile_grid: + $ref: '#/components/schemas/CompositeGeoTileGridAggregation' + CompositeTermsAggregation: + allOf: + - $ref: '#/components/schemas/CompositeAggregationBase' + - type: object + CompositeAggregationBase: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + missing_bucket: + type: boolean + missing_order: + $ref: '#/components/schemas/MissingOrder' + script: + $ref: '_common.yaml#/components/schemas/Script' + value_type: + $ref: '#/components/schemas/ValueType' + order: + $ref: '_common.yaml#/components/schemas/SortOrder' + MissingOrder: + type: string + enum: + - first + - last + - default + ValueType: + type: string + enum: + - string + - long + - double + - number + - date + - date_nanos + - ip + - numeric + - geo_point + - boolean + CompositeHistogramAggregation: + allOf: + - $ref: '#/components/schemas/CompositeAggregationBase' + - type: object + properties: + interval: + type: number + required: + - interval + CompositeDateHistogramAggregation: + allOf: + - $ref: '#/components/schemas/CompositeAggregationBase' + - type: object + properties: + format: + type: string + calendar_interval: + $ref: '_common.yaml#/components/schemas/DurationLarge' + fixed_interval: + $ref: '_common.yaml#/components/schemas/DurationLarge' + offset: + $ref: '_common.yaml#/components/schemas/Duration' + time_zone: + $ref: '_common.yaml#/components/schemas/TimeZone' + CompositeGeoTileGridAggregation: + allOf: + - $ref: '#/components/schemas/CompositeAggregationBase' + - type: object + properties: + precision: + type: number + bounds: + $ref: '_common.yaml#/components/schemas/GeoBounds' + CumulativeCardinalityAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + CumulativeSumAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + DateHistogramAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + calendar_interval: + $ref: '#/components/schemas/CalendarInterval' + extended_bounds: + $ref: '#/components/schemas/ExtendedBoundsFieldDateMath' + hard_bounds: + $ref: '#/components/schemas/ExtendedBoundsFieldDateMath' + field: + $ref: '_common.yaml#/components/schemas/Field' + fixed_interval: + $ref: '_common.yaml#/components/schemas/Duration' + format: + description: |- + The date format used to format `key_as_string` in the response. + If no `format` is specified, the first date format specified in the field mapping is used. + type: string + interval: + $ref: '_common.yaml#/components/schemas/Duration' + min_doc_count: + description: |- + Only returns buckets that have `min_doc_count` number of documents. + By default, all buckets between the first bucket that matches documents and the last one are returned. + type: number + missing: + $ref: '_common.yaml#/components/schemas/DateTime' + offset: + $ref: '_common.yaml#/components/schemas/Duration' + order: + $ref: '#/components/schemas/AggregateOrder' + params: + type: object + additionalProperties: + type: object + script: + $ref: '_common.yaml#/components/schemas/Script' + time_zone: + $ref: '_common.yaml#/components/schemas/TimeZone' + keyed: + description: Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than + an array. + type: boolean + CalendarInterval: + type: string + enum: + - second + - minute + - hour + - day + - week + - month + - quarter + - year + ExtendedBoundsFieldDateMath: + type: object + properties: + max: + $ref: '#/components/schemas/FieldDateMath' + min: + $ref: '#/components/schemas/FieldDateMath' + required: + - max + - min + FieldDateMath: + description: |- + A date range limit, represented either as a DateMath expression or a number expressed + according to the target field's precision. + oneOf: + - $ref: '_common.yaml#/components/schemas/DateMath' + - type: number + AggregateOrder: + oneOf: + - type: object + additionalProperties: + $ref: '_common.yaml#/components/schemas/SortOrder' + minProperties: 1 + maxProperties: 1 + - type: array + items: + type: object + additionalProperties: + $ref: '_common.yaml#/components/schemas/SortOrder' + minProperties: 1 + maxProperties: 1 + DateRangeAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + format: + description: The date format used to format `from` and `to` in the response. + type: string + missing: + $ref: '#/components/schemas/Missing' + ranges: + description: Array of date ranges. + type: array + items: + $ref: '#/components/schemas/DateRangeExpression' + time_zone: + $ref: '_common.yaml#/components/schemas/TimeZone' + keyed: + description: Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather + than an array. + type: boolean + DateRangeExpression: + type: object + properties: + from: + $ref: '#/components/schemas/FieldDateMath' + key: + description: Custom key to return the range with. + type: string + to: + $ref: '#/components/schemas/FieldDateMath' + DerivativeAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + DiversifiedSamplerAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + execution_hint: + $ref: '#/components/schemas/SamplerAggregationExecutionHint' + max_docs_per_value: + description: Limits how many documents are permitted per choice of de-duplicating value. + type: number + script: + $ref: '_common.yaml#/components/schemas/Script' + shard_size: + description: Limits how many top-scoring documents are collected in the sample processed on each shard. + type: number + field: + $ref: '_common.yaml#/components/schemas/Field' + SamplerAggregationExecutionHint: + type: string + enum: + - map + - global_ordinals + - bytes_hash + ExtendedStatsAggregation: + allOf: + - $ref: '#/components/schemas/FormatMetricAggregationBase' + - type: object + properties: + sigma: + description: The number of standard deviations above/below the mean to display. + type: number + ExtendedStatsBucketAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + properties: + sigma: + description: The number of standard deviations above/below the mean to display. + type: number + FrequentItemSetsAggregation: + type: object + properties: + fields: + description: Fields to analyze. + type: array + items: + $ref: '#/components/schemas/FrequentItemSetsField' + minimum_set_size: + description: The minimum size of one item set. + type: number + minimum_support: + description: The minimum support of one item set. + type: number + size: + description: The number of top item sets to return. + type: number + filter: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + required: + - fields + FrequentItemSetsField: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + exclude: + $ref: '#/components/schemas/TermsExclude' + include: + $ref: '#/components/schemas/TermsInclude' + required: + - field + TermsExclude: + oneOf: + - type: string + - type: array + items: + type: string + TermsInclude: + oneOf: + - type: string + - type: array + items: + type: string + - $ref: '#/components/schemas/TermsPartition' + TermsPartition: + type: object + properties: + num_partitions: + description: The number of partitions. + type: number + partition: + description: The partition number for this request. + type: number + required: + - num_partitions + - partition + FiltersAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + filters: + $ref: '#/components/schemas/BucketsQueryContainer' + other_bucket: + description: Set to `true` to add a bucket to the response which will contain all documents that do not match any of the + given filters. + type: boolean + other_bucket_key: + description: The key with which the other bucket is returned. + type: string + keyed: + description: |- + By default, the named filters aggregation returns the buckets as an object. + Set to `false` to return the buckets as an array of objects. + type: boolean + BucketsQueryContainer: + description: |- + 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. + oneOf: + - type: object + additionalProperties: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + - type: array + items: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + GeoBoundsAggregation: + allOf: + - $ref: '#/components/schemas/MetricAggregationBase' + - type: object + properties: + wrap_longitude: + description: Specifies whether the bounding box should be allowed to overlap the international date line. + type: boolean + GeoCentroidAggregation: + allOf: + - $ref: '#/components/schemas/MetricAggregationBase' + - type: object + properties: + count: + type: number + location: + $ref: '_common.yaml#/components/schemas/GeoLocation' + GeoDistanceAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + distance_type: + $ref: '_common.yaml#/components/schemas/GeoDistanceType' + field: + $ref: '_common.yaml#/components/schemas/Field' + origin: + $ref: '_common.yaml#/components/schemas/GeoLocation' + ranges: + description: An array of ranges used to bucket documents. + type: array + items: + $ref: '#/components/schemas/AggregationRange' + unit: + $ref: '_common.yaml#/components/schemas/DistanceUnit' + AggregationRange: + type: object + properties: + from: + description: Start of the range (inclusive). + oneOf: + - type: number + - type: string + - nullable: true + type: string + key: + description: Custom key to return the range with. + type: string + to: + description: End of the range (exclusive). + oneOf: + - type: number + - type: string + - nullable: true + type: string + GeoHashGridAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + bounds: + $ref: '_common.yaml#/components/schemas/GeoBounds' + field: + $ref: '_common.yaml#/components/schemas/Field' + precision: + $ref: '_common.yaml#/components/schemas/GeoHashPrecision' + shard_size: + description: |- + Allows for more accurate counting of the top cells returned in the final result the aggregation. + Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + type: number + size: + description: The maximum number of geohash buckets to return. + type: number + GeoLineAggregation: + type: object + properties: + point: + $ref: '#/components/schemas/GeoLinePoint' + sort: + $ref: '#/components/schemas/GeoLineSort' + include_sort: + description: When `true`, returns an additional array of the sort values in the feature properties. + type: boolean + sort_order: + $ref: '_common.yaml#/components/schemas/SortOrder' + size: + description: |- + The maximum length of the line represented in the aggregation. + Valid sizes are between 1 and 10000. + type: number + required: + - point + - sort + GeoLinePoint: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + GeoLineSort: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + GeoTileGridAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + precision: + $ref: '_common.yaml#/components/schemas/GeoTilePrecision' + shard_size: + description: |- + Allows for more accurate counting of the top cells returned in the final result the aggregation. + Defaults to returning `max(10,(size x number-of-shards))` buckets from each shard. + type: number + size: + description: The maximum number of buckets to return. + type: number + bounds: + $ref: '_common.yaml#/components/schemas/GeoBounds' + GeohexGridAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + precision: + description: |- + Integer zoom of the key used to defined cells or buckets + in the results. Value should be between 0-15. + type: number + bounds: + $ref: '_common.yaml#/components/schemas/GeoBounds' + size: + description: Maximum number of buckets to return. + type: number + shard_size: + description: Number of buckets returned from each shard. + type: number + required: + - field + GlobalAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + HistogramAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + extended_bounds: + $ref: '#/components/schemas/ExtendedBoundsdouble' + hard_bounds: + $ref: '#/components/schemas/ExtendedBoundsdouble' + field: + $ref: '_common.yaml#/components/schemas/Field' + interval: + description: |- + The interval for the buckets. + Must be a positive decimal. + type: number + min_doc_count: + description: |- + Only returns buckets that have `min_doc_count` number of documents. + By default, the response will fill gaps in the histogram with empty buckets. + type: number + missing: + description: |- + The value to apply to documents that do not have a value. + By default, documents without a value are ignored. + type: number + offset: + description: |- + By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`. + The bucket boundaries can be shifted by using the `offset` option. + type: number + order: + $ref: '#/components/schemas/AggregateOrder' + script: + $ref: '_common.yaml#/components/schemas/Script' + format: + type: string + keyed: + description: If `true`, returns buckets as a hash instead of an array, keyed by the bucket keys. + type: boolean + ExtendedBoundsdouble: + type: object + properties: + max: + description: Maximum value for the bound. + type: number + min: + description: Minimum value for the bound. + type: number + required: + - max + - min + IpRangeAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + ranges: + description: Array of IP ranges. + type: array + items: + $ref: '#/components/schemas/IpRangeAggregationRange' + IpRangeAggregationRange: + type: object + properties: + from: + description: Start of the range. + oneOf: + - type: string + - nullable: true + type: string + mask: + description: IP range defined as a CIDR mask. + type: string + to: + description: End of the range. + oneOf: + - type: string + - nullable: true + type: string + IpPrefixAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + prefix_length: + description: |- + Length of the network prefix. For IPv4 addresses the accepted range is [0, 32]. + For IPv6 addresses the accepted range is [0, 128]. + type: number + is_ipv6: + description: Defines whether the prefix applies to IPv6 addresses. + type: boolean + append_prefix_length: + description: Defines whether the prefix length is appended to IP address keys in the response. + type: boolean + keyed: + description: Defines whether buckets are returned as a hash rather than an array in the response. + type: boolean + min_doc_count: + description: Minimum number of documents in a bucket for it to be included in the response. + type: number + required: + - field + - prefix_length + InferenceAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + properties: + model_id: + $ref: '_common.yaml#/components/schemas/Name' + inference_config: + $ref: '#/components/schemas/InferenceConfigContainer' + required: + - model_id + InferenceConfigContainer: + type: object + properties: + regression: + $ref: '#/components/schemas/RegressionInferenceOptions' + classification: + $ref: '#/components/schemas/ClassificationInferenceOptions' + minProperties: 1 + maxProperties: 1 + RegressionInferenceOptions: + type: object + properties: + results_field: + $ref: '_common.yaml#/components/schemas/Field' + num_top_feature_importance_values: + description: Specifies the maximum number of feature importance values per document. + type: number + ClassificationInferenceOptions: + type: object + properties: + num_top_classes: + description: Specifies the number of top class predictions to return. Defaults to 0. + type: number + num_top_feature_importance_values: + description: Specifies the maximum number of feature importance values per document. + type: number + prediction_field_type: + description: 'Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When + boolean is provided 1.0 is transformed to true and 0.0 to false.' + type: string + results_field: + description: The field that is added to incoming documents to contain the inference prediction. Defaults to + predicted_value. + type: string + top_classes_results_field: + description: Specifies the field to which the top classes are written. Defaults to top_classes. + type: string + MatrixStatsAggregation: + allOf: + - $ref: '#/components/schemas/MatrixAggregation' + - type: object + properties: + mode: + $ref: '_common.yaml#/components/schemas/SortMode' + MatrixAggregation: + allOf: + - $ref: '#/components/schemas/Aggregation' + - type: object + properties: + fields: + $ref: '_common.yaml#/components/schemas/Fields' + missing: + description: |- + The value to apply to documents that do not have a value. + By default, documents without a value are ignored. + type: object + additionalProperties: + type: number + MaxAggregation: + allOf: + - $ref: '#/components/schemas/FormatMetricAggregationBase' + - type: object + MaxBucketAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + MedianAbsoluteDeviationAggregation: + allOf: + - $ref: '#/components/schemas/FormatMetricAggregationBase' + - type: object + properties: + compression: + description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling + control of memory usage and approximation error. + type: number + MinAggregation: + allOf: + - $ref: '#/components/schemas/FormatMetricAggregationBase' + - type: object + MinBucketAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + MissingAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + missing: + $ref: '#/components/schemas/Missing' + MovingAverageAggregation: + discriminator: + propertyName: model + oneOf: + - $ref: '#/components/schemas/LinearMovingAverageAggregation' + - $ref: '#/components/schemas/SimpleMovingAverageAggregation' + - $ref: '#/components/schemas/EwmaMovingAverageAggregation' + - $ref: '#/components/schemas/HoltMovingAverageAggregation' + - $ref: '#/components/schemas/HoltWintersMovingAverageAggregation' + LinearMovingAverageAggregation: + allOf: + - $ref: '#/components/schemas/MovingAverageAggregationBase' + - type: object + properties: + model: + type: string + enum: + - linear + settings: + $ref: '_common.yaml#/components/schemas/EmptyObject' + required: + - model + - settings + MovingAverageAggregationBase: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + properties: + minimize: + type: boolean + predict: + type: number + window: + type: number + SimpleMovingAverageAggregation: + allOf: + - $ref: '#/components/schemas/MovingAverageAggregationBase' + - type: object + properties: + model: + type: string + enum: + - simple + settings: + $ref: '_common.yaml#/components/schemas/EmptyObject' + required: + - model + - settings + EwmaMovingAverageAggregation: + allOf: + - $ref: '#/components/schemas/MovingAverageAggregationBase' + - type: object + properties: + model: + type: string + enum: + - ewma + settings: + $ref: '#/components/schemas/EwmaModelSettings' + required: + - model + - settings + EwmaModelSettings: + type: object + properties: + alpha: + type: number + HoltMovingAverageAggregation: + allOf: + - $ref: '#/components/schemas/MovingAverageAggregationBase' + - type: object + properties: + model: + type: string + enum: + - holt + settings: + $ref: '#/components/schemas/HoltLinearModelSettings' + required: + - model + - settings + HoltLinearModelSettings: + type: object + properties: + alpha: + type: number + beta: + type: number + HoltWintersMovingAverageAggregation: + allOf: + - $ref: '#/components/schemas/MovingAverageAggregationBase' + - type: object + properties: + model: + type: string + enum: + - holt_winters + settings: + $ref: '#/components/schemas/HoltWintersModelSettings' + required: + - model + - settings + HoltWintersModelSettings: + type: object + properties: + alpha: + type: number + beta: + type: number + gamma: + type: number + pad: + type: boolean + period: + type: number + type: + $ref: '#/components/schemas/HoltWintersType' + HoltWintersType: + type: string + enum: + - add + - mult + MovingPercentilesAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + properties: + window: + description: The size of window to "slide" across the histogram. + type: number + shift: + description: |- + By default, the window consists of the last n values excluding the current bucket. + Increasing `shift` by 1, moves the starting window position by 1 to the right. + type: number + keyed: + type: boolean + MovingFunctionAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + properties: + script: + description: The script that should be executed on each window of data. + type: string + shift: + description: |- + By default, the window consists of the last n values excluding the current bucket. + Increasing `shift` by 1, moves the starting window position by 1 to the right. + type: number + window: + description: The size of window to "slide" across the histogram. + type: number + MultiTermsAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + collect_mode: + $ref: '#/components/schemas/TermsAggregationCollectMode' + order: + $ref: '#/components/schemas/AggregateOrder' + min_doc_count: + description: The minimum number of documents in a bucket for it to be returned. + type: number + shard_min_doc_count: + description: The minimum number of documents in a bucket on each shard for it to be returned. + type: number + shard_size: + description: >- + The number of candidate terms produced by each shard. + + By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + type: number + show_term_doc_count_error: + description: Calculates the doc count error on per term basis. + type: boolean + size: + description: The number of term buckets should be returned out of the overall terms list. + type: number + terms: + description: The field from which to generate sets of terms. + type: array + items: + $ref: '#/components/schemas/MultiTermLookup' + required: + - terms + TermsAggregationCollectMode: + type: string + enum: + - depth_first + - breadth_first + MultiTermLookup: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + missing: + $ref: '#/components/schemas/Missing' + required: + - field + NestedAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + path: + $ref: '_common.yaml#/components/schemas/Field' + NormalizeAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + properties: + method: + $ref: '#/components/schemas/NormalizeMethod' + NormalizeMethod: + type: string + enum: + - rescale_0_1 + - rescale_0_100 + - percent_of_sum + - mean + - z-score + - softmax + ParentAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + type: + $ref: '_common.yaml#/components/schemas/RelationName' + PercentileRanksAggregation: + allOf: + - $ref: '#/components/schemas/FormatMetricAggregationBase' + - type: object + properties: + keyed: + description: >- + By default, the aggregation associates a unique string key with each bucket and returns the ranges as a + hash rather than an array. + + Set to `false` to disable this behavior. + type: boolean + values: + description: An array of values for which to calculate the percentile ranks. + oneOf: + - type: array + items: + type: number + - nullable: true + type: string + hdr: + $ref: '#/components/schemas/HdrMethod' + tdigest: + $ref: '#/components/schemas/TDigest' + HdrMethod: + type: object + properties: + number_of_significant_value_digits: + description: Specifies the resolution of values for the histogram in number of significant digits. + type: number + TDigest: + type: object + properties: + compression: + description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling + control of memory usage and approximation error. + type: number + PercentilesAggregation: + allOf: + - $ref: '#/components/schemas/FormatMetricAggregationBase' + - type: object + properties: + keyed: + description: >- + By default, the aggregation associates a unique string key with each bucket and returns the ranges as a + hash rather than an array. + + Set to `false` to disable this behavior. + type: boolean + percents: + description: The percentiles to calculate. + type: array + items: + type: number + hdr: + $ref: '#/components/schemas/HdrMethod' + tdigest: + $ref: '#/components/schemas/TDigest' + PercentilesBucketAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + properties: + percents: + description: The list of percentiles to calculate. + type: array + items: + type: number + RangeAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + missing: + description: |- + The value to apply to documents that do not have a value. + By default, documents without a value are ignored. + type: number + ranges: + description: An array of ranges used to bucket documents. + type: array + items: + $ref: '#/components/schemas/AggregationRange' + script: + $ref: '_common.yaml#/components/schemas/Script' + keyed: + description: Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than + an array. + type: boolean + format: + type: string + RareTermsAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + exclude: + $ref: '#/components/schemas/TermsExclude' + field: + $ref: '_common.yaml#/components/schemas/Field' + include: + $ref: '#/components/schemas/TermsInclude' + max_doc_count: + description: The maximum number of documents a term should appear in. + type: number + missing: + $ref: '#/components/schemas/Missing' + precision: + description: |- + The precision of the internal CuckooFilters. + Smaller precision leads to better approximation, but higher memory usage. + type: number + value_type: + type: string + RateAggregation: + allOf: + - $ref: '#/components/schemas/FormatMetricAggregationBase' + - type: object + properties: + unit: + $ref: '#/components/schemas/CalendarInterval' + mode: + $ref: '#/components/schemas/RateMode' + RateMode: + type: string + enum: + - sum + - value_count + ReverseNestedAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + path: + $ref: '_common.yaml#/components/schemas/Field' + SamplerAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + shard_size: + description: Limits how many top-scoring documents are collected in the sample processed on each shard. + type: number + ScriptedMetricAggregation: + allOf: + - $ref: '#/components/schemas/MetricAggregationBase' + - type: object + properties: + combine_script: + $ref: '_common.yaml#/components/schemas/Script' + init_script: + $ref: '_common.yaml#/components/schemas/Script' + map_script: + $ref: '_common.yaml#/components/schemas/Script' + params: + description: |- + A global object with script parameters for `init`, `map` and `combine` scripts. + It is shared between the scripts. + type: object + additionalProperties: + type: object + reduce_script: + $ref: '_common.yaml#/components/schemas/Script' + SerialDifferencingAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + properties: + lag: + description: |- + The historical bucket to subtract from the current value. + Must be a positive, non-zero integer. + type: number + SignificantTermsAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + background_filter: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + chi_square: + $ref: '#/components/schemas/ChiSquareHeuristic' + exclude: + $ref: '#/components/schemas/TermsExclude' + execution_hint: + $ref: '#/components/schemas/TermsAggregationExecutionHint' + field: + $ref: '_common.yaml#/components/schemas/Field' + gnd: + $ref: '#/components/schemas/GoogleNormalizedDistanceHeuristic' + include: + $ref: '#/components/schemas/TermsInclude' + jlh: + $ref: '_common.yaml#/components/schemas/EmptyObject' + min_doc_count: + description: Only return terms that are found in more than `min_doc_count` hits. + type: number + mutual_information: + $ref: '#/components/schemas/MutualInformationHeuristic' + percentage: + $ref: '#/components/schemas/PercentageScoreHeuristic' + script_heuristic: + $ref: '#/components/schemas/ScriptedHeuristic' + shard_min_doc_count: + description: >- + Regulates the certainty a shard has if the term should actually be added to the candidate list or not + with respect to the `min_doc_count`. + + Terms will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + type: number + shard_size: + description: >- + Can be used to control the volumes of candidate terms produced by each shard. + + By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + type: number + size: + description: The number of buckets returned out of the overall terms list. + type: number + ChiSquareHeuristic: + type: object + properties: + background_is_superset: + description: Set to `false` if you defined a custom background filter that represents a different set of documents that + you want to compare to. + type: boolean + include_negatives: + description: Set to `false` to filter out the terms that appear less often in the subset than in documents outside the + subset. + type: boolean + required: + - background_is_superset + - include_negatives + TermsAggregationExecutionHint: + type: string + enum: + - map + - global_ordinals + - global_ordinals_hash + - global_ordinals_low_cardinality + GoogleNormalizedDistanceHeuristic: + type: object + properties: + background_is_superset: + description: Set to `false` if you defined a custom background filter that represents a different set of documents that + you want to compare to. + type: boolean + MutualInformationHeuristic: + type: object + properties: + background_is_superset: + description: Set to `false` if you defined a custom background filter that represents a different set of documents that + you want to compare to. + type: boolean + include_negatives: + description: Set to `false` to filter out the terms that appear less often in the subset than in documents outside the + subset. + type: boolean + PercentageScoreHeuristic: + type: object + ScriptedHeuristic: + type: object + properties: + script: + $ref: '_common.yaml#/components/schemas/Script' + required: + - script + SignificantTextAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + background_filter: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + chi_square: + $ref: '#/components/schemas/ChiSquareHeuristic' + exclude: + $ref: '#/components/schemas/TermsExclude' + execution_hint: + $ref: '#/components/schemas/TermsAggregationExecutionHint' + field: + $ref: '_common.yaml#/components/schemas/Field' + filter_duplicate_text: + description: Whether to out duplicate text to deal with noisy data. + type: boolean + gnd: + $ref: '#/components/schemas/GoogleNormalizedDistanceHeuristic' + include: + $ref: '#/components/schemas/TermsInclude' + jlh: + $ref: '_common.yaml#/components/schemas/EmptyObject' + min_doc_count: + description: Only return values that are found in more than `min_doc_count` hits. + type: number + mutual_information: + $ref: '#/components/schemas/MutualInformationHeuristic' + percentage: + $ref: '#/components/schemas/PercentageScoreHeuristic' + script_heuristic: + $ref: '#/components/schemas/ScriptedHeuristic' + shard_min_doc_count: + description: >- + Regulates the certainty a shard has if the values should actually be added to the candidate list or not + with respect to the min_doc_count. + + Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`. + type: number + shard_size: + description: >- + The number of candidate terms produced by each shard. + + By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + type: number + size: + description: The number of buckets returned out of the overall terms list. + type: number + source_fields: + $ref: '_common.yaml#/components/schemas/Fields' + StatsAggregation: + allOf: + - $ref: '#/components/schemas/FormatMetricAggregationBase' + - type: object + StatsBucketAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + StringStatsAggregation: + allOf: + - $ref: '#/components/schemas/MetricAggregationBase' + - type: object + properties: + show_distribution: + description: Shows the probability distribution for all characters. + type: boolean + SumAggregation: + allOf: + - $ref: '#/components/schemas/FormatMetricAggregationBase' + - type: object + SumBucketAggregation: + allOf: + - $ref: '#/components/schemas/PipelineAggregationBase' + - type: object + TermsAggregation: + allOf: + - $ref: '#/components/schemas/BucketAggregationBase' + - type: object + properties: + collect_mode: + $ref: '#/components/schemas/TermsAggregationCollectMode' + exclude: + $ref: '#/components/schemas/TermsExclude' + execution_hint: + $ref: '#/components/schemas/TermsAggregationExecutionHint' + field: + $ref: '_common.yaml#/components/schemas/Field' + include: + $ref: '#/components/schemas/TermsInclude' + min_doc_count: + description: Only return values that are found in more than `min_doc_count` hits. + type: number + missing: + $ref: '#/components/schemas/Missing' + missing_order: + $ref: '#/components/schemas/MissingOrder' + missing_bucket: + type: boolean + value_type: + description: Coerced unmapped fields into the specified type. + type: string + order: + $ref: '#/components/schemas/AggregateOrder' + script: + $ref: '_common.yaml#/components/schemas/Script' + shard_size: + description: >- + The number of candidate terms produced by each shard. + + By default, `shard_size` will be automatically estimated based on the number of shards and the `size` parameter. + type: number + show_term_doc_count_error: + description: Set to `true` to return the `doc_count_error_upper_bound`, which is an upper bound to the error on the + `doc_count` returned by each shard. + type: boolean + size: + description: The number of buckets returned out of the overall terms list. + type: number + format: + type: string + TopHitsAggregation: + allOf: + - $ref: '#/components/schemas/MetricAggregationBase' + - type: object + properties: + docvalue_fields: + $ref: '_common.yaml#/components/schemas/Fields' + explain: + description: If `true`, returns detailed information about score computation as part of a hit. + type: boolean + from: + description: Starting document offset. + type: number + highlight: + $ref: '_core.search.yaml#/components/schemas/Highlight' + script_fields: + description: Returns the result of one or more script evaluations for each hit. + type: object + additionalProperties: + $ref: '_common.yaml#/components/schemas/ScriptField' + size: + description: The maximum number of top matching hits to return per bucket. + type: number + sort: + $ref: '_common.yaml#/components/schemas/Sort' + _source: + $ref: '_core.search.yaml#/components/schemas/SourceConfig' + stored_fields: + $ref: '_common.yaml#/components/schemas/Fields' + track_scores: + description: If `true`, calculates and returns document scores, even if the scores are not used for sorting. + type: boolean + version: + description: If `true`, returns document version as part of a hit. + type: boolean + seq_no_primary_term: + description: If `true`, returns sequence number and primary term of the last modification of each hit. + type: boolean + TTestAggregation: + allOf: + - $ref: '#/components/schemas/Aggregation' + - type: object + properties: + a: + $ref: '#/components/schemas/TestPopulation' + b: + $ref: '#/components/schemas/TestPopulation' + type: + $ref: '#/components/schemas/TTestType' + TestPopulation: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + script: + $ref: '_common.yaml#/components/schemas/Script' + filter: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + required: + - field + TTestType: + type: string + enum: + - paired + - homoscedastic + - heteroscedastic + TopMetricsAggregation: + allOf: + - $ref: '#/components/schemas/MetricAggregationBase' + - type: object + properties: + metrics: + description: The fields of the top document to return. + oneOf: + - $ref: '#/components/schemas/TopMetricsValue' + - type: array + items: + $ref: '#/components/schemas/TopMetricsValue' + size: + description: The number of top documents from which to return metrics. + type: number + sort: + $ref: '_common.yaml#/components/schemas/Sort' + TopMetricsValue: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + ValueCountAggregation: + allOf: + - $ref: '#/components/schemas/FormattableMetricAggregation' + - type: object + FormattableMetricAggregation: + allOf: + - $ref: '#/components/schemas/MetricAggregationBase' + - type: object + properties: + format: + type: string + WeightedAverageAggregation: + allOf: + - $ref: '#/components/schemas/Aggregation' + - type: object + properties: + format: + description: A numeric response formatter. + type: string + value: + $ref: '#/components/schemas/WeightedAverageValue' + value_type: + $ref: '#/components/schemas/ValueType' + weight: + $ref: '#/components/schemas/WeightedAverageValue' + WeightedAverageValue: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + missing: + description: A value or weight to use if the field is missing. + type: number + script: + $ref: '_common.yaml#/components/schemas/Script' + VariableWidthHistogramAggregation: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + buckets: + description: The target number of buckets. + type: number + shard_size: + description: |- + The number of buckets that the coordinating node will request from each shard. + Defaults to `buckets * 50`. + type: number + initial_buffer: + description: >- + Specifies the number of individual documents that will be stored in memory on a shard before the initial + bucketing algorithm is run. + + Defaults to `min(10 * shard_size, 50000)`. + type: number diff --git a/spec/schemas/_common.analysis.yaml b/spec/schemas/_common.analysis.yaml new file mode 100644 index 00000000..0f1a2246 --- /dev/null +++ b/spec/schemas/_common.analysis.yaml @@ -0,0 +1,1771 @@ +openapi: 3.1.0 +info: + title: Schemas of _common.analysis category + description: Schemas of _common.analysis category + version: 1.0.0 +paths: {} +components: + schemas: + Analyzer: + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/CustomAnalyzer' + - $ref: '#/components/schemas/FingerprintAnalyzer' + - $ref: '#/components/schemas/KeywordAnalyzer' + - $ref: '#/components/schemas/LanguageAnalyzer' + - $ref: '#/components/schemas/NoriAnalyzer' + - $ref: '#/components/schemas/PatternAnalyzer' + - $ref: '#/components/schemas/SimpleAnalyzer' + - $ref: '#/components/schemas/StandardAnalyzer' + - $ref: '#/components/schemas/StopAnalyzer' + - $ref: '#/components/schemas/WhitespaceAnalyzer' + - $ref: '#/components/schemas/IcuAnalyzer' + - $ref: '#/components/schemas/KuromojiAnalyzer' + - $ref: '#/components/schemas/SnowballAnalyzer' + - $ref: '#/components/schemas/DutchAnalyzer' + CustomAnalyzer: + type: object + properties: + type: + type: string + enum: + - custom + char_filter: + type: array + items: + type: string + filter: + type: array + items: + type: string + position_increment_gap: + type: number + position_offset_gap: + type: number + tokenizer: + type: string + required: + - type + - tokenizer + FingerprintAnalyzer: + type: object + properties: + type: + type: string + enum: + - fingerprint + version: + $ref: '_common.yaml#/components/schemas/VersionString' + max_output_size: + type: number + preserve_original: + type: boolean + separator: + type: string + stopwords: + $ref: '#/components/schemas/StopWords' + stopwords_path: + type: string + required: + - type + - max_output_size + - preserve_original + - separator + StopWords: + description: >- + Language value, such as _arabic_ or _thai_. Defaults to _english_. + + Each 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. + + Also accepts an array of stop words. + oneOf: + - type: string + - type: array + items: + type: string + KeywordAnalyzer: + type: object + properties: + type: + type: string + enum: + - keyword + version: + $ref: '_common.yaml#/components/schemas/VersionString' + required: + - type + LanguageAnalyzer: + type: object + properties: + type: + type: string + enum: + - language + version: + $ref: '_common.yaml#/components/schemas/VersionString' + language: + $ref: '#/components/schemas/Language' + stem_exclusion: + type: array + items: + type: string + stopwords: + $ref: '#/components/schemas/StopWords' + stopwords_path: + type: string + required: + - type + - language + - stem_exclusion + Language: + type: string + enum: + - 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 + NoriAnalyzer: + type: object + properties: + type: + type: string + enum: + - nori + version: + $ref: '_common.yaml#/components/schemas/VersionString' + decompound_mode: + $ref: '#/components/schemas/NoriDecompoundMode' + stoptags: + type: array + items: + type: string + user_dictionary: + type: string + required: + - type + NoriDecompoundMode: + type: string + enum: + - discard + - none + - mixed + PatternAnalyzer: + type: object + properties: + type: + type: string + enum: + - pattern + version: + $ref: '_common.yaml#/components/schemas/VersionString' + flags: + type: string + lowercase: + type: boolean + pattern: + type: string + stopwords: + $ref: '#/components/schemas/StopWords' + required: + - type + - pattern + SimpleAnalyzer: + type: object + properties: + type: + type: string + enum: + - simple + version: + $ref: '_common.yaml#/components/schemas/VersionString' + required: + - type + StandardAnalyzer: + type: object + properties: + type: + type: string + enum: + - standard + max_token_length: + type: number + stopwords: + $ref: '#/components/schemas/StopWords' + required: + - type + StopAnalyzer: + type: object + properties: + type: + type: string + enum: + - stop + version: + $ref: '_common.yaml#/components/schemas/VersionString' + stopwords: + $ref: '#/components/schemas/StopWords' + stopwords_path: + type: string + required: + - type + WhitespaceAnalyzer: + type: object + properties: + type: + type: string + enum: + - whitespace + version: + $ref: '_common.yaml#/components/schemas/VersionString' + required: + - type + IcuAnalyzer: + type: object + properties: + type: + type: string + enum: + - icu_analyzer + method: + $ref: '#/components/schemas/IcuNormalizationType' + mode: + $ref: '#/components/schemas/IcuNormalizationMode' + required: + - type + - method + - mode + IcuNormalizationType: + type: string + enum: + - nfc + - nfkc + - nfkc_cf + IcuNormalizationMode: + type: string + enum: + - decompose + - compose + KuromojiAnalyzer: + type: object + properties: + type: + type: string + enum: + - kuromoji + mode: + $ref: '#/components/schemas/KuromojiTokenizationMode' + user_dictionary: + type: string + required: + - type + - mode + KuromojiTokenizationMode: + type: string + enum: + - normal + - search + - extended + SnowballAnalyzer: + type: object + properties: + type: + type: string + enum: + - snowball + version: + $ref: '_common.yaml#/components/schemas/VersionString' + language: + $ref: '#/components/schemas/SnowballLanguage' + stopwords: + $ref: '#/components/schemas/StopWords' + required: + - type + - language + SnowballLanguage: + type: string + enum: + - Armenian + - Basque + - Catalan + - Danish + - Dutch + - English + - Finnish + - French + - German + - German2 + - Hungarian + - Italian + - Kp + - Lovins + - Norwegian + - Porter + - Portuguese + - Romanian + - Russian + - Spanish + - Swedish + - Turkish + DutchAnalyzer: + type: object + properties: + type: + type: string + enum: + - dutch + stopwords: + $ref: '#/components/schemas/StopWords' + required: + - type + CharFilter: + oneOf: + - type: string + - $ref: '#/components/schemas/CharFilterDefinition' + CharFilterDefinition: + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/HtmlStripCharFilter' + - $ref: '#/components/schemas/MappingCharFilter' + - $ref: '#/components/schemas/PatternReplaceCharFilter' + - $ref: '#/components/schemas/IcuNormalizationCharFilter' + - $ref: '#/components/schemas/KuromojiIterationMarkCharFilter' + HtmlStripCharFilter: + allOf: + - $ref: '#/components/schemas/CharFilterBase' + - type: object + properties: + type: + type: string + enum: + - html_strip + required: + - type + CharFilterBase: + type: object + properties: + version: + $ref: '_common.yaml#/components/schemas/VersionString' + MappingCharFilter: + allOf: + - $ref: '#/components/schemas/CharFilterBase' + - type: object + properties: + type: + type: string + enum: + - mapping + mappings: + type: array + items: + type: string + mappings_path: + type: string + required: + - type + PatternReplaceCharFilter: + allOf: + - $ref: '#/components/schemas/CharFilterBase' + - type: object + properties: + type: + type: string + enum: + - pattern_replace + flags: + type: string + pattern: + type: string + replacement: + type: string + required: + - type + - pattern + IcuNormalizationCharFilter: + allOf: + - $ref: '#/components/schemas/CharFilterBase' + - type: object + properties: + type: + type: string + enum: + - icu_normalizer + mode: + $ref: '#/components/schemas/IcuNormalizationMode' + name: + $ref: '#/components/schemas/IcuNormalizationType' + required: + - type + KuromojiIterationMarkCharFilter: + allOf: + - $ref: '#/components/schemas/CharFilterBase' + - type: object + properties: + type: + type: string + enum: + - kuromoji_iteration_mark + normalize_kana: + type: boolean + normalize_kanji: + type: boolean + required: + - type + - normalize_kana + - normalize_kanji + TokenFilter: + oneOf: + - type: string + - $ref: '#/components/schemas/TokenFilterDefinition' + TokenFilterDefinition: + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/AsciiFoldingTokenFilter' + - $ref: '#/components/schemas/CommonGramsTokenFilter' + - $ref: '#/components/schemas/ConditionTokenFilter' + - $ref: '#/components/schemas/DelimitedPayloadTokenFilter' + - $ref: '#/components/schemas/EdgeNGramTokenFilter' + - $ref: '#/components/schemas/ElisionTokenFilter' + - $ref: '#/components/schemas/FingerprintTokenFilter' + - $ref: '#/components/schemas/HunspellTokenFilter' + - $ref: '#/components/schemas/HyphenationDecompounderTokenFilter' + - $ref: '#/components/schemas/KeepTypesTokenFilter' + - $ref: '#/components/schemas/KeepWordsTokenFilter' + - $ref: '#/components/schemas/KeywordMarkerTokenFilter' + - $ref: '#/components/schemas/KStemTokenFilter' + - $ref: '#/components/schemas/LengthTokenFilter' + - $ref: '#/components/schemas/LimitTokenCountTokenFilter' + - $ref: '#/components/schemas/LowercaseTokenFilter' + - $ref: '#/components/schemas/MultiplexerTokenFilter' + - $ref: '#/components/schemas/NGramTokenFilter' + - $ref: '#/components/schemas/NoriPartOfSpeechTokenFilter' + - $ref: '#/components/schemas/PatternCaptureTokenFilter' + - $ref: '#/components/schemas/PatternReplaceTokenFilter' + - $ref: '#/components/schemas/PorterStemTokenFilter' + - $ref: '#/components/schemas/PredicateTokenFilter' + - $ref: '#/components/schemas/RemoveDuplicatesTokenFilter' + - $ref: '#/components/schemas/ReverseTokenFilter' + - $ref: '#/components/schemas/ShingleTokenFilter' + - $ref: '#/components/schemas/SnowballTokenFilter' + - $ref: '#/components/schemas/StemmerOverrideTokenFilter' + - $ref: '#/components/schemas/StemmerTokenFilter' + - $ref: '#/components/schemas/StopTokenFilter' + - $ref: '#/components/schemas/SynonymGraphTokenFilter' + - $ref: '#/components/schemas/SynonymTokenFilter' + - $ref: '#/components/schemas/TrimTokenFilter' + - $ref: '#/components/schemas/TruncateTokenFilter' + - $ref: '#/components/schemas/UniqueTokenFilter' + - $ref: '#/components/schemas/UppercaseTokenFilter' + - $ref: '#/components/schemas/WordDelimiterGraphTokenFilter' + - $ref: '#/components/schemas/WordDelimiterTokenFilter' + - $ref: '#/components/schemas/KuromojiStemmerTokenFilter' + - $ref: '#/components/schemas/KuromojiReadingFormTokenFilter' + - $ref: '#/components/schemas/KuromojiPartOfSpeechTokenFilter' + - $ref: '#/components/schemas/IcuTokenizer' + - $ref: '#/components/schemas/IcuCollationTokenFilter' + - $ref: '#/components/schemas/IcuFoldingTokenFilter' + - $ref: '#/components/schemas/IcuNormalizationTokenFilter' + - $ref: '#/components/schemas/IcuTransformTokenFilter' + - $ref: '#/components/schemas/PhoneticTokenFilter' + - $ref: '#/components/schemas/DictionaryDecompounderTokenFilter' + AsciiFoldingTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - asciifolding + preserve_original: + $ref: '_common.yaml#/components/schemas/Stringifiedboolean' + required: + - type + TokenFilterBase: + type: object + properties: + version: + $ref: '_common.yaml#/components/schemas/VersionString' + CommonGramsTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - common_grams + common_words: + type: array + items: + type: string + common_words_path: + type: string + ignore_case: + type: boolean + query_mode: + type: boolean + required: + - type + ConditionTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - condition + filter: + type: array + items: + type: string + script: + $ref: '_common.yaml#/components/schemas/Script' + required: + - type + - filter + - script + DelimitedPayloadTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - delimited_payload + delimiter: + type: string + encoding: + $ref: '#/components/schemas/DelimitedPayloadEncoding' + required: + - type + DelimitedPayloadEncoding: + type: string + enum: + - int + - float + - identity + EdgeNGramTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - edge_ngram + max_gram: + type: number + min_gram: + type: number + side: + $ref: '#/components/schemas/EdgeNGramSide' + preserve_original: + $ref: '_common.yaml#/components/schemas/Stringifiedboolean' + required: + - type + EdgeNGramSide: + type: string + enum: + - front + - back + ElisionTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - elision + articles: + type: array + items: + type: string + articles_path: + type: string + articles_case: + $ref: '_common.yaml#/components/schemas/Stringifiedboolean' + required: + - type + FingerprintTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - fingerprint + max_output_size: + type: number + separator: + type: string + required: + - type + HunspellTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - hunspell + dedup: + type: boolean + dictionary: + type: string + locale: + type: string + longest_only: + type: boolean + required: + - type + - locale + HyphenationDecompounderTokenFilter: + allOf: + - $ref: '#/components/schemas/CompoundWordTokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - hyphenation_decompounder + required: + - type + CompoundWordTokenFilterBase: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + hyphenation_patterns_path: + type: string + max_subword_size: + type: number + min_subword_size: + type: number + min_word_size: + type: number + only_longest_match: + type: boolean + word_list: + type: array + items: + type: string + word_list_path: + type: string + KeepTypesTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - keep_types + mode: + $ref: '#/components/schemas/KeepTypesMode' + types: + type: array + items: + type: string + required: + - type + KeepTypesMode: + type: string + enum: + - include + - exclude + KeepWordsTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - keep + keep_words: + type: array + items: + type: string + keep_words_case: + type: boolean + keep_words_path: + type: string + required: + - type + KeywordMarkerTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - keyword_marker + ignore_case: + type: boolean + keywords: + type: array + items: + type: string + keywords_path: + type: string + keywords_pattern: + type: string + required: + - type + KStemTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - kstem + required: + - type + LengthTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - length + max: + type: number + min: + type: number + required: + - type + LimitTokenCountTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - limit + consume_all_tokens: + type: boolean + max_token_count: + $ref: '_common.yaml#/components/schemas/Stringifiedinteger' + required: + - type + LowercaseTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - lowercase + language: + type: string + required: + - type + MultiplexerTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - multiplexer + filters: + type: array + items: + type: string + preserve_original: + $ref: '_common.yaml#/components/schemas/Stringifiedboolean' + required: + - type + - filters + NGramTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - ngram + max_gram: + type: number + min_gram: + type: number + preserve_original: + $ref: '_common.yaml#/components/schemas/Stringifiedboolean' + required: + - type + NoriPartOfSpeechTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - nori_part_of_speech + stoptags: + type: array + items: + type: string + required: + - type + PatternCaptureTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - pattern_capture + patterns: + type: array + items: + type: string + preserve_original: + $ref: '_common.yaml#/components/schemas/Stringifiedboolean' + required: + - type + - patterns + PatternReplaceTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - pattern_replace + all: + type: boolean + flags: + type: string + pattern: + type: string + replacement: + type: string + required: + - type + - pattern + PorterStemTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - porter_stem + required: + - type + PredicateTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - predicate_token_filter + script: + $ref: '_common.yaml#/components/schemas/Script' + required: + - type + - script + RemoveDuplicatesTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - remove_duplicates + required: + - type + ReverseTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - reverse + required: + - type + ShingleTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - shingle + filler_token: + type: string + max_shingle_size: + oneOf: + - type: number + - type: string + min_shingle_size: + oneOf: + - type: number + - type: string + output_unigrams: + type: boolean + output_unigrams_if_no_shingles: + type: boolean + token_separator: + type: string + required: + - type + SnowballTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - snowball + language: + $ref: '#/components/schemas/SnowballLanguage' + required: + - type + - language + StemmerOverrideTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - stemmer_override + rules: + type: array + items: + type: string + rules_path: + type: string + required: + - type + StemmerTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - stemmer + language: + type: string + required: + - type + StopTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - stop + ignore_case: + type: boolean + remove_trailing: + type: boolean + stopwords: + $ref: '#/components/schemas/StopWords' + stopwords_path: + type: string + required: + - type + SynonymGraphTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - synonym_graph + expand: + type: boolean + format: + $ref: '#/components/schemas/SynonymFormat' + lenient: + type: boolean + synonyms: + type: array + items: + type: string + synonyms_path: + type: string + tokenizer: + type: string + updateable: + type: boolean + required: + - type + SynonymFormat: + type: string + enum: + - solr + - wordnet + SynonymTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - synonym + expand: + type: boolean + format: + $ref: '#/components/schemas/SynonymFormat' + lenient: + type: boolean + synonyms: + type: array + items: + type: string + synonyms_path: + type: string + tokenizer: + type: string + updateable: + type: boolean + required: + - type + TrimTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - trim + required: + - type + TruncateTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - truncate + length: + type: number + required: + - type + UniqueTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - unique + only_on_same_position: + type: boolean + required: + - type + UppercaseTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - uppercase + required: + - type + WordDelimiterGraphTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - word_delimiter_graph + adjust_offsets: + type: boolean + catenate_all: + type: boolean + catenate_numbers: + type: boolean + catenate_words: + type: boolean + generate_number_parts: + type: boolean + generate_word_parts: + type: boolean + ignore_keywords: + type: boolean + preserve_original: + $ref: '_common.yaml#/components/schemas/Stringifiedboolean' + protected_words: + type: array + items: + type: string + protected_words_path: + type: string + split_on_case_change: + type: boolean + split_on_numerics: + type: boolean + stem_english_possessive: + type: boolean + type_table: + type: array + items: + type: string + type_table_path: + type: string + required: + - type + WordDelimiterTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - word_delimiter + catenate_all: + type: boolean + catenate_numbers: + type: boolean + catenate_words: + type: boolean + generate_number_parts: + type: boolean + generate_word_parts: + type: boolean + preserve_original: + $ref: '_common.yaml#/components/schemas/Stringifiedboolean' + protected_words: + type: array + items: + type: string + protected_words_path: + type: string + split_on_case_change: + type: boolean + split_on_numerics: + type: boolean + stem_english_possessive: + type: boolean + type_table: + type: array + items: + type: string + type_table_path: + type: string + required: + - type + KuromojiStemmerTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - kuromoji_stemmer + minimum_length: + type: number + required: + - type + - minimum_length + KuromojiReadingFormTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - kuromoji_readingform + use_romaji: + type: boolean + required: + - type + - use_romaji + KuromojiPartOfSpeechTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - kuromoji_part_of_speech + stoptags: + type: array + items: + type: string + required: + - type + - stoptags + IcuTokenizer: + allOf: + - $ref: '#/components/schemas/TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - icu_tokenizer + rule_files: + type: string + required: + - type + - rule_files + TokenizerBase: + type: object + properties: + version: + $ref: '_common.yaml#/components/schemas/VersionString' + IcuCollationTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - icu_collation + alternate: + $ref: '#/components/schemas/IcuCollationAlternate' + caseFirst: + $ref: '#/components/schemas/IcuCollationCaseFirst' + caseLevel: + type: boolean + country: + type: string + decomposition: + $ref: '#/components/schemas/IcuCollationDecomposition' + hiraganaQuaternaryMode: + type: boolean + language: + type: string + numeric: + type: boolean + rules: + type: string + strength: + $ref: '#/components/schemas/IcuCollationStrength' + variableTop: + type: string + variant: + type: string + required: + - type + IcuCollationAlternate: + type: string + enum: + - shifted + - non-ignorable + IcuCollationCaseFirst: + type: string + enum: + - lower + - upper + IcuCollationDecomposition: + type: string + enum: + - no + - identical + IcuCollationStrength: + type: string + enum: + - primary + - secondary + - tertiary + - quaternary + - identical + IcuFoldingTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - icu_folding + unicode_set_filter: + type: string + required: + - type + - unicode_set_filter + IcuNormalizationTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - icu_normalizer + name: + $ref: '#/components/schemas/IcuNormalizationType' + required: + - type + - name + IcuTransformTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - icu_transform + dir: + $ref: '#/components/schemas/IcuTransformDirection' + id: + type: string + required: + - type + - id + IcuTransformDirection: + type: string + enum: + - forward + - reverse + PhoneticTokenFilter: + allOf: + - $ref: '#/components/schemas/TokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - phonetic + encoder: + $ref: '#/components/schemas/PhoneticEncoder' + languageset: + type: array + items: + $ref: '#/components/schemas/PhoneticLanguage' + max_code_len: + type: number + name_type: + $ref: '#/components/schemas/PhoneticNameType' + replace: + type: boolean + rule_type: + $ref: '#/components/schemas/PhoneticRuleType' + required: + - type + - encoder + - languageset + - name_type + - rule_type + PhoneticEncoder: + type: string + enum: + - metaphone + - double_metaphone + - soundex + - refined_soundex + - caverphone1 + - caverphone2 + - cologne + - nysiis + - koelnerphonetik + - haasephonetik + - beider_morse + - daitch_mokotoff + PhoneticLanguage: + type: string + enum: + - any + - common + - cyrillic + - english + - french + - german + - hebrew + - hungarian + - polish + - romanian + - russian + - spanish + PhoneticNameType: + type: string + enum: + - generic + - ashkenazi + - sephardic + PhoneticRuleType: + type: string + enum: + - approx + - exact + DictionaryDecompounderTokenFilter: + allOf: + - $ref: '#/components/schemas/CompoundWordTokenFilterBase' + - type: object + properties: + type: + type: string + enum: + - dictionary_decompounder + required: + - type + Normalizer: + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/LowercaseNormalizer' + - $ref: '#/components/schemas/CustomNormalizer' + LowercaseNormalizer: + type: object + properties: + type: + type: string + enum: + - lowercase + required: + - type + CustomNormalizer: + type: object + properties: + type: + type: string + enum: + - custom + char_filter: + type: array + items: + type: string + filter: + type: array + items: + type: string + required: + - type + Tokenizer: + oneOf: + - type: string + - $ref: '#/components/schemas/TokenizerDefinition' + TokenizerDefinition: + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/CharGroupTokenizer' + - $ref: '#/components/schemas/EdgeNGramTokenizer' + - $ref: '#/components/schemas/KeywordTokenizer' + - $ref: '#/components/schemas/LetterTokenizer' + - $ref: '#/components/schemas/LowercaseTokenizer' + - $ref: '#/components/schemas/NGramTokenizer' + - $ref: '#/components/schemas/NoriTokenizer' + - $ref: '#/components/schemas/PathHierarchyTokenizer' + - $ref: '#/components/schemas/StandardTokenizer' + - $ref: '#/components/schemas/UaxEmailUrlTokenizer' + - $ref: '#/components/schemas/WhitespaceTokenizer' + - $ref: '#/components/schemas/KuromojiTokenizer' + - $ref: '#/components/schemas/PatternTokenizer' + - $ref: '#/components/schemas/IcuTokenizer' + CharGroupTokenizer: + allOf: + - $ref: '#/components/schemas/TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - char_group + tokenize_on_chars: + type: array + items: + type: string + max_token_length: + type: number + required: + - type + - tokenize_on_chars + EdgeNGramTokenizer: + allOf: + - $ref: '#/components/schemas/TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - edge_ngram + custom_token_chars: + type: string + max_gram: + type: number + min_gram: + type: number + token_chars: + type: array + items: + $ref: '#/components/schemas/TokenChar' + required: + - type + - max_gram + - min_gram + - token_chars + TokenChar: + type: string + enum: + - letter + - digit + - whitespace + - punctuation + - symbol + - custom + KeywordTokenizer: + allOf: + - $ref: '#/components/schemas/TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - keyword + buffer_size: + type: number + required: + - type + - buffer_size + LetterTokenizer: + allOf: + - $ref: '#/components/schemas/TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - letter + required: + - type + LowercaseTokenizer: + allOf: + - $ref: '#/components/schemas/TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - lowercase + required: + - type + NGramTokenizer: + allOf: + - $ref: '#/components/schemas/TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - ngram + custom_token_chars: + type: string + max_gram: + type: number + min_gram: + type: number + token_chars: + type: array + items: + $ref: '#/components/schemas/TokenChar' + required: + - type + - max_gram + - min_gram + - token_chars + NoriTokenizer: + allOf: + - $ref: '#/components/schemas/TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - nori_tokenizer + decompound_mode: + $ref: '#/components/schemas/NoriDecompoundMode' + discard_punctuation: + type: boolean + user_dictionary: + type: string + user_dictionary_rules: + type: array + items: + type: string + required: + - type + PathHierarchyTokenizer: + allOf: + - $ref: '#/components/schemas/TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - path_hierarchy + buffer_size: + $ref: '_common.yaml#/components/schemas/Stringifiedinteger' + delimiter: + type: string + replacement: + type: string + reverse: + $ref: '_common.yaml#/components/schemas/Stringifiedboolean' + skip: + $ref: '_common.yaml#/components/schemas/Stringifiedinteger' + required: + - type + - buffer_size + - delimiter + - reverse + - skip + StandardTokenizer: + allOf: + - $ref: '#/components/schemas/TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - standard + max_token_length: + type: number + required: + - type + UaxEmailUrlTokenizer: + allOf: + - $ref: '#/components/schemas/TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - uax_url_email + max_token_length: + type: number + required: + - type + WhitespaceTokenizer: + allOf: + - $ref: '#/components/schemas/TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - whitespace + max_token_length: + type: number + required: + - type + KuromojiTokenizer: + allOf: + - $ref: '#/components/schemas/TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - kuromoji_tokenizer + discard_punctuation: + type: boolean + mode: + $ref: '#/components/schemas/KuromojiTokenizationMode' + nbest_cost: + type: number + nbest_examples: + type: string + user_dictionary: + type: string + user_dictionary_rules: + type: array + items: + type: string + discard_compound_token: + type: boolean + required: + - type + - mode + PatternTokenizer: + allOf: + - $ref: '#/components/schemas/TokenizerBase' + - type: object + properties: + type: + type: string + enum: + - pattern + flags: + type: string + group: + type: number + pattern: + type: string + required: + - type diff --git a/spec/schemas/_common.mapping.yaml b/spec/schemas/_common.mapping.yaml new file mode 100644 index 00000000..b237dfd6 --- /dev/null +++ b/spec/schemas/_common.mapping.yaml @@ -0,0 +1,1265 @@ +openapi: 3.1.0 +info: + title: Schemas of _common.mapping category + description: Schemas of _common.mapping category + version: 1.0.0 +paths: {} +components: + schemas: + RuntimeFields: + type: object + additionalProperties: + $ref: '#/components/schemas/RuntimeField' + RuntimeField: + type: object + properties: + fetch_fields: + description: For type `lookup` + type: array + items: + $ref: '#/components/schemas/RuntimeFieldFetchFields' + format: + description: A custom format for `date` type runtime fields. + type: string + input_field: + $ref: '_common.yaml#/components/schemas/Field' + target_field: + $ref: '_common.yaml#/components/schemas/Field' + target_index: + $ref: '_common.yaml#/components/schemas/IndexName' + script: + $ref: '_common.yaml#/components/schemas/Script' + type: + $ref: '#/components/schemas/RuntimeFieldType' + required: + - type + RuntimeFieldFetchFields: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + format: + type: string + required: + - field + RuntimeFieldType: + type: string + enum: + - boolean + - date + - double + - geo_point + - ip + - keyword + - long + - lookup + TypeMapping: + type: object + properties: + all_field: + $ref: '#/components/schemas/AllField' + date_detection: + type: boolean + dynamic: + $ref: '#/components/schemas/DynamicMapping' + dynamic_date_formats: + type: array + items: + type: string + dynamic_templates: + type: array + items: + type: object + additionalProperties: + $ref: '#/components/schemas/DynamicTemplate' + _field_names: + $ref: '#/components/schemas/FieldNamesField' + index_field: + $ref: '#/components/schemas/IndexField' + _meta: + $ref: '_common.yaml#/components/schemas/Metadata' + numeric_detection: + type: boolean + properties: + type: object + additionalProperties: + $ref: '#/components/schemas/Property' + _routing: + $ref: '#/components/schemas/RoutingField' + _size: + $ref: '#/components/schemas/SizeField' + _source: + $ref: '#/components/schemas/SourceField' + runtime: + type: object + additionalProperties: + $ref: '#/components/schemas/RuntimeField' + enabled: + type: boolean + _data_stream_timestamp: + $ref: '#/components/schemas/DataStreamTimestamp' + AllField: + type: object + properties: + analyzer: + type: string + enabled: + type: boolean + omit_norms: + type: boolean + search_analyzer: + type: string + similarity: + type: string + store: + type: boolean + store_term_vector_offsets: + type: boolean + store_term_vector_payloads: + type: boolean + store_term_vector_positions: + type: boolean + store_term_vectors: + type: boolean + required: + - analyzer + - enabled + - omit_norms + - search_analyzer + - similarity + - store + - store_term_vector_offsets + - store_term_vector_payloads + - store_term_vector_positions + - store_term_vectors + DynamicMapping: + type: string + enum: + - strict + - runtime + - 'true' + - 'false' + DynamicTemplate: + type: object + properties: + mapping: + $ref: '#/components/schemas/Property' + match: + type: string + match_mapping_type: + type: string + match_pattern: + $ref: '#/components/schemas/MatchType' + path_match: + type: string + path_unmatch: + type: string + unmatch: + type: string + Property: + discriminator: + propertyName: type + oneOf: + - $ref: '#/components/schemas/BinaryProperty' + - $ref: '#/components/schemas/BooleanProperty' + - $ref: '#/components/schemas/DynamicProperty' + - $ref: '#/components/schemas/JoinProperty' + - $ref: '#/components/schemas/KeywordProperty' + - $ref: '#/components/schemas/MatchOnlyTextProperty' + - $ref: '#/components/schemas/PercolatorProperty' + - $ref: '#/components/schemas/RankFeatureProperty' + - $ref: '#/components/schemas/RankFeaturesProperty' + - $ref: '#/components/schemas/SearchAsYouTypeProperty' + - $ref: '#/components/schemas/TextProperty' + - $ref: '#/components/schemas/VersionProperty' + - $ref: '#/components/schemas/WildcardProperty' + - $ref: '#/components/schemas/DateNanosProperty' + - $ref: '#/components/schemas/DateProperty' + - $ref: '#/components/schemas/AggregateMetricDoubleProperty' + - $ref: '#/components/schemas/DenseVectorProperty' + - $ref: '#/components/schemas/SparseVectorProperty' + - $ref: '#/components/schemas/FlattenedProperty' + - $ref: '#/components/schemas/NestedProperty' + - $ref: '#/components/schemas/ObjectProperty' + - $ref: '#/components/schemas/CompletionProperty' + - $ref: '#/components/schemas/ConstantKeywordProperty' + - $ref: '#/components/schemas/FieldAliasProperty' + - $ref: '#/components/schemas/HistogramProperty' + - $ref: '#/components/schemas/IpProperty' + - $ref: '#/components/schemas/Murmur3HashProperty' + - $ref: '#/components/schemas/TokenCountProperty' + - $ref: '#/components/schemas/GeoPointProperty' + - $ref: '#/components/schemas/GeoShapeProperty' + - $ref: '#/components/schemas/PointProperty' + - $ref: '#/components/schemas/ShapeProperty' + - $ref: '#/components/schemas/ByteNumberProperty' + - $ref: '#/components/schemas/DoubleNumberProperty' + - $ref: '#/components/schemas/FloatNumberProperty' + - $ref: '#/components/schemas/HalfFloatNumberProperty' + - $ref: '#/components/schemas/IntegerNumberProperty' + - $ref: '#/components/schemas/LongNumberProperty' + - $ref: '#/components/schemas/ScaledFloatNumberProperty' + - $ref: '#/components/schemas/ShortNumberProperty' + - $ref: '#/components/schemas/UnsignedLongNumberProperty' + - $ref: '#/components/schemas/DateRangeProperty' + - $ref: '#/components/schemas/DoubleRangeProperty' + - $ref: '#/components/schemas/FloatRangeProperty' + - $ref: '#/components/schemas/IntegerRangeProperty' + - $ref: '#/components/schemas/IpRangeProperty' + - $ref: '#/components/schemas/LongRangeProperty' + BinaryProperty: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + type: + type: string + enum: + - binary + required: + - type + DocValuesPropertyBase: + allOf: + - $ref: '#/components/schemas/CorePropertyBase' + - type: object + properties: + doc_values: + type: boolean + CorePropertyBase: + allOf: + - $ref: '#/components/schemas/PropertyBase' + - type: object + properties: + copy_to: + $ref: '_common.yaml#/components/schemas/Fields' + similarity: + type: string + store: + type: boolean + PropertyBase: + type: object + properties: + meta: + description: Metadata about the field. + type: object + additionalProperties: + type: string + properties: + type: object + additionalProperties: + $ref: '#/components/schemas/Property' + ignore_above: + type: number + dynamic: + $ref: '#/components/schemas/DynamicMapping' + fields: + type: object + additionalProperties: + $ref: '#/components/schemas/Property' + BooleanProperty: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + boost: + type: number + fielddata: + $ref: 'indices._common.yaml#/components/schemas/NumericFielddata' + index: + type: boolean + null_value: + type: boolean + type: + type: string + enum: + - boolean + required: + - type + DynamicProperty: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + type: + type: string + enum: + - '{dynamic_property}' + enabled: + type: boolean + null_value: + $ref: '_common.yaml#/components/schemas/FieldValue' + boost: + type: number + coerce: + type: boolean + script: + $ref: '_common.yaml#/components/schemas/Script' + on_script_error: + $ref: '#/components/schemas/OnScriptError' + ignore_malformed: + type: boolean + time_series_metric: + $ref: '#/components/schemas/TimeSeriesMetricType' + analyzer: + type: string + eager_global_ordinals: + type: boolean + index: + type: boolean + index_options: + $ref: '#/components/schemas/IndexOptions' + index_phrases: + type: boolean + index_prefixes: + $ref: '#/components/schemas/TextIndexPrefixes' + norms: + type: boolean + position_increment_gap: + type: number + search_analyzer: + type: string + search_quote_analyzer: + type: string + term_vector: + $ref: '#/components/schemas/TermVectorOption' + format: + type: string + precision_step: + type: number + locale: + type: string + required: + - type + OnScriptError: + type: string + enum: + - fail + - continue + TimeSeriesMetricType: + type: string + enum: + - gauge + - counter + - summary + - histogram + - position + IndexOptions: + type: string + enum: + - docs + - freqs + - positions + - offsets + TextIndexPrefixes: + type: object + properties: + max_chars: + type: number + min_chars: + type: number + required: + - max_chars + - min_chars + TermVectorOption: + type: string + enum: + - no + - yes + - with_offsets + - with_positions + - with_positions_offsets + - with_positions_offsets_payloads + - with_positions_payloads + JoinProperty: + allOf: + - $ref: '#/components/schemas/PropertyBase' + - type: object + properties: + relations: + type: object + additionalProperties: + oneOf: + - $ref: '_common.yaml#/components/schemas/RelationName' + - type: array + items: + $ref: '_common.yaml#/components/schemas/RelationName' + eager_global_ordinals: + type: boolean + type: + type: string + enum: + - join + required: + - type + KeywordProperty: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + boost: + type: number + eager_global_ordinals: + type: boolean + index: + type: boolean + index_options: + $ref: '#/components/schemas/IndexOptions' + normalizer: + type: string + norms: + type: boolean + null_value: + type: string + split_queries_on_whitespace: + type: boolean + time_series_dimension: + description: For internal use by Opensearch only. Marks the field as a time series dimension. Defaults to false. + type: boolean + type: + type: string + enum: + - keyword + required: + - type + MatchOnlyTextProperty: + type: object + properties: + type: + type: string + enum: + - match_only_text + fields: + description: >- + 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. + type: object + additionalProperties: + $ref: '#/components/schemas/Property' + meta: + description: Metadata about the field. + type: object + additionalProperties: + type: string + copy_to: + $ref: '_common.yaml#/components/schemas/Fields' + required: + - type + PercolatorProperty: + allOf: + - $ref: '#/components/schemas/PropertyBase' + - type: object + properties: + type: + type: string + enum: + - percolator + required: + - type + RankFeatureProperty: + allOf: + - $ref: '#/components/schemas/PropertyBase' + - type: object + properties: + positive_score_impact: + type: boolean + type: + type: string + enum: + - rank_feature + required: + - type + RankFeaturesProperty: + allOf: + - $ref: '#/components/schemas/PropertyBase' + - type: object + properties: + type: + type: string + enum: + - rank_features + required: + - type + SearchAsYouTypeProperty: + allOf: + - $ref: '#/components/schemas/CorePropertyBase' + - type: object + properties: + analyzer: + type: string + index: + type: boolean + index_options: + $ref: '#/components/schemas/IndexOptions' + max_shingle_size: + type: number + norms: + type: boolean + search_analyzer: + type: string + search_quote_analyzer: + type: string + term_vector: + $ref: '#/components/schemas/TermVectorOption' + type: + type: string + enum: + - search_as_you_type + required: + - type + TextProperty: + allOf: + - $ref: '#/components/schemas/CorePropertyBase' + - type: object + properties: + analyzer: + type: string + boost: + type: number + eager_global_ordinals: + type: boolean + fielddata: + type: boolean + fielddata_frequency_filter: + $ref: 'indices._common.yaml#/components/schemas/FielddataFrequencyFilter' + index: + type: boolean + index_options: + $ref: '#/components/schemas/IndexOptions' + index_phrases: + type: boolean + index_prefixes: + $ref: '#/components/schemas/TextIndexPrefixes' + norms: + type: boolean + position_increment_gap: + type: number + search_analyzer: + type: string + search_quote_analyzer: + type: string + term_vector: + $ref: '#/components/schemas/TermVectorOption' + type: + type: string + enum: + - text + required: + - type + VersionProperty: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + type: + type: string + enum: + - version + required: + - type + WildcardProperty: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + type: + type: string + enum: + - wildcard + null_value: + type: string + required: + - type + DateNanosProperty: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + boost: + type: number + format: + type: string + ignore_malformed: + type: boolean + index: + type: boolean + null_value: + $ref: '_common.yaml#/components/schemas/DateTime' + precision_step: + type: number + type: + type: string + enum: + - date_nanos + required: + - type + DateProperty: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + boost: + type: number + fielddata: + $ref: 'indices._common.yaml#/components/schemas/NumericFielddata' + format: + type: string + ignore_malformed: + type: boolean + index: + type: boolean + null_value: + $ref: '_common.yaml#/components/schemas/DateTime' + precision_step: + type: number + locale: + type: string + type: + type: string + enum: + - date + required: + - type + AggregateMetricDoubleProperty: + allOf: + - $ref: '#/components/schemas/PropertyBase' + - type: object + properties: + type: + type: string + enum: + - aggregate_metric_double + default_metric: + type: string + metrics: + type: array + items: + type: string + time_series_metric: + $ref: '#/components/schemas/TimeSeriesMetricType' + required: + - type + - default_metric + - metrics + DenseVectorProperty: + allOf: + - $ref: '#/components/schemas/PropertyBase' + - type: object + properties: + type: + type: string + enum: + - dense_vector + dims: + type: number + similarity: + type: string + index: + type: boolean + index_options: + $ref: '#/components/schemas/DenseVectorIndexOptions' + required: + - type + - dims + DenseVectorIndexOptions: + type: object + properties: + type: + type: string + m: + type: number + ef_construction: + type: number + required: + - type + - m + - ef_construction + SparseVectorProperty: + allOf: + - $ref: '#/components/schemas/PropertyBase' + - type: object + properties: + type: + type: string + enum: + - sparse_vector + required: + - type + FlattenedProperty: + allOf: + - $ref: '#/components/schemas/PropertyBase' + - type: object + properties: + boost: + type: number + depth_limit: + type: number + doc_values: + type: boolean + eager_global_ordinals: + type: boolean + index: + type: boolean + index_options: + $ref: '#/components/schemas/IndexOptions' + null_value: + type: string + similarity: + type: string + split_queries_on_whitespace: + type: boolean + type: + type: string + enum: + - flattened + required: + - type + NestedProperty: + allOf: + - $ref: '#/components/schemas/CorePropertyBase' + - type: object + properties: + enabled: + type: boolean + include_in_parent: + type: boolean + include_in_root: + type: boolean + type: + type: string + enum: + - nested + required: + - type + ObjectProperty: + allOf: + - $ref: '#/components/schemas/CorePropertyBase' + - type: object + properties: + enabled: + type: boolean + type: + type: string + enum: + - object + CompletionProperty: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + analyzer: + type: string + contexts: + type: array + items: + $ref: '#/components/schemas/SuggestContext' + max_input_length: + type: number + preserve_position_increments: + type: boolean + preserve_separators: + type: boolean + search_analyzer: + type: string + type: + type: string + enum: + - completion + required: + - type + SuggestContext: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + path: + $ref: '_common.yaml#/components/schemas/Field' + type: + type: string + precision: + oneOf: + - type: number + - type: string + required: + - name + - type + ConstantKeywordProperty: + allOf: + - $ref: '#/components/schemas/PropertyBase' + - type: object + properties: + value: + type: object + type: + type: string + enum: + - constant_keyword + required: + - type + FieldAliasProperty: + allOf: + - $ref: '#/components/schemas/PropertyBase' + - type: object + properties: + path: + $ref: '_common.yaml#/components/schemas/Field' + type: + type: string + enum: + - alias + required: + - type + HistogramProperty: + allOf: + - $ref: '#/components/schemas/PropertyBase' + - type: object + properties: + ignore_malformed: + type: boolean + type: + type: string + enum: + - histogram + required: + - type + IpProperty: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + boost: + type: number + index: + type: boolean + ignore_malformed: + type: boolean + null_value: + type: string + on_script_error: + $ref: '#/components/schemas/OnScriptError' + script: + $ref: '_common.yaml#/components/schemas/Script' + time_series_dimension: + description: For internal use by Opensearch only. Marks the field as a time series dimension. Defaults to false. + type: boolean + type: + type: string + enum: + - ip + required: + - type + Murmur3HashProperty: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + type: + type: string + enum: + - murmur3 + required: + - type + TokenCountProperty: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + analyzer: + type: string + boost: + type: number + index: + type: boolean + null_value: + type: number + enable_position_increments: + type: boolean + type: + type: string + enum: + - token_count + required: + - type + GeoPointProperty: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + ignore_malformed: + type: boolean + ignore_z_value: + type: boolean + null_value: + $ref: '_common.yaml#/components/schemas/GeoLocation' + type: + type: string + enum: + - geo_point + required: + - type + GeoShapeProperty: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + coerce: + type: boolean + ignore_malformed: + type: boolean + ignore_z_value: + type: boolean + orientation: + $ref: '#/components/schemas/GeoOrientation' + strategy: + $ref: '#/components/schemas/GeoStrategy' + type: + type: string + enum: + - geo_shape + required: + - type + GeoOrientation: + type: string + enum: + - right + - left + GeoStrategy: + type: string + enum: + - recursive + - term + PointProperty: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + ignore_malformed: + type: boolean + ignore_z_value: + type: boolean + null_value: + type: string + type: + type: string + enum: + - point + required: + - type + ShapeProperty: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + coerce: + type: boolean + ignore_malformed: + type: boolean + ignore_z_value: + type: boolean + orientation: + $ref: '#/components/schemas/GeoOrientation' + type: + type: string + enum: + - shape + required: + - type + ByteNumberProperty: + allOf: + - $ref: '#/components/schemas/NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - byte + null_value: + $ref: '_common.yaml#/components/schemas/byte' + required: + - type + NumberPropertyBase: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + boost: + type: number + coerce: + type: boolean + ignore_malformed: + type: boolean + index: + type: boolean + on_script_error: + $ref: '#/components/schemas/OnScriptError' + script: + $ref: '_common.yaml#/components/schemas/Script' + time_series_metric: + $ref: '#/components/schemas/TimeSeriesMetricType' + time_series_dimension: + description: For internal use by Opensearch only. Marks the field as a time series dimension. Defaults to false. + type: boolean + DoubleNumberProperty: + allOf: + - $ref: '#/components/schemas/NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - double + null_value: + type: number + required: + - type + FloatNumberProperty: + allOf: + - $ref: '#/components/schemas/NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - float + null_value: + type: number + required: + - type + HalfFloatNumberProperty: + allOf: + - $ref: '#/components/schemas/NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - half_float + null_value: + type: number + required: + - type + IntegerNumberProperty: + allOf: + - $ref: '#/components/schemas/NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - integer + null_value: + type: number + required: + - type + LongNumberProperty: + allOf: + - $ref: '#/components/schemas/NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - long + null_value: + type: number + required: + - type + ScaledFloatNumberProperty: + allOf: + - $ref: '#/components/schemas/NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - scaled_float + null_value: + type: number + scaling_factor: + type: number + required: + - type + ShortNumberProperty: + allOf: + - $ref: '#/components/schemas/NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - short + null_value: + $ref: '_common.yaml#/components/schemas/short' + required: + - type + UnsignedLongNumberProperty: + allOf: + - $ref: '#/components/schemas/NumberPropertyBase' + - type: object + properties: + type: + type: string + enum: + - unsigned_long + null_value: + $ref: '_common.yaml#/components/schemas/ulong' + required: + - type + DateRangeProperty: + allOf: + - $ref: '#/components/schemas/RangePropertyBase' + - type: object + properties: + format: + type: string + type: + type: string + enum: + - date_range + required: + - type + RangePropertyBase: + allOf: + - $ref: '#/components/schemas/DocValuesPropertyBase' + - type: object + properties: + boost: + type: number + coerce: + type: boolean + index: + type: boolean + DoubleRangeProperty: + allOf: + - $ref: '#/components/schemas/RangePropertyBase' + - type: object + properties: + type: + type: string + enum: + - double_range + required: + - type + FloatRangeProperty: + allOf: + - $ref: '#/components/schemas/RangePropertyBase' + - type: object + properties: + type: + type: string + enum: + - float_range + required: + - type + IntegerRangeProperty: + allOf: + - $ref: '#/components/schemas/RangePropertyBase' + - type: object + properties: + type: + type: string + enum: + - integer_range + required: + - type + IpRangeProperty: + allOf: + - $ref: '#/components/schemas/RangePropertyBase' + - type: object + properties: + type: + type: string + enum: + - ip_range + required: + - type + LongRangeProperty: + allOf: + - $ref: '#/components/schemas/RangePropertyBase' + - type: object + properties: + type: + type: string + enum: + - long_range + required: + - type + MatchType: + type: string + enum: + - simple + - regex + FieldNamesField: + type: object + properties: + enabled: + type: boolean + required: + - enabled + IndexField: + type: object + properties: + enabled: + type: boolean + required: + - enabled + RoutingField: + type: object + properties: + required: + type: boolean + required: + - required + SizeField: + type: object + properties: + enabled: + type: boolean + required: + - enabled + SourceField: + type: object + properties: + compress: + type: boolean + compress_threshold: + type: string + enabled: + type: boolean + excludes: + type: array + items: + type: string + includes: + type: array + items: + type: string + mode: + $ref: '#/components/schemas/SourceFieldMode' + SourceFieldMode: + type: string + enum: + - disabled + - stored + - synthetic + DataStreamTimestamp: + type: object + properties: + enabled: + type: boolean + required: + - enabled + FieldMapping: + type: object + properties: + full_name: + type: string + mapping: + type: object + additionalProperties: + $ref: '#/components/schemas/Property' + minProperties: 1 + maxProperties: 1 + required: + - full_name + - mapping diff --git a/spec/schemas/_common.query_dsl.yaml b/spec/schemas/_common.query_dsl.yaml new file mode 100644 index 00000000..8d4d8c4e --- /dev/null +++ b/spec/schemas/_common.query_dsl.yaml @@ -0,0 +1,1945 @@ +openapi: 3.1.0 +info: + title: Schemas of _common.query_dsl category + description: Schemas of _common.query_dsl category + version: 1.0.0 +paths: {} +components: + schemas: + Operator: + type: string + enum: + - and + - or + QueryContainer: + type: object + properties: + bool: + $ref: '#/components/schemas/BoolQuery' + boosting: + $ref: '#/components/schemas/BoostingQuery' + common: + deprecated: true + type: object + additionalProperties: + $ref: '#/components/schemas/CommonTermsQuery' + minProperties: 1 + maxProperties: 1 + combined_fields: + $ref: '#/components/schemas/CombinedFieldsQuery' + constant_score: + $ref: '#/components/schemas/ConstantScoreQuery' + dis_max: + $ref: '#/components/schemas/DisMaxQuery' + distance_feature: + $ref: '#/components/schemas/DistanceFeatureQuery' + exists: + $ref: '#/components/schemas/ExistsQuery' + function_score: + $ref: '#/components/schemas/FunctionScoreQuery' + fuzzy: + description: Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance. + type: object + additionalProperties: + $ref: '#/components/schemas/FuzzyQuery' + minProperties: 1 + maxProperties: 1 + geo_bounding_box: + $ref: '#/components/schemas/GeoBoundingBoxQuery' + geo_distance: + $ref: '#/components/schemas/GeoDistanceQuery' + geo_polygon: + $ref: '#/components/schemas/GeoPolygonQuery' + geo_shape: + $ref: '#/components/schemas/GeoShapeQuery' + has_child: + $ref: '#/components/schemas/HasChildQuery' + has_parent: + $ref: '#/components/schemas/HasParentQuery' + ids: + $ref: '#/components/schemas/IdsQuery' + intervals: + description: Returns documents based on the order and proximity of matching terms. + type: object + additionalProperties: + $ref: '#/components/schemas/IntervalsQuery' + minProperties: 1 + maxProperties: 1 + match: + description: |- + Returns documents that match a provided text, number, date or boolean value. + The provided text is analyzed before matching. + type: object + additionalProperties: + $ref: '#/components/schemas/MatchQuery' + minProperties: 1 + maxProperties: 1 + match_all: + $ref: '#/components/schemas/MatchAllQuery' + match_bool_prefix: + description: |- + Analyzes its input and constructs a `bool` query from the terms. + Each term except the last is used in a `term` query. + The last term is used in a prefix query. + type: object + additionalProperties: + $ref: '#/components/schemas/MatchBoolPrefixQuery' + minProperties: 1 + maxProperties: 1 + match_none: + $ref: '#/components/schemas/MatchNoneQuery' + match_phrase: + description: Analyzes the text and creates a phrase query out of the analyzed text. + type: object + additionalProperties: + $ref: '#/components/schemas/MatchPhraseQuery' + minProperties: 1 + maxProperties: 1 + match_phrase_prefix: + description: |- + Returns documents that contain the words of a provided text, in the same order as provided. + The last term of the provided text is treated as a prefix, matching any words that begin with that term. + type: object + additionalProperties: + $ref: '#/components/schemas/MatchPhrasePrefixQuery' + minProperties: 1 + maxProperties: 1 + more_like_this: + $ref: '#/components/schemas/MoreLikeThisQuery' + multi_match: + $ref: '#/components/schemas/MultiMatchQuery' + nested: + $ref: '#/components/schemas/NestedQuery' + parent_id: + $ref: '#/components/schemas/ParentIdQuery' + percolate: + $ref: '#/components/schemas/PercolateQuery' + pinned: + $ref: '#/components/schemas/PinnedQuery' + prefix: + description: Returns documents that contain a specific prefix in a provided field. + type: object + additionalProperties: + $ref: '#/components/schemas/PrefixQuery' + minProperties: 1 + maxProperties: 1 + query_string: + $ref: '#/components/schemas/QueryStringQuery' + range: + description: Returns documents that contain terms within a provided range. + type: object + additionalProperties: + $ref: '#/components/schemas/RangeQuery' + minProperties: 1 + maxProperties: 1 + rank_feature: + $ref: '#/components/schemas/RankFeatureQuery' + regexp: + description: Returns documents that contain terms matching a regular expression. + type: object + additionalProperties: + $ref: '#/components/schemas/RegexpQuery' + minProperties: 1 + maxProperties: 1 + rule_query: + $ref: '#/components/schemas/RuleQuery' + script: + $ref: '#/components/schemas/ScriptQuery' + script_score: + $ref: '#/components/schemas/ScriptScoreQuery' + shape: + $ref: '#/components/schemas/ShapeQuery' + simple_query_string: + $ref: '#/components/schemas/SimpleQueryStringQuery' + span_containing: + $ref: '#/components/schemas/SpanContainingQuery' + field_masking_span: + $ref: '#/components/schemas/SpanFieldMaskingQuery' + span_first: + $ref: '#/components/schemas/SpanFirstQuery' + span_multi: + $ref: '#/components/schemas/SpanMultiTermQuery' + span_near: + $ref: '#/components/schemas/SpanNearQuery' + span_not: + $ref: '#/components/schemas/SpanNotQuery' + span_or: + $ref: '#/components/schemas/SpanOrQuery' + span_term: + description: Matches spans containing a term. + type: object + additionalProperties: + $ref: '#/components/schemas/SpanTermQuery' + minProperties: 1 + maxProperties: 1 + span_within: + $ref: '#/components/schemas/SpanWithinQuery' + term: + description: >- + Returns documents that contain an exact term in a provided field. + + To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization. + type: object + additionalProperties: + $ref: '#/components/schemas/TermQuery' + minProperties: 1 + maxProperties: 1 + terms: + $ref: '#/components/schemas/TermsQuery' + terms_set: + description: >- + Returns documents that contain a minimum number of exact terms in a provided field. + + To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization. + type: object + additionalProperties: + $ref: '#/components/schemas/TermsSetQuery' + minProperties: 1 + maxProperties: 1 + text_expansion: + description: Uses a natural language processing model to convert the query text into a list of token-weight pairs which + are then used in a query against a sparse vector or rank features field. + type: object + additionalProperties: + $ref: '#/components/schemas/TextExpansionQuery' + minProperties: 1 + maxProperties: 1 + weighted_tokens: + description: Supports returning text_expansion query results by sending in precomputed tokens with the query. + type: object + additionalProperties: + $ref: '#/components/schemas/WeightedTokensQuery' + minProperties: 1 + maxProperties: 1 + wildcard: + description: Returns documents that contain terms matching a wildcard pattern. + type: object + additionalProperties: + $ref: '#/components/schemas/WildcardQuery' + minProperties: 1 + maxProperties: 1 + wrapper: + $ref: '#/components/schemas/WrapperQuery' + type: + $ref: '#/components/schemas/TypeQuery' + minProperties: 1 + maxProperties: 1 + BoolQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + filter: + description: |- + The clause (query) must appear in matching documents. + However, unlike `must`, the score of the query will be ignored. + oneOf: + - $ref: '#/components/schemas/QueryContainer' + - type: array + items: + $ref: '#/components/schemas/QueryContainer' + minimum_should_match: + $ref: '_common.yaml#/components/schemas/MinimumShouldMatch' + must: + description: The clause (query) must appear in matching documents and will contribute to the score. + oneOf: + - $ref: '#/components/schemas/QueryContainer' + - type: array + items: + $ref: '#/components/schemas/QueryContainer' + must_not: + description: |- + The clause (query) must not appear in the matching documents. + Because scoring is ignored, a score of `0` is returned for all documents. + oneOf: + - $ref: '#/components/schemas/QueryContainer' + - type: array + items: + $ref: '#/components/schemas/QueryContainer' + should: + description: The clause (query) should appear in the matching document. + oneOf: + - $ref: '#/components/schemas/QueryContainer' + - type: array + items: + $ref: '#/components/schemas/QueryContainer' + QueryBase: + type: object + properties: + boost: + description: |- + Floating point number used to decrease or increase the relevance scores of the query. + Boost values are relative to the default value of 1.0. + A boost value between 0 and 1.0 decreases the relevance score. + A value greater than 1.0 increases the relevance score. + type: number + _name: + type: string + BoostingQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + negative_boost: + description: Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the + `negative` query. + type: number + negative: + $ref: '#/components/schemas/QueryContainer' + positive: + $ref: '#/components/schemas/QueryContainer' + required: + - negative_boost + - negative + - positive + CommonTermsQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + analyzer: + type: string + cutoff_frequency: + type: number + high_freq_operator: + $ref: '#/components/schemas/Operator' + low_freq_operator: + $ref: '#/components/schemas/Operator' + minimum_should_match: + $ref: '_common.yaml#/components/schemas/MinimumShouldMatch' + query: + type: string + required: + - query + CombinedFieldsQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + fields: + description: List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they + must all have the same search `analyzer`. + type: array + items: + $ref: '_common.yaml#/components/schemas/Field' + query: + description: |- + Text to search for in the provided `fields`. + The `combined_fields` query analyzes the provided text before performing a search. + type: string + auto_generate_synonyms_phrase_query: + description: If true, match phrase queries are automatically created for multi-term synonyms. + type: boolean + operator: + $ref: '#/components/schemas/CombinedFieldsOperator' + minimum_should_match: + $ref: '_common.yaml#/components/schemas/MinimumShouldMatch' + zero_terms_query: + $ref: '#/components/schemas/CombinedFieldsZeroTerms' + required: + - fields + - query + CombinedFieldsOperator: + type: string + enum: + - or + - and + CombinedFieldsZeroTerms: + type: string + enum: + - none + - all + ConstantScoreQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + filter: + $ref: '#/components/schemas/QueryContainer' + required: + - filter + DisMaxQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + queries: + description: |- + One or more query clauses. + Returned documents must match one or more of these queries. + If a document matches multiple queries, Opensearch uses the highest relevance score. + type: array + items: + $ref: '#/components/schemas/QueryContainer' + tie_breaker: + description: Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching + multiple query clauses. + type: number + required: + - queries + DistanceFeatureQuery: + oneOf: + - $ref: '#/components/schemas/GeoDistanceFeatureQuery' + - $ref: '#/components/schemas/DateDistanceFeatureQuery' + GeoDistanceFeatureQuery: + allOf: + - $ref: '#/components/schemas/DistanceFeatureQueryBaseGeoLocationDistance' + - type: object + DistanceFeatureQueryBaseGeoLocationDistance: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + origin: + $ref: '_common.yaml#/components/schemas/GeoLocation' + pivot: + $ref: '_common.yaml#/components/schemas/Distance' + field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - origin + - pivot + - field + DateDistanceFeatureQuery: + allOf: + - $ref: '#/components/schemas/DistanceFeatureQueryBaseDateMathDuration' + - type: object + DistanceFeatureQueryBaseDateMathDuration: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + origin: + $ref: '_common.yaml#/components/schemas/DateMath' + pivot: + $ref: '_common.yaml#/components/schemas/Duration' + field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - origin + - pivot + - field + ExistsQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + FunctionScoreQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + boost_mode: + $ref: '#/components/schemas/FunctionBoostMode' + functions: + description: One or more functions that compute a new score for each document returned by the query. + type: array + items: + $ref: '#/components/schemas/FunctionScoreContainer' + max_boost: + description: Restricts the new score to not exceed the provided limit. + type: number + min_score: + description: Excludes documents that do not meet the provided score threshold. + type: number + query: + $ref: '#/components/schemas/QueryContainer' + score_mode: + $ref: '#/components/schemas/FunctionScoreMode' + FunctionBoostMode: + type: string + enum: + - multiply + - replace + - sum + - avg + - max + - min + FunctionScoreContainer: + allOf: + - type: object + properties: + filter: + $ref: '#/components/schemas/QueryContainer' + weight: + type: number + - type: object + properties: + exp: + $ref: '#/components/schemas/DecayFunction' + gauss: + $ref: '#/components/schemas/DecayFunction' + linear: + $ref: '#/components/schemas/DecayFunction' + field_value_factor: + $ref: '#/components/schemas/FieldValueFactorScoreFunction' + random_score: + $ref: '#/components/schemas/RandomScoreFunction' + script_score: + $ref: '#/components/schemas/ScriptScoreFunction' + minProperties: 1 + maxProperties: 1 + DecayFunction: + oneOf: + - $ref: '#/components/schemas/DateDecayFunction' + - $ref: '#/components/schemas/NumericDecayFunction' + - $ref: '#/components/schemas/GeoDecayFunction' + DateDecayFunction: + allOf: + - $ref: '#/components/schemas/DecayFunctionBase' + - type: object + DecayFunctionBase: + type: object + properties: + multi_value_mode: + $ref: '#/components/schemas/MultiValueMode' + MultiValueMode: + type: string + enum: + - min + - max + - avg + - sum + NumericDecayFunction: + allOf: + - $ref: '#/components/schemas/DecayFunctionBase' + - type: object + GeoDecayFunction: + allOf: + - $ref: '#/components/schemas/DecayFunctionBase' + - type: object + FieldValueFactorScoreFunction: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + factor: + description: Optional factor to multiply the field value with. + type: number + missing: + description: |- + Value used if the document doesn’t have that field. + The modifier and factor are still applied to it as though it were read from the document. + type: number + modifier: + $ref: '#/components/schemas/FieldValueFactorModifier' + required: + - field + FieldValueFactorModifier: + type: string + enum: + - none + - log + - log1p + - log2p + - ln + - ln1p + - ln2p + - square + - sqrt + - reciprocal + RandomScoreFunction: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + seed: + oneOf: + - type: number + - type: string + ScriptScoreFunction: + type: object + properties: + script: + $ref: '_common.yaml#/components/schemas/Script' + required: + - script + FunctionScoreMode: + type: string + enum: + - multiply + - sum + - avg + - first + - max + - min + FuzzyQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + max_expansions: + description: Maximum number of variations created. + type: number + prefix_length: + description: Number of beginning characters left unchanged when creating expansions. + type: number + rewrite: + $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' + transpositions: + description: Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`). + type: boolean + fuzziness: + $ref: '_common.yaml#/components/schemas/Fuzziness' + value: + description: Term you wish to find in the provided field. + oneOf: + - type: string + - type: number + - type: boolean + required: + - value + GeoBoundingBoxQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + type: + $ref: '#/components/schemas/GeoExecution' + validation_method: + $ref: '#/components/schemas/GeoValidationMethod' + ignore_unmapped: + description: |- + 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. + type: boolean + GeoExecution: + type: string + enum: + - memory + - indexed + GeoValidationMethod: + type: string + enum: + - coerce + - ignore_malformed + - strict + GeoDistanceQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + distance: + $ref: '_common.yaml#/components/schemas/Distance' + distance_type: + $ref: '_common.yaml#/components/schemas/GeoDistanceType' + validation_method: + $ref: '#/components/schemas/GeoValidationMethod' + required: + - distance + GeoPolygonQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + validation_method: + $ref: '#/components/schemas/GeoValidationMethod' + ignore_unmapped: + type: boolean + GeoShapeQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + ignore_unmapped: + description: |- + 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. + type: boolean + HasChildQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + ignore_unmapped: + description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + type: boolean + inner_hits: + $ref: '_core.search.yaml#/components/schemas/InnerHits' + max_children: + description: |- + Maximum number of child documents that match the query allowed for a returned parent document. + If the parent document exceeds this limit, it is excluded from the search results. + type: number + min_children: + description: >- + Minimum number of child documents that match the query required to match the query for a returned parent + document. + + If the parent document does not meet this limit, it is excluded from the search results. + type: number + query: + $ref: '#/components/schemas/QueryContainer' + score_mode: + $ref: '#/components/schemas/ChildScoreMode' + type: + $ref: '_common.yaml#/components/schemas/RelationName' + required: + - query + - type + FieldAndFormat: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + format: + description: Format in which the values are returned. + type: string + include_unmapped: + type: boolean + required: + - field + ChildScoreMode: + type: string + enum: + - none + - avg + - sum + - max + - min + HasParentQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + ignore_unmapped: + description: |- + Indicates whether to ignore an unmapped `parent_type` and not return any documents instead of an error. + You can use this parameter to query multiple indices that may not contain the `parent_type`. + type: boolean + inner_hits: + $ref: '_core.search.yaml#/components/schemas/InnerHits' + parent_type: + $ref: '_common.yaml#/components/schemas/RelationName' + query: + $ref: '#/components/schemas/QueryContainer' + score: + description: Indicates whether the relevance score of a matching parent document is aggregated into its child documents. + type: boolean + required: + - parent_type + - query + IdsQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + values: + $ref: '_common.yaml#/components/schemas/Ids' + IntervalsQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + all_of: + $ref: '#/components/schemas/IntervalsAllOf' + any_of: + $ref: '#/components/schemas/IntervalsAnyOf' + fuzzy: + $ref: '#/components/schemas/IntervalsFuzzy' + match: + $ref: '#/components/schemas/IntervalsMatch' + prefix: + $ref: '#/components/schemas/IntervalsPrefix' + wildcard: + $ref: '#/components/schemas/IntervalsWildcard' + minProperties: 1 + maxProperties: 1 + IntervalsAllOf: + type: object + properties: + intervals: + description: An array of rules to combine. All rules must produce a match in a document for the overall source to match. + type: array + items: + $ref: '#/components/schemas/IntervalsContainer' + max_gaps: + description: |- + Maximum number of positions between the matching terms. + Intervals produced by the rules further apart than this are not considered matches. + type: number + ordered: + description: If `true`, intervals produced by the rules should appear in the order in which they are specified. + type: boolean + filter: + $ref: '#/components/schemas/IntervalsFilter' + required: + - intervals + IntervalsContainer: + type: object + properties: + all_of: + $ref: '#/components/schemas/IntervalsAllOf' + any_of: + $ref: '#/components/schemas/IntervalsAnyOf' + fuzzy: + $ref: '#/components/schemas/IntervalsFuzzy' + match: + $ref: '#/components/schemas/IntervalsMatch' + prefix: + $ref: '#/components/schemas/IntervalsPrefix' + wildcard: + $ref: '#/components/schemas/IntervalsWildcard' + minProperties: 1 + maxProperties: 1 + IntervalsAnyOf: + type: object + properties: + intervals: + description: An array of rules to match. + type: array + items: + $ref: '#/components/schemas/IntervalsContainer' + filter: + $ref: '#/components/schemas/IntervalsFilter' + required: + - intervals + IntervalsFilter: + type: object + properties: + after: + $ref: '#/components/schemas/IntervalsContainer' + before: + $ref: '#/components/schemas/IntervalsContainer' + contained_by: + $ref: '#/components/schemas/IntervalsContainer' + containing: + $ref: '#/components/schemas/IntervalsContainer' + not_contained_by: + $ref: '#/components/schemas/IntervalsContainer' + not_containing: + $ref: '#/components/schemas/IntervalsContainer' + not_overlapping: + $ref: '#/components/schemas/IntervalsContainer' + overlapping: + $ref: '#/components/schemas/IntervalsContainer' + script: + $ref: '_common.yaml#/components/schemas/Script' + minProperties: 1 + maxProperties: 1 + IntervalsFuzzy: + type: object + properties: + analyzer: + description: Analyzer used to normalize the term. + type: string + fuzziness: + $ref: '_common.yaml#/components/schemas/Fuzziness' + prefix_length: + description: Number of beginning characters left unchanged when creating expansions. + type: number + term: + description: The term to match. + type: string + transpositions: + description: Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`). + type: boolean + use_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - term + IntervalsMatch: + type: object + properties: + analyzer: + description: Analyzer used to analyze terms in the query. + type: string + max_gaps: + description: |- + Maximum number of positions between the matching terms. + Terms further apart than this are not considered matches. + type: number + ordered: + description: If `true`, matching terms must appear in their specified order. + type: boolean + query: + description: Text you wish to find in the provided field. + type: string + use_field: + $ref: '_common.yaml#/components/schemas/Field' + filter: + $ref: '#/components/schemas/IntervalsFilter' + required: + - query + IntervalsPrefix: + type: object + properties: + analyzer: + description: Analyzer used to analyze the `prefix`. + type: string + prefix: + description: Beginning characters of terms you wish to find in the top-level field. + type: string + use_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - prefix + IntervalsWildcard: + type: object + properties: + analyzer: + description: |- + Analyzer used to analyze the `pattern`. + Defaults to the top-level field's analyzer. + type: string + pattern: + description: Wildcard pattern used to find matching terms. + type: string + use_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - pattern + MatchQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert the text in the query value into tokens. + type: string + auto_generate_synonyms_phrase_query: + description: If `true`, match phrase queries are automatically created for multi-term synonyms. + type: boolean + cutoff_frequency: + deprecated: true + type: number + fuzziness: + $ref: '_common.yaml#/components/schemas/Fuzziness' + fuzzy_rewrite: + $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' + fuzzy_transpositions: + description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to + `ba`). + type: boolean + lenient: + description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + type: boolean + max_expansions: + description: Maximum number of terms to which the query will expand. + type: number + minimum_should_match: + $ref: '_common.yaml#/components/schemas/MinimumShouldMatch' + operator: + $ref: '#/components/schemas/Operator' + prefix_length: + description: Number of beginning characters left unchanged for fuzzy matching. + type: number + query: + description: Text, number, boolean value or date you wish to find in the provided field. + oneOf: + - type: string + - type: number + - type: boolean + zero_terms_query: + $ref: '#/components/schemas/ZeroTermsQuery' + required: + - query + ZeroTermsQuery: + type: string + enum: + - all + - none + MatchAllQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + MatchBoolPrefixQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert the text in the query value into tokens. + type: string + fuzziness: + $ref: '_common.yaml#/components/schemas/Fuzziness' + fuzzy_rewrite: + $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' + fuzzy_transpositions: + description: >- + If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` + to `ba`). + + Can be applied to the term subqueries constructed for all terms but the final term. + type: boolean + max_expansions: + description: |- + Maximum number of terms to which the query will expand. + Can be applied to the term subqueries constructed for all terms but the final term. + type: number + minimum_should_match: + $ref: '_common.yaml#/components/schemas/MinimumShouldMatch' + operator: + $ref: '#/components/schemas/Operator' + prefix_length: + description: |- + Number of beginning characters left unchanged for fuzzy matching. + Can be applied to the term subqueries constructed for all terms but the final term. + type: number + query: + description: |- + Terms you wish to find in the provided field. + The last term is used in a prefix query. + type: string + required: + - query + MatchNoneQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + MatchPhraseQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert the text in the query value into tokens. + type: string + query: + description: Query terms that are analyzed and turned into a phrase query. + type: string + slop: + description: Maximum number of positions allowed between matching tokens. + type: number + zero_terms_query: + $ref: '#/components/schemas/ZeroTermsQuery' + required: + - query + MatchPhrasePrefixQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert text in the query value into tokens. + type: string + max_expansions: + description: Maximum number of terms to which the last provided term of the query value will expand. + type: number + query: + description: Text you wish to find in the provided field. + type: string + slop: + description: Maximum number of positions allowed between matching tokens. + type: number + zero_terms_query: + $ref: '#/components/schemas/ZeroTermsQuery' + required: + - query + MoreLikeThisQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + analyzer: + description: |- + The analyzer that is used to analyze the free form text. + Defaults to the analyzer associated with the first field in fields. + type: string + boost_terms: + description: |- + Each term in the formed query could be further boosted by their tf-idf score. + This sets the boost factor to use when using this feature. + Defaults to deactivated (0). + type: number + fail_on_unsupported_field: + description: Controls whether the query should fail (throw an exception) if any of the specified fields are not of the + supported types (`text` or `keyword`). + type: boolean + fields: + description: |- + A list of fields to fetch and analyze the text from. + Defaults to the `index.query.default_field` index setting, which has a default value of `*`. + type: array + items: + $ref: '_common.yaml#/components/schemas/Field' + include: + description: Specifies whether the input documents should also be included in the search results returned. + type: boolean + like: + description: Specifies free form text and/or a single or multiple documents for which you want to find similar + documents. + oneOf: + - $ref: '#/components/schemas/Like' + - type: array + items: + $ref: '#/components/schemas/Like' + max_doc_freq: + description: The maximum document frequency above which the terms are ignored from the input document. + type: number + max_query_terms: + description: The maximum number of query terms that can be selected. + type: number + max_word_length: + description: |- + The maximum word length above which the terms are ignored. + Defaults to unbounded (`0`). + type: number + min_doc_freq: + description: The minimum document frequency below which the terms are ignored from the input document. + type: number + minimum_should_match: + $ref: '_common.yaml#/components/schemas/MinimumShouldMatch' + min_term_freq: + description: The minimum term frequency below which the terms are ignored from the input document. + type: number + min_word_length: + description: The minimum word length below which the terms are ignored. + type: number + per_field_analyzer: + description: Overrides the default analyzer. + type: object + additionalProperties: + type: string + routing: + $ref: '_common.yaml#/components/schemas/Routing' + stop_words: + $ref: '_common.analysis.yaml#/components/schemas/StopWords' + unlike: + description: Used in combination with `like` to exclude documents that match a set of terms. + oneOf: + - $ref: '#/components/schemas/Like' + - type: array + items: + $ref: '#/components/schemas/Like' + version: + $ref: '_common.yaml#/components/schemas/VersionNumber' + version_type: + $ref: '_common.yaml#/components/schemas/VersionType' + required: + - like + Like: + description: Text that we want similar documents for or a lookup to a document's field for the text. + oneOf: + - type: string + - $ref: '#/components/schemas/LikeDocument' + LikeDocument: + type: object + properties: + doc: + description: A document not present in the index. + type: object + fields: + type: array + items: + $ref: '_common.yaml#/components/schemas/Field' + _id: + $ref: '_common.yaml#/components/schemas/Id' + _index: + $ref: '_common.yaml#/components/schemas/IndexName' + per_field_analyzer: + type: object + additionalProperties: + type: string + routing: + $ref: '_common.yaml#/components/schemas/Routing' + version: + $ref: '_common.yaml#/components/schemas/VersionNumber' + version_type: + $ref: '_common.yaml#/components/schemas/VersionType' + MultiMatchQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert the text in the query value into tokens. + type: string + auto_generate_synonyms_phrase_query: + description: If `true`, match phrase queries are automatically created for multi-term synonyms. + type: boolean + cutoff_frequency: + deprecated: true + type: number + fields: + $ref: '_common.yaml#/components/schemas/Fields' + fuzziness: + $ref: '_common.yaml#/components/schemas/Fuzziness' + fuzzy_rewrite: + $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' + fuzzy_transpositions: + description: >- + If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` + to `ba`). + + Can be applied to the term subqueries constructed for all terms but the final term. + type: boolean + lenient: + description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored. + type: boolean + max_expansions: + description: Maximum number of terms to which the query will expand. + type: number + minimum_should_match: + $ref: '_common.yaml#/components/schemas/MinimumShouldMatch' + operator: + $ref: '#/components/schemas/Operator' + prefix_length: + description: Number of beginning characters left unchanged for fuzzy matching. + type: number + query: + description: Text, number, boolean value or date you wish to find in the provided field. + type: string + slop: + description: Maximum number of positions allowed between matching tokens. + type: number + tie_breaker: + description: Determines how scores for each per-term blended query and scores across groups are combined. + type: number + type: + $ref: '#/components/schemas/TextQueryType' + zero_terms_query: + $ref: '#/components/schemas/ZeroTermsQuery' + required: + - query + TextQueryType: + type: string + enum: + - best_fields + - most_fields + - cross_fields + - phrase + - phrase_prefix + - bool_prefix + NestedQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + ignore_unmapped: + description: Indicates whether to ignore an unmapped path and not return any documents instead of an error. + type: boolean + inner_hits: + $ref: '_core.search.yaml#/components/schemas/InnerHits' + path: + $ref: '_common.yaml#/components/schemas/Field' + query: + $ref: '#/components/schemas/QueryContainer' + score_mode: + $ref: '#/components/schemas/ChildScoreMode' + required: + - path + - query + ParentIdQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + id: + $ref: '_common.yaml#/components/schemas/Id' + ignore_unmapped: + description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error. + type: boolean + type: + $ref: '_common.yaml#/components/schemas/RelationName' + PercolateQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + document: + description: The source of the document being percolated. + type: object + documents: + description: An array of sources of the documents being percolated. + type: array + items: + type: object + field: + $ref: '_common.yaml#/components/schemas/Field' + id: + $ref: '_common.yaml#/components/schemas/Id' + index: + $ref: '_common.yaml#/components/schemas/IndexName' + name: + description: The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified. + type: string + preference: + description: Preference used to fetch document to percolate. + type: string + routing: + $ref: '_common.yaml#/components/schemas/Routing' + version: + $ref: '_common.yaml#/components/schemas/VersionNumber' + required: + - field + PinnedQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - allOf: + - type: object + properties: + organic: + $ref: '#/components/schemas/QueryContainer' + required: + - organic + - type: object + properties: + ids: + description: |- + Document IDs listed in the order they are to appear in results. + Required if `docs` is not specified. + type: array + items: + $ref: '_common.yaml#/components/schemas/Id' + docs: + description: |- + Documents listed in the order they are to appear in results. + Required if `ids` is not specified. + type: array + items: + $ref: '#/components/schemas/PinnedDoc' + minProperties: 1 + maxProperties: 1 + PinnedDoc: + type: object + properties: + _id: + $ref: '_common.yaml#/components/schemas/Id' + _index: + $ref: '_common.yaml#/components/schemas/IndexName' + required: + - _id + - _index + PrefixQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + rewrite: + $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' + value: + description: Beginning characters of terms you wish to find in the provided field. + type: string + case_insensitive: + description: >- + Allows ASCII case insensitive matching of the value 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. + type: boolean + required: + - value + QueryStringQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + allow_leading_wildcard: + description: If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string. + type: boolean + analyzer: + description: Analyzer used to convert text in the query string into tokens. + type: string + analyze_wildcard: + description: If `true`, the query attempts to analyze wildcard terms in the query string. + type: boolean + auto_generate_synonyms_phrase_query: + description: If `true`, match phrase queries are automatically created for multi-term synonyms. + type: boolean + default_field: + $ref: '_common.yaml#/components/schemas/Field' + default_operator: + $ref: '#/components/schemas/Operator' + enable_position_increments: + description: If `true`, enable position increments in queries constructed from a `query_string` search. + type: boolean + escape: + type: boolean + fields: + description: Array of fields to search. Supports wildcards (`*`). + type: array + items: + $ref: '_common.yaml#/components/schemas/Field' + fuzziness: + $ref: '_common.yaml#/components/schemas/Fuzziness' + fuzzy_max_expansions: + description: Maximum number of terms to which the query expands for fuzzy matching. + type: number + fuzzy_prefix_length: + description: Number of beginning characters left unchanged for fuzzy matching. + type: number + fuzzy_rewrite: + $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' + fuzzy_transpositions: + description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to + `ba`). + type: boolean + lenient: + description: If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + type: boolean + max_determinized_states: + description: Maximum number of automaton states required for the query. + type: number + minimum_should_match: + $ref: '_common.yaml#/components/schemas/MinimumShouldMatch' + phrase_slop: + description: Maximum number of positions allowed between matching tokens for phrases. + type: number + query: + description: Query string you wish to parse and use for search. + type: string + quote_analyzer: + description: |- + Analyzer used to convert quoted text in the query string into tokens. + For quoted text, this parameter overrides the analyzer specified in the `analyzer` parameter. + type: string + quote_field_suffix: + description: |- + Suffix appended to quoted text in the query string. + You can use this suffix to use a different analysis method for exact matches. + type: string + rewrite: + $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' + tie_breaker: + description: How to combine the queries generated from the individual search terms in the resulting `dis_max` query. + type: number + time_zone: + $ref: '_common.yaml#/components/schemas/TimeZone' + type: + $ref: '#/components/schemas/TextQueryType' + required: + - query + RangeQuery: + oneOf: + - $ref: '#/components/schemas/DateRangeQuery' + - $ref: '#/components/schemas/NumberRangeQuery' + DateRangeQuery: + allOf: + - $ref: '#/components/schemas/RangeQueryBase' + - type: object + properties: + gt: + $ref: '_common.yaml#/components/schemas/DateMath' + gte: + $ref: '_common.yaml#/components/schemas/DateMath' + lt: + $ref: '_common.yaml#/components/schemas/DateMath' + lte: + $ref: '_common.yaml#/components/schemas/DateMath' + from: + oneOf: + - $ref: '_common.yaml#/components/schemas/DateMath' + - nullable: true + type: string + to: + oneOf: + - $ref: '_common.yaml#/components/schemas/DateMath' + - nullable: true + type: string + format: + $ref: '_common.yaml#/components/schemas/DateFormat' + time_zone: + $ref: '_common.yaml#/components/schemas/TimeZone' + RangeQueryBase: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + relation: + $ref: '#/components/schemas/RangeRelation' + RangeRelation: + type: string + enum: + - within + - contains + - intersects + NumberRangeQuery: + allOf: + - $ref: '#/components/schemas/RangeQueryBase' + - type: object + properties: + gt: + description: Greater than. + type: number + gte: + description: Greater than or equal to. + type: number + lt: + description: Less than. + type: number + lte: + description: Less than or equal to. + type: number + from: + oneOf: + - type: number + - nullable: true + type: string + to: + oneOf: + - type: number + - nullable: true + type: string + RankFeatureQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + saturation: + $ref: '#/components/schemas/RankFeatureFunctionSaturation' + log: + $ref: '#/components/schemas/RankFeatureFunctionLogarithm' + linear: + $ref: '#/components/schemas/RankFeatureFunctionLinear' + sigmoid: + $ref: '#/components/schemas/RankFeatureFunctionSigmoid' + required: + - field + RankFeatureFunctionSaturation: + allOf: + - $ref: '#/components/schemas/RankFeatureFunction' + - type: object + properties: + pivot: + description: Configurable pivot value so that the result will be less than 0.5. + type: number + RankFeatureFunction: + type: object + RankFeatureFunctionLogarithm: + allOf: + - $ref: '#/components/schemas/RankFeatureFunction' + - type: object + properties: + scaling_factor: + description: Configurable scaling factor. + type: number + required: + - scaling_factor + RankFeatureFunctionLinear: + allOf: + - $ref: '#/components/schemas/RankFeatureFunction' + - type: object + RankFeatureFunctionSigmoid: + allOf: + - $ref: '#/components/schemas/RankFeatureFunction' + - type: object + properties: + pivot: + description: Configurable pivot value so that the result will be less than 0.5. + type: number + exponent: + description: Configurable Exponent. + type: number + required: + - pivot + - exponent + RegexpQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + case_insensitive: + description: >- + Allows case insensitive matching of the regular expression value with the indexed field values when set + to `true`. + + When `false`, case sensitivity of matching depends on the underlying field’s mapping. + type: boolean + flags: + description: Enables optional operators for the regular expression. + type: string + max_determinized_states: + description: Maximum number of automaton states required for the query. + type: number + rewrite: + $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' + value: + description: Regular expression for terms you wish to find in the provided field. + type: string + required: + - value + RuleQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + organic: + $ref: '#/components/schemas/QueryContainer' + ruleset_id: + $ref: '_common.yaml#/components/schemas/Id' + match_criteria: + type: object + required: + - organic + - ruleset_id + - match_criteria + ScriptQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + script: + $ref: '_common.yaml#/components/schemas/Script' + required: + - script + ScriptScoreQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + min_score: + description: Documents with a score lower than this floating point number are excluded from the search results. + type: number + query: + $ref: '#/components/schemas/QueryContainer' + script: + $ref: '_common.yaml#/components/schemas/Script' + required: + - query + - script + ShapeQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + ignore_unmapped: + description: When set to `true` the query ignores an unmapped field and will not match any documents. + type: boolean + SimpleQueryStringQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + analyzer: + description: Analyzer used to convert text in the query string into tokens. + type: string + analyze_wildcard: + description: If `true`, the query attempts to analyze wildcard terms in the query string. + type: boolean + auto_generate_synonyms_phrase_query: + description: If `true`, the parser creates a match_phrase query for each multi-position token. + type: boolean + default_operator: + $ref: '#/components/schemas/Operator' + fields: + description: |- + Array of fields you wish to search. + Accepts wildcard expressions. + You also can boost relevance scores for matches to particular fields using a caret (`^`) notation. + Defaults to the `index.query.default_field index` setting, which has a default value of `*`. + type: array + items: + $ref: '_common.yaml#/components/schemas/Field' + flags: + $ref: '#/components/schemas/SimpleQueryStringFlags' + fuzzy_max_expansions: + description: Maximum number of terms to which the query expands for fuzzy matching. + type: number + fuzzy_prefix_length: + description: Number of beginning characters left unchanged for fuzzy matching. + type: number + fuzzy_transpositions: + description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to + `ba`). + type: boolean + lenient: + description: If `true`, format-based errors, such as providing a text value for a numeric field, are ignored. + type: boolean + minimum_should_match: + $ref: '_common.yaml#/components/schemas/MinimumShouldMatch' + query: + description: Query string in the simple query string syntax you wish to parse and use for search. + type: string + quote_field_suffix: + description: Suffix appended to quoted text in the query string. + type: string + required: + - query + SimpleQueryStringFlags: + description: Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX` + allOf: + - $ref: '_common.yaml#/components/schemas/PipeSeparatedFlagsSimpleQueryStringFlag' + SimpleQueryStringFlag: + type: string + enum: + - NONE + - AND + - NOT + - OR + - PREFIX + - PHRASE + - PRECEDENCE + - ESCAPE + - WHITESPACE + - FUZZY + - NEAR + - SLOP + - ALL + SpanContainingQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + big: + $ref: '#/components/schemas/SpanQuery' + little: + $ref: '#/components/schemas/SpanQuery' + required: + - big + - little + SpanQuery: + type: object + properties: + span_containing: + $ref: '#/components/schemas/SpanContainingQuery' + field_masking_span: + $ref: '#/components/schemas/SpanFieldMaskingQuery' + span_first: + $ref: '#/components/schemas/SpanFirstQuery' + span_gap: + $ref: '#/components/schemas/SpanGapQuery' + span_multi: + $ref: '#/components/schemas/SpanMultiTermQuery' + span_near: + $ref: '#/components/schemas/SpanNearQuery' + span_not: + $ref: '#/components/schemas/SpanNotQuery' + span_or: + $ref: '#/components/schemas/SpanOrQuery' + span_term: + description: The equivalent of the `term` query but for use with other span queries. + type: object + additionalProperties: + $ref: '#/components/schemas/SpanTermQuery' + minProperties: 1 + maxProperties: 1 + span_within: + $ref: '#/components/schemas/SpanWithinQuery' + minProperties: 1 + maxProperties: 1 + SpanFieldMaskingQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + query: + $ref: '#/components/schemas/SpanQuery' + required: + - field + - query + SpanFirstQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + end: + description: Controls the maximum end position permitted in a match. + type: number + match: + $ref: '#/components/schemas/SpanQuery' + required: + - end + - match + SpanGapQuery: + description: Can only be used as a clause in a span_near query. + type: object + additionalProperties: + type: number + minProperties: 1 + maxProperties: 1 + SpanMultiTermQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + match: + $ref: '#/components/schemas/QueryContainer' + required: + - match + SpanNearQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + clauses: + description: Array of one or more other span type queries. + type: array + items: + $ref: '#/components/schemas/SpanQuery' + in_order: + description: Controls whether matches are required to be in-order. + type: boolean + slop: + description: Controls the maximum number of intervening unmatched positions permitted. + type: number + required: + - clauses + SpanNotQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + dist: + description: |- + The number of tokens from within the include span that can’t have overlap with the exclude span. + Equivalent to setting both `pre` and `post`. + type: number + exclude: + $ref: '#/components/schemas/SpanQuery' + include: + $ref: '#/components/schemas/SpanQuery' + post: + description: The number of tokens after the include span that can’t have overlap with the exclude span. + type: number + pre: + description: The number of tokens before the include span that can’t have overlap with the exclude span. + type: number + required: + - exclude + - include + SpanOrQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + clauses: + description: Array of one or more other span type queries. + type: array + items: + $ref: '#/components/schemas/SpanQuery' + required: + - clauses + SpanTermQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + value: + type: string + required: + - value + SpanWithinQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + big: + $ref: '#/components/schemas/SpanQuery' + little: + $ref: '#/components/schemas/SpanQuery' + required: + - big + - little + TermQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + value: + $ref: '_common.yaml#/components/schemas/FieldValue' + case_insensitive: + description: |- + Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`. + When `false`, the case sensitivity of matching depends on the underlying field’s mapping. + type: boolean + required: + - value + TermsQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + TermsSetQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + minimum_should_match_field: + $ref: '_common.yaml#/components/schemas/Field' + minimum_should_match_script: + $ref: '_common.yaml#/components/schemas/Script' + terms: + description: Array of terms you wish to find in the provided field. + type: array + items: + type: string + required: + - terms + TextExpansionQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + model_id: + description: The text expansion NLP model to use + type: string + model_text: + description: The query text + type: string + pruning_config: + $ref: '#/components/schemas/TokenPruningConfig' + required: + - model_id + - model_text + TokenPruningConfig: + type: object + properties: + tokens_freq_ratio_threshold: + description: Tokens whose frequency is more than this threshold times the average frequency of all tokens in the + specified field are considered outliers and pruned. + type: number + tokens_weight_threshold: + description: Tokens whose weight is less than this threshold are considered nonsignificant and pruned. + type: number + only_score_pruned_tokens: + description: Whether to only score pruned tokens, vs only scoring kept tokens. + type: boolean + WeightedTokensQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + tokens: + description: The tokens representing this query + type: object + additionalProperties: + type: number + pruning_config: + $ref: '#/components/schemas/TokenPruningConfig' + required: + - tokens + WildcardQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + case_insensitive: + 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. + type: boolean + rewrite: + $ref: '_common.yaml#/components/schemas/MultiTermQueryRewrite' + value: + description: Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set. + type: string + wildcard: + description: Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set. + type: string + WrapperQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + query: + description: |- + A base64 encoded query. + The binary data format can be any of JSON, YAML, CBOR or SMILE encodings + type: string + required: + - query + TypeQuery: + allOf: + - $ref: '#/components/schemas/QueryBase' + - type: object + properties: + value: + type: string + required: + - value diff --git a/spec/schemas/_common.yaml b/spec/schemas/_common.yaml new file mode 100644 index 00000000..ce46ac9d --- /dev/null +++ b/spec/schemas/_common.yaml @@ -0,0 +1,1822 @@ +openapi: 3.1.0 +info: + title: Schemas of _common category + description: Schemas of _common category + version: 1.0.0 +paths: {} +components: + schemas: + Id: + type: string + AcknowledgedResponseBase: + type: object + properties: + acknowledged: + description: For a successful response, this value is always true. On failure, an exception is returned instead. + type: boolean + required: + - acknowledged + Duration: + description: |- + A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and + `d` (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. + x-data-type: time + pattern: ^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$ + type: string + Metadata: + type: object + additionalProperties: + type: object + GeoBounds: + description: |- + 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 + oneOf: + - $ref: '#/components/schemas/CoordsGeoBounds' + - $ref: '#/components/schemas/TopLeftBottomRightGeoBounds' + - $ref: '#/components/schemas/TopRightBottomLeftGeoBounds' + - $ref: '#/components/schemas/WktGeoBounds' + CoordsGeoBounds: + type: object + properties: + top: + type: number + bottom: + type: number + left: + type: number + right: + type: number + required: + - top + - bottom + - left + - right + TopLeftBottomRightGeoBounds: + type: object + properties: + top_left: + $ref: '#/components/schemas/GeoLocation' + bottom_right: + $ref: '#/components/schemas/GeoLocation' + required: + - top_left + - bottom_right + GeoLocation: + description: |- + 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 + oneOf: + - $ref: '#/components/schemas/LatLonGeoLocation' + - $ref: '#/components/schemas/GeoHashLocation' + - type: array + items: + type: number + - type: string + LatLonGeoLocation: + type: object + properties: + lat: + description: Latitude + type: number + lon: + description: Longitude + type: number + required: + - lat + - lon + GeoHashLocation: + type: object + properties: + geohash: + $ref: '#/components/schemas/GeoHash' + required: + - geohash + GeoHash: + type: string + TopRightBottomLeftGeoBounds: + type: object + properties: + top_right: + $ref: '#/components/schemas/GeoLocation' + bottom_left: + $ref: '#/components/schemas/GeoLocation' + required: + - top_right + - bottom_left + WktGeoBounds: + type: object + properties: + wkt: + type: string + required: + - wkt + EpochTimeUnitMillis: + allOf: + - $ref: '#/components/schemas/UnitMillis' + UnitMillis: + description: Time unit for milliseconds + type: number + DurationLarge: + description: >- + A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) + and + + `y` (year) + type: string + FieldValue: + description: A field value. + oneOf: + - type: number + - type: number + - type: string + - type: boolean + - nullable: true + type: string + - type: object + Void: + description: |- + 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 + type: object + GeoTile: + description: A map tile reference, represented as `{zoom}/{x}/{y}` + type: string + GeoHexCell: + description: A map hex cell (H3) reference + type: string + IndexName: + type: string + Field: + description: Path to field or array of paths. Some API's support wildcards in the path to select multiple fields. + type: string + SequenceNumber: + type: number + VersionNumber: + type: number + SortResults: + type: array + items: + $ref: '#/components/schemas/FieldValue' + GeoLine: + type: object + properties: + type: + description: Always `"LineString"` + type: string + coordinates: + description: Array of `[lon, lat]` coordinates + type: array + items: + type: array + items: + type: number + required: + - type + - coordinates + ClusterStatistics: + type: object + properties: + skipped: + type: number + successful: + type: number + total: + type: number + running: + type: number + partial: + type: number + failed: + type: number + details: + type: object + additionalProperties: + $ref: '#/components/schemas/ClusterDetails' + required: + - skipped + - successful + - total + - running + - partial + - failed + ClusterDetails: + type: object + properties: + status: + $ref: '#/components/schemas/ClusterSearchStatus' + indices: + type: string + took: + $ref: '#/components/schemas/DurationValueUnitMillis' + timed_out: + type: boolean + _shards: + $ref: '#/components/schemas/ShardStatistics' + failures: + type: array + items: + $ref: '#/components/schemas/ShardFailure' + required: + - status + - indices + - timed_out + ClusterSearchStatus: + type: string + enum: + - running + - successful + - partial + - skipped + - failed + DurationValueUnitMillis: + allOf: + - $ref: '#/components/schemas/UnitMillis' + ShardStatistics: + type: object + properties: + failed: + $ref: '#/components/schemas/uint' + successful: + $ref: '#/components/schemas/uint' + total: + $ref: '#/components/schemas/uint' + failures: + type: array + items: + $ref: '#/components/schemas/ShardFailure' + skipped: + $ref: '#/components/schemas/uint' + required: + - failed + - successful + - total + uint: + type: number + ShardFailure: + type: object + properties: + index: + $ref: '#/components/schemas/IndexName' + node: + type: string + reason: + $ref: '#/components/schemas/ErrorCause' + shard: + type: number + status: + type: string + required: + - reason + - shard + ErrorCause: + type: object + properties: + type: + description: The type of error + type: string + reason: + description: A human-readable explanation of the error, in english + type: string + stack_trace: + description: The server stack trace. Present only if the `error_trace=true` parameter was sent with the request. + type: string + caused_by: + $ref: '#/components/schemas/ErrorCause' + root_cause: + type: array + items: + $ref: '#/components/schemas/ErrorCause' + suppressed: + type: array + items: + $ref: '#/components/schemas/ErrorCause' + required: + - type + DurationValueUnitNanos: + allOf: + - $ref: '#/components/schemas/UnitNanos' + UnitNanos: + description: Time unit for nanoseconds + type: number + ScrollId: + type: string + Routing: + type: string + DateTime: + description: |- + A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a + number of milliseconds since the Epoch. Opensearch accepts both as input, but will generally output a string + representation. + oneOf: + - type: string + - $ref: '#/components/schemas/EpochTimeUnitMillis' + Indices: + oneOf: + - $ref: '#/components/schemas/IndexName' + - type: array + items: + $ref: '#/components/schemas/IndexName' + Fields: + oneOf: + - $ref: '#/components/schemas/Field' + - type: array + items: + $ref: '#/components/schemas/Field' + ExpandWildcards: + oneOf: + - $ref: '#/components/schemas/ExpandWildcard' + - type: array + items: + $ref: '#/components/schemas/ExpandWildcard' + ExpandWildcard: + type: string + enum: + - all + - open + - closed + - hidden + - none + VersionString: + type: string + SearchType: + type: string + enum: + - query_then_fetch + - dfs_query_then_fetch + SuggestMode: + type: string + enum: + - missing + - popular + - always + MinimumShouldMatch: + description: The minimum number of terms that should match as integer, percentage or range + oneOf: + - type: number + - type: string + Distance: + type: string + DateMath: + type: string + Script: + oneOf: + - $ref: '#/components/schemas/InlineScript' + - $ref: '#/components/schemas/StoredScriptId' + InlineScript: + allOf: + - $ref: '#/components/schemas/ScriptBase' + - type: object + properties: + lang: + $ref: '#/components/schemas/ScriptLanguage' + options: + type: object + additionalProperties: + type: string + source: + description: The script source. + type: string + required: + - source + ScriptLanguage: + type: string + enum: + - painless + - expression + - mustache + - java + ScriptBase: + type: object + properties: + params: + description: |- + Specifies any named parameters that are passed into the script as variables. + Use parameters instead of hard-coded values to decrease compile time. + type: object + additionalProperties: + type: object + StoredScriptId: + allOf: + - $ref: '#/components/schemas/ScriptBase' + - type: object + properties: + id: + $ref: '#/components/schemas/Id' + required: + - id + MultiTermQueryRewrite: + type: string + Fuzziness: + oneOf: + - type: string + - type: number + GeoDistanceType: + type: string + enum: + - arc + - plane + Name: + type: string + ScriptField: + type: object + properties: + script: + $ref: '#/components/schemas/Script' + ignore_failure: + type: boolean + required: + - script + Sort: + oneOf: + - $ref: '#/components/schemas/SortCombinations' + - type: array + items: + $ref: '#/components/schemas/SortCombinations' + SortCombinations: + oneOf: + - $ref: '#/components/schemas/Field' + - $ref: '#/components/schemas/SortOptions' + SortOptions: + type: object + properties: + _score: + $ref: '#/components/schemas/ScoreSort' + _doc: + $ref: '#/components/schemas/ScoreSort' + _geo_distance: + $ref: '#/components/schemas/GeoDistanceSort' + _script: + $ref: '#/components/schemas/ScriptSort' + minProperties: 1 + maxProperties: 1 + ScoreSort: + type: object + properties: + order: + $ref: '#/components/schemas/SortOrder' + SortOrder: + type: string + enum: + - asc + - desc + GeoDistanceSort: + type: object + properties: + mode: + $ref: '#/components/schemas/SortMode' + distance_type: + $ref: '#/components/schemas/GeoDistanceType' + ignore_unmapped: + type: boolean + order: + $ref: '#/components/schemas/SortOrder' + unit: + $ref: '#/components/schemas/DistanceUnit' + SortMode: + type: string + enum: + - min + - max + - sum + - avg + - median + DistanceUnit: + type: string + enum: + - in + - ft + - yd + - mi + - nmi + - km + - m + - cm + - mm + ScriptSort: + type: object + properties: + order: + $ref: '#/components/schemas/SortOrder' + script: + $ref: '#/components/schemas/Script' + type: + $ref: '#/components/schemas/ScriptSortType' + mode: + $ref: '#/components/schemas/SortMode' + nested: + $ref: '#/components/schemas/NestedSortValue' + required: + - script + ScriptSortType: + type: string + enum: + - string + - number + - version + NestedSortValue: + type: object + properties: + filter: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + max_children: + type: number + nested: + $ref: '#/components/schemas/NestedSortValue' + path: + $ref: '#/components/schemas/Field' + required: + - path + RelationName: + type: string + Ids: + oneOf: + - $ref: '#/components/schemas/Id' + - type: array + items: + $ref: '#/components/schemas/Id' + VersionType: + type: string + enum: + - internal + - external + - external_gte + - force + TimeZone: + type: string + DateFormat: + type: string + PipeSeparatedFlagsSimpleQueryStringFlag: + description: |- + A set of flags that can be represented as a single enum value or a set of values that are encoded + as a pipe-separated string + + Depending on the target language, code generators can use this hint to generate language specific + flags enum constructs and the corresponding (de-)serialization code. + oneOf: + - $ref: '_common.query_dsl.yaml#/components/schemas/SimpleQueryStringFlag' + - type: string + GeoHashPrecision: + description: A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m". + oneOf: + - type: number + - type: string + GeoTilePrecision: + type: number + EmptyObject: + type: object + KnnQuery: + type: object + properties: + field: + $ref: '#/components/schemas/Field' + query_vector: + $ref: '#/components/schemas/QueryVector' + query_vector_builder: + $ref: '#/components/schemas/QueryVectorBuilder' + k: + description: The final number of nearest neighbors to return as top hits + type: number + num_candidates: + description: The number of nearest neighbor candidates to consider per shard + type: number + boost: + description: Boost value to apply to kNN scores + type: number + filter: + description: Filters for the kNN search query + oneOf: + - $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + - type: array + items: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + similarity: + description: The minimum similarity for a vector to be considered a match + type: number + required: + - field + - k + - num_candidates + QueryVector: + type: array + items: + type: number + QueryVectorBuilder: + type: object + properties: + text_embedding: + $ref: '#/components/schemas/TextEmbedding' + minProperties: 1 + maxProperties: 1 + TextEmbedding: + type: object + properties: + model_id: + type: string + model_text: + type: string + required: + - model_id + - model_text + SlicedScroll: + type: object + properties: + field: + $ref: '#/components/schemas/Field' + id: + $ref: '#/components/schemas/Id' + max: + type: number + required: + - id + - max + NodeName: + type: string + Refresh: + type: string + enum: + - 'true' + - 'false' + - wait_for + WaitForActiveShards: + oneOf: + - type: number + - $ref: '#/components/schemas/WaitForActiveShardOptions' + WaitForActiveShardOptions: + type: string + enum: + - all + - index-setting + InlineGetDictUserDefined: + type: object + properties: + fields: + type: object + additionalProperties: + type: object + found: + type: boolean + _seq_no: + $ref: '#/components/schemas/SequenceNumber' + _primary_term: + type: number + _routing: + $ref: '#/components/schemas/Routing' + _source: + type: object + additionalProperties: + type: object + required: + - found + - _source + Names: + oneOf: + - $ref: '#/components/schemas/Name' + - type: array + items: + $ref: '#/components/schemas/Name' + NodeIds: + oneOf: + - $ref: '#/components/schemas/NodeId' + - type: array + items: + $ref: '#/components/schemas/NodeId' + NodeId: + type: string + Bytes: + type: string + enum: + - b + - kb + - mb + - gb + - tb + - pb + ByteSize: + oneOf: + - type: number + - type: string + Percentage: + oneOf: + - type: string + - type: number + Host: + type: string + Ip: + type: string + StringifiedEpochTimeUnitSeconds: + description: |- + 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. + + Depending on the target language, code generators can keep the union or remove it and leniently parse + strings to the target type. + oneOf: + - $ref: '#/components/schemas/EpochTimeUnitSeconds' + - type: string + EpochTimeUnitSeconds: + allOf: + - $ref: '#/components/schemas/UnitSeconds' + UnitSeconds: + description: Time unit for seconds + type: number + TimeOfDay: + description: Time of day, expressed as HH:MM:SS + type: string + TimeUnit: + type: string + enum: + - nanos + - micros + - ms + - s + - m + - h + - d + HealthStatus: + type: string + enum: + - green + - yellow + - red + ScheduleTimeOfDay: + description: A time of day, expressed either as `hh:mm`, `noon`, `midnight`, or an hour/minutes structure. + oneOf: + - type: string + - $ref: '#/components/schemas/HourAndMinute' + HourAndMinute: + type: object + properties: + hour: + type: array + items: + type: number + minute: + type: array + items: + type: number + required: + - hour + - minute + Uuid: + type: string + ScrollIds: + oneOf: + - $ref: '#/components/schemas/ScrollId' + - type: array + items: + $ref: '#/components/schemas/ScrollId' + TransportAddress: + type: string + Stringifiedinteger: + description: |- + 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. + + Depending on the target language, code generators can keep the union or remove it and leniently parse + strings to the target type. + oneOf: + - type: number + - type: string + Stringifiedboolean: + description: |- + 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. + + Depending on the target language, code generators can keep the union or remove it and leniently parse + strings to the target type. + oneOf: + - type: boolean + - type: string + PipelineName: + type: string + StringifiedEpochTimeUnitMillis: + description: |- + 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. + + Depending on the target language, code generators can keep the union or remove it and leniently parse + strings to the target type. + oneOf: + - $ref: '#/components/schemas/EpochTimeUnitMillis' + - type: string + DFIIndependenceMeasure: + type: string + enum: + - standardized + - saturated + - chisquared + DFRAfterEffect: + type: string + enum: + - no + - b + - l + DFRBasicModel: + type: string + enum: + - be + - d + - g + - if + - in + - ine + - p + Normalization: + type: string + enum: + - no + - h1 + - h2 + - h3 + - z + IBDistribution: + type: string + enum: + - ll + - spl + IBLambda: + type: string + enum: + - df + - ttf + byte: + type: number + short: + type: number + ulong: + type: number + Level: + type: string + enum: + - cluster + - indices + - shards + WaitForEvents: + type: string + enum: + - immediate + - urgent + - high + - normal + - low + - languid + DataStreamName: + type: string + Metrics: + oneOf: + - type: string + - type: array + items: + type: string + CompletionStats: + type: object + properties: + size_in_bytes: + description: Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes. + type: number + size: + $ref: '#/components/schemas/ByteSize' + fields: + type: object + additionalProperties: + $ref: '#/components/schemas/FieldSizeUsage' + required: + - size_in_bytes + FieldSizeUsage: + type: object + properties: + size: + $ref: '#/components/schemas/ByteSize' + size_in_bytes: + type: number + required: + - size_in_bytes + DocStats: + type: object + properties: + count: + description: |- + Total number of non-deleted documents across all primary shards assigned to selected nodes. + This number is based on documents in Lucene segments and may include documents from nested fields. + type: number + deleted: + description: |- + Total number of deleted documents across all primary shards assigned to selected nodes. + This number is based on documents in Lucene segments. + Opensearch reclaims the disk space of deleted Lucene documents when a segment is merged. + type: number + required: + - count + FielddataStats: + type: object + properties: + evictions: + type: number + memory_size: + $ref: '#/components/schemas/ByteSize' + memory_size_in_bytes: + type: number + fields: + type: object + additionalProperties: + $ref: '#/components/schemas/FieldMemoryUsage' + required: + - memory_size_in_bytes + FieldMemoryUsage: + type: object + properties: + memory_size: + $ref: '#/components/schemas/ByteSize' + memory_size_in_bytes: + type: number + required: + - memory_size_in_bytes + QueryCacheStats: + type: object + properties: + cache_count: + description: |- + Total number of entries added to the query cache across all shards assigned to selected nodes. + This number includes current and evicted entries. + type: number + cache_size: + description: Total number of entries currently in the query cache across all shards assigned to selected nodes. + type: number + evictions: + description: Total number of query cache evictions across all shards assigned to selected nodes. + type: number + hit_count: + description: Total count of query cache hits across all shards assigned to selected nodes. + type: number + memory_size: + $ref: '#/components/schemas/ByteSize' + memory_size_in_bytes: + description: Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes. + type: number + miss_count: + description: Total count of query cache misses across all shards assigned to selected nodes. + type: number + total_count: + description: Total count of hits and misses in the query cache across all shards assigned to selected nodes. + type: number + required: + - cache_count + - cache_size + - evictions + - hit_count + - memory_size_in_bytes + - miss_count + - total_count + SegmentsStats: + type: object + properties: + count: + description: Total number of segments across all shards assigned to selected nodes. + type: number + doc_values_memory: + $ref: '#/components/schemas/ByteSize' + doc_values_memory_in_bytes: + description: Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes. + type: number + file_sizes: + description: |- + This object is not populated by the cluster stats API. + To get information on segment files, use the node stats API. + type: object + additionalProperties: + $ref: 'indices.stats.yaml#/components/schemas/ShardFileSizeInfo' + fixed_bit_set: + $ref: '#/components/schemas/ByteSize' + fixed_bit_set_memory_in_bytes: + description: Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes. + type: number + index_writer_memory: + $ref: '#/components/schemas/ByteSize' + index_writer_max_memory_in_bytes: + type: number + index_writer_memory_in_bytes: + description: Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes. + type: number + max_unsafe_auto_id_timestamp: + description: Unix timestamp, in milliseconds, of the most recently retried indexing request. + type: number + memory: + $ref: '#/components/schemas/ByteSize' + memory_in_bytes: + description: Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes. + type: number + norms_memory: + $ref: '#/components/schemas/ByteSize' + norms_memory_in_bytes: + description: Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected + nodes. + type: number + points_memory: + $ref: '#/components/schemas/ByteSize' + points_memory_in_bytes: + description: Total amount, in bytes, of memory used for points across all shards assigned to selected nodes. + type: number + stored_memory: + $ref: '#/components/schemas/ByteSize' + stored_fields_memory_in_bytes: + description: Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes. + type: number + terms_memory_in_bytes: + description: Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes. + type: number + terms_memory: + $ref: '#/components/schemas/ByteSize' + term_vectory_memory: + $ref: '#/components/schemas/ByteSize' + term_vectors_memory_in_bytes: + description: Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes. + type: number + version_map_memory: + $ref: '#/components/schemas/ByteSize' + version_map_memory_in_bytes: + description: Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes. + type: number + required: + - count + - doc_values_memory_in_bytes + - file_sizes + - fixed_bit_set_memory_in_bytes + - index_writer_memory_in_bytes + - max_unsafe_auto_id_timestamp + - memory_in_bytes + - norms_memory_in_bytes + - points_memory_in_bytes + - stored_fields_memory_in_bytes + - terms_memory_in_bytes + - term_vectors_memory_in_bytes + - version_map_memory_in_bytes + StoreStats: + type: object + properties: + size: + $ref: '#/components/schemas/ByteSize' + size_in_bytes: + description: Total size, in bytes, of all shards assigned to selected nodes. + type: number + reserved: + $ref: '#/components/schemas/ByteSize' + reserved_in_bytes: + description: A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer + recoveries, restoring snapshots, and similar activities. + type: number + total_data_set_size: + $ref: '#/components/schemas/ByteSize' + total_data_set_size_in_bytes: + description: >- + Total data set size, in bytes, of all shards assigned to selected nodes. + + This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices. + type: number + required: + - size_in_bytes + - reserved_in_bytes + PluginStats: + type: object + properties: + classname: + type: string + description: + type: string + extended_plugins: + type: array + items: + type: string + has_native_controller: + type: boolean + java_version: + $ref: '#/components/schemas/VersionString' + name: + $ref: '#/components/schemas/Name' + version: + $ref: '#/components/schemas/VersionString' + licensed: + type: boolean + opensearch_version: + $ref: '#/components/schemas/VersionString' + required: + - classname + - description + - opensearch_version + - extended_plugins + - has_native_controller + - java_version + - name + - version + - licensed + NodeStatistics: + type: object + properties: + failures: + type: array + items: + $ref: '#/components/schemas/ErrorCause' + total: + description: Total number of nodes selected by the request. + type: number + successful: + description: Number of nodes that responded successfully to the request. + type: number + failed: + description: Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the + rejection or failure is included in the response. + type: number + required: + - total + - successful + - failed + WriteResponseBase: + type: object + properties: + _id: + $ref: '#/components/schemas/Id' + _index: + $ref: '#/components/schemas/IndexName' + _primary_term: + type: number + result: + $ref: '#/components/schemas/Result' + _seq_no: + $ref: '#/components/schemas/SequenceNumber' + _shards: + $ref: '#/components/schemas/ShardStatistics' + _version: + $ref: '#/components/schemas/VersionNumber' + forced_refresh: + type: boolean + required: + - _id + - _index + - _primary_term + - result + - _seq_no + - _shards + - _version + Result: + type: string + enum: + - created + - updated + - deleted + - not_found + - noop + Conflicts: + type: string + enum: + - abort + - proceed + Slices: + description: Slices configuration used to parallelize a process. + oneOf: + - type: number + - $ref: '#/components/schemas/SlicesCalculation' + SlicesCalculation: + type: string + enum: + - auto + BulkIndexByScrollFailure: + type: object + properties: + cause: + $ref: '#/components/schemas/ErrorCause' + id: + $ref: '#/components/schemas/Id' + index: + $ref: '#/components/schemas/IndexName' + status: + type: number + type: + type: string + required: + - cause + - id + - index + - status + - type + Retries: + type: object + properties: + bulk: + type: number + search: + type: number + required: + - bulk + - search + TaskId: + oneOf: + - type: string + - type: number + TaskFailure: + type: object + properties: + task_id: + type: number + node_id: + $ref: '#/components/schemas/NodeId' + status: + type: string + reason: + $ref: '#/components/schemas/ErrorCause' + required: + - task_id + - node_id + - status + - reason + InlineGet: + type: object + properties: + fields: + type: object + additionalProperties: + type: object + found: + type: boolean + _seq_no: + $ref: '#/components/schemas/SequenceNumber' + _primary_term: + type: number + _routing: + $ref: '#/components/schemas/Routing' + _source: + type: object + required: + - found + - _source + IndexAlias: + type: string + ErrorResponseBase: + type: object + properties: + error: + $ref: '#/components/schemas/ErrorCause' + status: + type: number + required: + - error + - status + StoredScript: + type: object + properties: + lang: + $ref: '#/components/schemas/ScriptLanguage' + options: + type: object + additionalProperties: + type: string + source: + description: The script source. + type: string + required: + - lang + - source + OpType: + type: string + enum: + - index + - create + ShardsOperationResponseBase: + type: object + properties: + _shards: + $ref: '#/components/schemas/ShardStatistics' + required: + - _shards + IndicesResponseBase: + allOf: + - $ref: '#/components/schemas/AcknowledgedResponseBase' + - type: object + properties: + _shards: + $ref: '#/components/schemas/ShardStatistics' + DataStreamNames: + oneOf: + - $ref: '#/components/schemas/DataStreamName' + - type: array + items: + $ref: '#/components/schemas/DataStreamName' + FlushStats: + type: object + properties: + periodic: + type: number + total: + type: number + total_time: + $ref: '#/components/schemas/Duration' + total_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + required: + - periodic + - total + - total_time_in_millis + GetStats: + type: object + properties: + current: + type: number + exists_time: + $ref: '#/components/schemas/Duration' + exists_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + exists_total: + type: number + missing_time: + $ref: '#/components/schemas/Duration' + missing_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + missing_total: + type: number + time: + $ref: '#/components/schemas/Duration' + time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + total: + type: number + required: + - current + - exists_time_in_millis + - exists_total + - missing_time_in_millis + - missing_total + - time_in_millis + - total + IndexingStats: + type: object + properties: + index_current: + type: number + delete_current: + type: number + delete_time: + $ref: '#/components/schemas/Duration' + delete_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + delete_total: + type: number + is_throttled: + type: boolean + noop_update_total: + type: number + throttle_time: + $ref: '#/components/schemas/Duration' + throttle_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + index_time: + $ref: '#/components/schemas/Duration' + index_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + index_total: + type: number + index_failed: + type: number + types: + type: object + additionalProperties: + $ref: '#/components/schemas/IndexingStats' + write_load: + type: number + required: + - index_current + - delete_current + - delete_time_in_millis + - delete_total + - is_throttled + - noop_update_total + - throttle_time_in_millis + - index_time_in_millis + - index_total + - index_failed + MergesStats: + type: object + properties: + current: + type: number + current_docs: + type: number + current_size: + type: string + current_size_in_bytes: + type: number + total: + type: number + total_auto_throttle: + type: string + total_auto_throttle_in_bytes: + type: number + total_docs: + type: number + total_size: + type: string + total_size_in_bytes: + type: number + total_stopped_time: + $ref: '#/components/schemas/Duration' + total_stopped_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + total_throttled_time: + $ref: '#/components/schemas/Duration' + total_throttled_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + total_time: + $ref: '#/components/schemas/Duration' + total_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + required: + - current + - current_docs + - current_size_in_bytes + - total + - total_auto_throttle_in_bytes + - total_docs + - total_size_in_bytes + - total_stopped_time_in_millis + - total_throttled_time_in_millis + - total_time_in_millis + RecoveryStats: + type: object + properties: + current_as_source: + type: number + current_as_target: + type: number + throttle_time: + $ref: '#/components/schemas/Duration' + throttle_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + required: + - current_as_source + - current_as_target + - throttle_time_in_millis + RefreshStats: + type: object + properties: + external_total: + type: number + external_total_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + listeners: + type: number + total: + type: number + total_time: + $ref: '#/components/schemas/Duration' + total_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + required: + - external_total + - external_total_time_in_millis + - listeners + - total + - total_time_in_millis + RequestCacheStats: + type: object + properties: + evictions: + type: number + hit_count: + type: number + memory_size: + type: string + memory_size_in_bytes: + type: number + miss_count: + type: number + required: + - evictions + - hit_count + - memory_size_in_bytes + - miss_count + SearchStats: + type: object + properties: + fetch_current: + type: number + fetch_time: + $ref: '#/components/schemas/Duration' + fetch_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + fetch_total: + type: number + open_contexts: + type: number + query_current: + type: number + query_time: + $ref: '#/components/schemas/Duration' + query_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + query_total: + type: number + scroll_current: + type: number + scroll_time: + $ref: '#/components/schemas/Duration' + scroll_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + scroll_total: + type: number + suggest_current: + type: number + suggest_time: + $ref: '#/components/schemas/Duration' + suggest_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + suggest_total: + type: number + groups: + type: object + additionalProperties: + $ref: '#/components/schemas/SearchStats' + required: + - fetch_current + - fetch_time_in_millis + - fetch_total + - query_current + - query_time_in_millis + - query_total + - scroll_current + - scroll_time_in_millis + - scroll_total + - suggest_current + - suggest_time_in_millis + - suggest_total + TranslogStats: + type: object + properties: + earliest_last_modified_age: + type: number + operations: + type: number + size: + type: string + size_in_bytes: + type: number + uncommitted_operations: + type: number + uncommitted_size: + type: string + uncommitted_size_in_bytes: + type: number + required: + - earliest_last_modified_age + - operations + - size_in_bytes + - uncommitted_operations + - uncommitted_size_in_bytes + WarmerStats: + type: object + properties: + current: + type: number + total: + type: number + total_time: + $ref: '#/components/schemas/Duration' + total_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + required: + - current + - total + - total_time_in_millis + BulkStats: + type: object + properties: + total_operations: + type: number + total_time: + $ref: '#/components/schemas/Duration' + total_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + total_size: + $ref: '#/components/schemas/ByteSize' + total_size_in_bytes: + type: number + avg_time: + $ref: '#/components/schemas/Duration' + avg_time_in_millis: + $ref: '#/components/schemas/DurationValueUnitMillis' + avg_size: + $ref: '#/components/schemas/ByteSize' + avg_size_in_bytes: + type: number + required: + - total_operations + - total_time_in_millis + - total_size_in_bytes + - avg_time_in_millis + - avg_size_in_bytes + GeoShapeRelation: + type: string + enum: + - intersects + - disjoint + - within + - contains + StringifiedVersionNumber: + description: |- + 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. + + Depending on the target language, code generators can keep the union or remove it and leniently parse + strings to the target type. + oneOf: + - $ref: '#/components/schemas/VersionNumber' + - type: string + ActionStatusOptions: + type: string + enum: + - success + - failure + - simulated + - throttled + NodeAttributes: + type: object + properties: + attributes: + description: Lists node attributes. + type: object + additionalProperties: + type: string + ephemeral_id: + $ref: '#/components/schemas/Id' + id: + $ref: '#/components/schemas/NodeId' + name: + $ref: '#/components/schemas/NodeName' + transport_address: + $ref: '#/components/schemas/TransportAddress' + roles: + $ref: '#/components/schemas/NodeRoles' + external_id: + type: string + required: + - attributes + - ephemeral_id + - name + - transport_address + NodeRoles: + description: '* @doc_id node-roles' + type: array + items: + $ref: '#/components/schemas/NodeRole' + NodeRole: + type: string + enum: + - master + - data + - data_cold + - data_content + - data_frozen + - data_hot + - data_warm + - client + - ingest + - ml + - voting_only + - transform + - remote_cluster_client + - coordinating_only + HttpHeaders: + type: object + additionalProperties: + oneOf: + - type: string + - type: array + items: + type: string + Password: + type: string + Username: + type: string + BaseNode: + type: object + properties: + attributes: + type: object + additionalProperties: + type: string + host: + $ref: '#/components/schemas/Host' + ip: + $ref: '#/components/schemas/Ip' + name: + $ref: '#/components/schemas/Name' + roles: + $ref: '#/components/schemas/NodeRoles' + transport_address: + $ref: '#/components/schemas/TransportAddress' + required: + - attributes + - host + - ip + - name + - transport_address + RankContainer: + type: object + properties: + rrf: + $ref: '#/components/schemas/RrfRank' + minProperties: 1 + maxProperties: 1 + RrfRank: + allOf: + - $ref: '#/components/schemas/RankBase' + - type: object + properties: + rank_constant: + description: How much influence documents in individual result sets per query have over the final ranked result set + type: number + window_size: + description: Size of the individual result sets per query + type: number + RankBase: + type: object + NodeShard: + type: object + properties: + state: + $ref: 'indices.stats.yaml#/components/schemas/ShardRoutingState' + primary: + type: boolean + node: + $ref: '#/components/schemas/NodeName' + shard: + type: number + index: + $ref: '#/components/schemas/IndexName' + allocation_id: + type: object + additionalProperties: + $ref: '#/components/schemas/Id' + recovery_source: + type: object + additionalProperties: + $ref: '#/components/schemas/Id' + unassigned_info: + $ref: 'cluster.allocation_explain.yaml#/components/schemas/UnassignedInformation' + relocating_node: + oneOf: + - $ref: '#/components/schemas/NodeId' + - nullable: true + type: string + relocation_failure_info: + $ref: '#/components/schemas/RelocationFailureInfo' + required: + - state + - primary + - shard + - index + RelocationFailureInfo: + type: object + properties: + failed_attempts: + type: number + required: + - failed_attempts + OpensearchVersionInfo: + type: object + properties: + build_date: + $ref: '#/components/schemas/DateTime' + build_flavor: + type: string + build_hash: + type: string + build_snapshot: + type: boolean + build_type: + type: string + lucene_version: + $ref: '#/components/schemas/VersionString' + minimum_index_compatibility_version: + $ref: '#/components/schemas/VersionString' + minimum_wire_compatibility_version: + $ref: '#/components/schemas/VersionString' + number: + type: string + required: + - build_date + - build_flavor + - build_hash + - build_snapshot + - build_type + - lucene_version + - minimum_index_compatibility_version + - minimum_wire_compatibility_version + - number diff --git a/spec/schemas/_core._common.yaml b/spec/schemas/_core._common.yaml new file mode 100644 index 00000000..adb685ea --- /dev/null +++ b/spec/schemas/_core._common.yaml @@ -0,0 +1,48 @@ +openapi: 3.1.0 +info: + title: Schemas of _core._common category + description: Schemas of _core._common category + version: 1.0.0 +paths: {} +components: + schemas: + DeletedPit: + type: object + properties: + successful: + type: boolean + pit_id: + type: string + PitsDetailsDeleteAll: + type: object + properties: + successful: + type: boolean + pit_id: + type: string + PitDetail: + type: object + properties: + pit_id: + type: string + creation_time: + type: integer + format: int64 + keep_alive: + type: integer + format: int64 + ShardStatistics: + type: object + properties: + total: + type: integer + format: int32 + successful: + type: integer + format: int32 + skipped: + type: integer + format: int32 + failed: + type: integer + format: int32 diff --git a/spec/schemas/_core.bulk.yaml b/spec/schemas/_core.bulk.yaml new file mode 100644 index 00000000..6cfa08f8 --- /dev/null +++ b/spec/schemas/_core.bulk.yaml @@ -0,0 +1,154 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.bulk category + description: Schemas of _core.bulk category + version: 1.0.0 +paths: {} +components: + schemas: + OperationContainer: + type: object + properties: + index: + $ref: '#/components/schemas/IndexOperation' + create: + $ref: '#/components/schemas/CreateOperation' + update: + $ref: '#/components/schemas/UpdateOperation' + delete: + $ref: '#/components/schemas/DeleteOperation' + minProperties: 1 + maxProperties: 1 + IndexOperation: + allOf: + - $ref: '#/components/schemas/WriteOperation' + - type: object + WriteOperation: + allOf: + - $ref: '#/components/schemas/OperationBase' + - type: object + properties: + dynamic_templates: + description: >- + A map from the full name of fields to the name of dynamic templates. + + Defaults to an empty map. + + If a name matches a dynamic template, then that template will be applied regardless of other match predicates defined in the template. + + If a field is already defined in the mapping, then this parameter won’t be used. + type: object + additionalProperties: + type: string + pipeline: + description: >- + ID of the pipeline to use to preprocess incoming documents. + + If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. + + If a final pipeline is configured it will always run, regardless of the value of this parameter. + type: string + require_alias: + description: If `true`, the request’s actions must target an index alias. + type: boolean + OperationBase: + type: object + properties: + _id: + $ref: '_common.yaml#/components/schemas/Id' + _index: + $ref: '_common.yaml#/components/schemas/IndexName' + routing: + $ref: '_common.yaml#/components/schemas/Routing' + if_primary_term: + type: number + if_seq_no: + $ref: '_common.yaml#/components/schemas/SequenceNumber' + version: + $ref: '_common.yaml#/components/schemas/VersionNumber' + version_type: + $ref: '_common.yaml#/components/schemas/VersionType' + CreateOperation: + allOf: + - $ref: '#/components/schemas/WriteOperation' + - type: object + UpdateOperation: + allOf: + - $ref: '#/components/schemas/OperationBase' + - type: object + properties: + require_alias: + description: If `true`, the request’s actions must target an index alias. + type: boolean + retry_on_conflict: + type: number + DeleteOperation: + allOf: + - $ref: '#/components/schemas/OperationBase' + - type: object + UpdateAction: + type: object + properties: + detect_noop: + description: |- + Set to false to disable setting 'result' in the response + to 'noop' if no change to the document occurred. + type: boolean + doc: + description: A partial update to an existing document. + type: object + doc_as_upsert: + description: Set to true to use the contents of 'doc' as the value of 'upsert' + type: boolean + script: + $ref: '_common.yaml#/components/schemas/Script' + scripted_upsert: + description: Set to true to execute the script whether or not the document exists. + type: boolean + _source: + $ref: '_core.search.yaml#/components/schemas/SourceConfig' + upsert: + description: |- + 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. + type: object + ResponseItem: + type: object + properties: + _id: + description: The document ID associated with the operation. + oneOf: + - type: string + - nullable: true + type: string + _index: + description: |- + Name of the index associated with the operation. + If the operation targeted a data stream, this is the backing index into which the document was written. + type: string + status: + description: HTTP status code returned for the operation. + type: number + error: + $ref: '_common.yaml#/components/schemas/ErrorCause' + _primary_term: + description: The primary term assigned to the document for the operation. + type: number + result: + description: |- + Result of the operation. + Successful values are `created`, `deleted`, and `updated`. + type: string + _seq_no: + $ref: '_common.yaml#/components/schemas/SequenceNumber' + _shards: + $ref: '_common.yaml#/components/schemas/ShardStatistics' + _version: + $ref: '_common.yaml#/components/schemas/VersionNumber' + forced_refresh: + type: boolean + get: + $ref: '_common.yaml#/components/schemas/InlineGetDictUserDefined' + required: + - _index + - status diff --git a/spec/schemas/_core.explain.yaml b/spec/schemas/_core.explain.yaml new file mode 100644 index 00000000..c0821a79 --- /dev/null +++ b/spec/schemas/_core.explain.yaml @@ -0,0 +1,37 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.explain category + description: Schemas of _core.explain category + version: 1.0.0 +paths: {} +components: + schemas: + Explanation: + type: object + properties: + description: + type: string + details: + type: array + items: + $ref: '#/components/schemas/ExplanationDetail' + value: + type: number + required: + - description + - details + - value + ExplanationDetail: + type: object + properties: + description: + type: string + details: + type: array + items: + $ref: '#/components/schemas/ExplanationDetail' + value: + type: number + required: + - description + - value diff --git a/spec/schemas/_core.field_caps.yaml b/spec/schemas/_core.field_caps.yaml new file mode 100644 index 00000000..a56005b9 --- /dev/null +++ b/spec/schemas/_core.field_caps.yaml @@ -0,0 +1,53 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.field_caps category + description: Schemas of _core.field_caps category + version: 1.0.0 +paths: {} +components: + schemas: + FieldCapability: + type: object + properties: + aggregatable: + description: Whether this field can be aggregated on all indices. + type: boolean + indices: + $ref: '_common.yaml#/components/schemas/Indices' + meta: + $ref: '_common.yaml#/components/schemas/Metadata' + non_aggregatable_indices: + $ref: '_common.yaml#/components/schemas/Indices' + non_searchable_indices: + $ref: '_common.yaml#/components/schemas/Indices' + searchable: + description: Whether this field is indexed for search on all indices. + type: boolean + type: + type: string + metadata_field: + description: Whether this field is registered as a metadata field. + type: boolean + time_series_dimension: + description: Whether this field is used as a time series dimension. + type: boolean + time_series_metric: + $ref: '_common.mapping.yaml#/components/schemas/TimeSeriesMetricType' + non_dimension_indices: + description: |- + If this list is present in response then some indices have the + field marked as a dimension and other indices, the ones in this list, do not. + type: array + items: + $ref: '_common.yaml#/components/schemas/IndexName' + metric_conflicts_indices: + description: |- + The list of indices where this field is present if these indices + don’t have the same `time_series_metric` value for this field. + type: array + items: + $ref: '_common.yaml#/components/schemas/IndexName' + required: + - aggregatable + - searchable + - type diff --git a/spec/schemas/_core.get.yaml b/spec/schemas/_core.get.yaml new file mode 100644 index 00000000..b676d321 --- /dev/null +++ b/spec/schemas/_core.get.yaml @@ -0,0 +1,35 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.get category + description: Schemas of _core.get category + version: 1.0.0 +paths: {} +components: + schemas: + GetResult: + type: object + properties: + _index: + $ref: '_common.yaml#/components/schemas/IndexName' + fields: + type: object + additionalProperties: + type: object + found: + type: boolean + _id: + $ref: '_common.yaml#/components/schemas/Id' + _primary_term: + type: number + _routing: + type: string + _seq_no: + $ref: '_common.yaml#/components/schemas/SequenceNumber' + _source: + type: object + _version: + $ref: '_common.yaml#/components/schemas/VersionNumber' + required: + - _index + - found + - _id diff --git a/spec/schemas/_core.get_script_context.yaml b/spec/schemas/_core.get_script_context.yaml new file mode 100644 index 00000000..ffc62a06 --- /dev/null +++ b/spec/schemas/_core.get_script_context.yaml @@ -0,0 +1,45 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.get_script_context category + description: Schemas of _core.get_script_context category + version: 1.0.0 +paths: {} +components: + schemas: + Context: + type: object + properties: + methods: + type: array + items: + $ref: '#/components/schemas/ContextMethod' + name: + $ref: '_common.yaml#/components/schemas/Name' + required: + - methods + - name + ContextMethod: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + return_type: + type: string + params: + type: array + items: + $ref: '#/components/schemas/ContextMethodParam' + required: + - name + - return_type + - params + ContextMethodParam: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + type: + type: string + required: + - name + - type diff --git a/spec/schemas/_core.get_script_languages.yaml b/spec/schemas/_core.get_script_languages.yaml new file mode 100644 index 00000000..698c2490 --- /dev/null +++ b/spec/schemas/_core.get_script_languages.yaml @@ -0,0 +1,20 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.get_script_languages category + description: Schemas of _core.get_script_languages category + version: 1.0.0 +paths: {} +components: + schemas: + LanguageContext: + type: object + properties: + contexts: + type: array + items: + type: string + language: + $ref: '_common.yaml#/components/schemas/ScriptLanguage' + required: + - contexts + - language diff --git a/spec/schemas/_core.mget.yaml b/spec/schemas/_core.mget.yaml new file mode 100644 index 00000000..997832e8 --- /dev/null +++ b/spec/schemas/_core.mget.yaml @@ -0,0 +1,44 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.mget category + description: Schemas of _core.mget category + version: 1.0.0 +paths: {} +components: + schemas: + Operation: + type: object + properties: + _id: + $ref: '_common.yaml#/components/schemas/Id' + _index: + $ref: '_common.yaml#/components/schemas/IndexName' + routing: + $ref: '_common.yaml#/components/schemas/Routing' + _source: + $ref: '_core.search.yaml#/components/schemas/SourceConfig' + stored_fields: + $ref: '_common.yaml#/components/schemas/Fields' + version: + $ref: '_common.yaml#/components/schemas/VersionNumber' + version_type: + $ref: '_common.yaml#/components/schemas/VersionType' + required: + - _id + ResponseItem: + oneOf: + - $ref: '_core.get.yaml#/components/schemas/GetResult' + - $ref: '#/components/schemas/MultiGetError' + MultiGetError: + type: object + properties: + error: + $ref: '_common.yaml#/components/schemas/ErrorCause' + _id: + $ref: '_common.yaml#/components/schemas/Id' + _index: + $ref: '_common.yaml#/components/schemas/IndexName' + required: + - error + - _id + - _index diff --git a/spec/schemas/_core.msearch.yaml b/spec/schemas/_core.msearch.yaml new file mode 100644 index 00000000..28906948 --- /dev/null +++ b/spec/schemas/_core.msearch.yaml @@ -0,0 +1,188 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.msearch category + description: Schemas of _core.msearch category + version: 1.0.0 +paths: {} +components: + schemas: + RequestItem: + oneOf: + - $ref: '#/components/schemas/MultisearchHeader' + - $ref: '#/components/schemas/MultisearchBody' + MultisearchHeader: + type: object + properties: + allow_no_indices: + type: boolean + expand_wildcards: + $ref: '_common.yaml#/components/schemas/ExpandWildcards' + ignore_unavailable: + type: boolean + index: + $ref: '_common.yaml#/components/schemas/Indices' + preference: + type: string + request_cache: + type: boolean + routing: + $ref: '_common.yaml#/components/schemas/Routing' + search_type: + $ref: '_common.yaml#/components/schemas/SearchType' + ccs_minimize_roundtrips: + type: boolean + allow_partial_search_results: + type: boolean + ignore_throttled: + type: boolean + MultisearchBody: + type: object + properties: + aggregations: + type: object + additionalProperties: + $ref: '_common.aggregations.yaml#/components/schemas/AggregationContainer' + collapse: + $ref: '_core.search.yaml#/components/schemas/FieldCollapse' + query: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + explain: + description: If true, returns detailed information about score computation as part of a hit. + type: boolean + ext: + description: Configuration of search extensions defined by Opensearch plugins. + type: object + additionalProperties: + type: object + stored_fields: + $ref: '_common.yaml#/components/schemas/Fields' + docvalue_fields: + description: |- + Array of wildcard (*) patterns. The request returns doc values for field + names matching these patterns in the hits.fields property of the response. + type: array + items: + $ref: '_common.query_dsl.yaml#/components/schemas/FieldAndFormat' + knn: + description: Defines the approximate kNN search to run. + oneOf: + - $ref: '_common.yaml#/components/schemas/KnnQuery' + - type: array + items: + $ref: '_common.yaml#/components/schemas/KnnQuery' + from: + description: |- + 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. + type: number + highlight: + $ref: '_core.search.yaml#/components/schemas/Highlight' + indices_boost: + description: Boosts the _score of documents from specified indices. + type: array + items: + type: object + additionalProperties: + type: number + min_score: + description: |- + Minimum _score for matching documents. Documents with a lower _score are + not included in the search results. + type: number + post_filter: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + profile: + type: boolean + rescore: + oneOf: + - $ref: '_core.search.yaml#/components/schemas/Rescore' + - type: array + items: + $ref: '_core.search.yaml#/components/schemas/Rescore' + script_fields: + description: Retrieve a script evaluation (based on different fields) for each hit. + type: object + additionalProperties: + $ref: '_common.yaml#/components/schemas/ScriptField' + search_after: + $ref: '_common.yaml#/components/schemas/SortResults' + size: + description: |- + 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. + type: number + sort: + $ref: '_common.yaml#/components/schemas/Sort' + _source: + $ref: '_core.search.yaml#/components/schemas/SourceConfig' + fields: + description: |- + Array of wildcard (*) patterns. The request returns values for field names + matching these patterns in the hits.fields property of the response. + type: array + items: + $ref: '_common.query_dsl.yaml#/components/schemas/FieldAndFormat' + terminate_after: + description: |- + Maximum number of documents to collect for each shard. If a query reaches this + limit, Opensearch terminates the query early. Opensearch collects documents + before sorting. Defaults to 0, which does not terminate query execution early. + type: number + stats: + description: |- + 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. + type: array + items: + type: string + timeout: + description: |- + 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. + type: string + track_scores: + description: If true, calculate and return document scores, even if the scores are not used for sorting. + type: boolean + track_total_hits: + $ref: '_core.search.yaml#/components/schemas/TrackHits' + version: + description: If true, returns document version as part of a hit. + type: boolean + runtime_mappings: + $ref: '_common.mapping.yaml#/components/schemas/RuntimeFields' + seq_no_primary_term: + description: |- + If true, returns sequence number and primary term of the last modification + of each hit. See Optimistic concurrency control. + type: boolean + pit: + $ref: '_core.search.yaml#/components/schemas/PointInTimeReference' + suggest: + $ref: '_core.search.yaml#/components/schemas/Suggester' + ResponseItem: + oneOf: + - $ref: '#/components/schemas/MultiSearchItem' + - $ref: '_common.yaml#/components/schemas/ErrorResponseBase' + MultiSearchItem: + allOf: + - $ref: '_core.search.yaml#/components/schemas/ResponseBody' + - type: object + properties: + status: + type: number + MultiSearchResult: + type: object + properties: + took: + type: number + responses: + type: array + items: + $ref: '#/components/schemas/ResponseItem' + required: + - took + - responses diff --git a/spec/schemas/_core.msearch_template.yaml b/spec/schemas/_core.msearch_template.yaml new file mode 100644 index 00000000..23a05070 --- /dev/null +++ b/spec/schemas/_core.msearch_template.yaml @@ -0,0 +1,37 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.msearch_template category + description: Schemas of _core.msearch_template category + version: 1.0.0 +paths: {} +components: + schemas: + RequestItem: + oneOf: + - $ref: '_core.msearch.yaml#/components/schemas/MultisearchHeader' + - $ref: '#/components/schemas/TemplateConfig' + TemplateConfig: + type: object + properties: + explain: + description: If `true`, returns detailed information about score calculation as part of each hit. + type: boolean + id: + $ref: '_common.yaml#/components/schemas/Id' + params: + description: |- + Key-value pairs used to replace Mustache variables in the template. + The key is the variable name. + The value is the variable value. + type: object + additionalProperties: + type: object + profile: + description: If `true`, the query execution is profiled. + type: boolean + source: + description: |- + 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. + type: string diff --git a/spec/schemas/_core.mtermvectors.yaml b/spec/schemas/_core.mtermvectors.yaml new file mode 100644 index 00000000..8281b7ad --- /dev/null +++ b/spec/schemas/_core.mtermvectors.yaml @@ -0,0 +1,68 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.mtermvectors category + description: Schemas of _core.mtermvectors category + version: 1.0.0 +paths: {} +components: + schemas: + Operation: + type: object + properties: + _id: + $ref: '_common.yaml#/components/schemas/Id' + _index: + $ref: '_common.yaml#/components/schemas/IndexName' + doc: + description: An artificial document (a document not present in the index) for which you want to retrieve term vectors. + type: object + fields: + $ref: '_common.yaml#/components/schemas/Fields' + field_statistics: + description: If `true`, the response includes the document count, sum of document frequencies, and sum of total term + frequencies. + type: boolean + filter: + $ref: '_core.termvectors.yaml#/components/schemas/Filter' + offsets: + description: If `true`, the response includes term offsets. + type: boolean + payloads: + description: If `true`, the response includes term payloads. + type: boolean + positions: + description: If `true`, the response includes term positions. + type: boolean + routing: + $ref: '_common.yaml#/components/schemas/Routing' + term_statistics: + description: If true, the response includes term frequency and document frequency. + type: boolean + version: + $ref: '_common.yaml#/components/schemas/VersionNumber' + version_type: + $ref: '_common.yaml#/components/schemas/VersionType' + required: + - _id + TermVectorsResult: + type: object + properties: + _id: + $ref: '_common.yaml#/components/schemas/Id' + _index: + $ref: '_common.yaml#/components/schemas/IndexName' + _version: + $ref: '_common.yaml#/components/schemas/VersionNumber' + took: + type: number + found: + type: boolean + term_vectors: + type: object + additionalProperties: + $ref: '_core.termvectors.yaml#/components/schemas/TermVector' + error: + $ref: '_common.yaml#/components/schemas/ErrorCause' + required: + - _id + - _index diff --git a/spec/schemas/_core.rank_eval.yaml b/spec/schemas/_core.rank_eval.yaml new file mode 100644 index 00000000..0367bcee --- /dev/null +++ b/spec/schemas/_core.rank_eval.yaml @@ -0,0 +1,187 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.rank_eval category + description: Schemas of _core.rank_eval category + version: 1.0.0 +paths: {} +components: + schemas: + RankEvalRequestItem: + type: object + properties: + id: + $ref: '_common.yaml#/components/schemas/Id' + request: + $ref: '#/components/schemas/RankEvalQuery' + ratings: + description: List of document ratings + type: array + items: + $ref: '#/components/schemas/DocumentRating' + template_id: + $ref: '_common.yaml#/components/schemas/Id' + params: + description: The search template parameters. + type: object + additionalProperties: + type: object + required: + - id + - ratings + RankEvalQuery: + type: object + properties: + query: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + size: + type: number + required: + - query + DocumentRating: + type: object + properties: + _id: + $ref: '_common.yaml#/components/schemas/Id' + _index: + $ref: '_common.yaml#/components/schemas/IndexName' + rating: + description: The document’s relevance with regard to this search request. + type: number + required: + - _id + - _index + - rating + RankEvalMetric: + type: object + properties: + precision: + $ref: '#/components/schemas/RankEvalMetricPrecision' + recall: + $ref: '#/components/schemas/RankEvalMetricRecall' + mean_reciprocal_rank: + $ref: '#/components/schemas/RankEvalMetricMeanReciprocalRank' + dcg: + $ref: '#/components/schemas/RankEvalMetricDiscountedCumulativeGain' + expected_reciprocal_rank: + $ref: '#/components/schemas/RankEvalMetricExpectedReciprocalRank' + RankEvalMetricPrecision: + allOf: + - $ref: '#/components/schemas/RankEvalMetricRatingTreshold' + - type: object + properties: + ignore_unlabeled: + description: Controls how unlabeled documents in the search results are counted. If set to true, unlabeled documents are + ignored and neither count as relevant or irrelevant. Set to false (the default), they are treated as + irrelevant. + type: boolean + RankEvalMetricRatingTreshold: + allOf: + - $ref: '#/components/schemas/RankEvalMetricBase' + - type: object + properties: + relevant_rating_threshold: + description: Sets the rating threshold above which documents are considered to be "relevant". + type: number + RankEvalMetricBase: + type: object + properties: + k: + description: Sets the maximum number of documents retrieved per query. This value will act in place of the usual size + parameter in the query. + type: number + RankEvalMetricRecall: + allOf: + - $ref: '#/components/schemas/RankEvalMetricRatingTreshold' + - type: object + RankEvalMetricMeanReciprocalRank: + allOf: + - $ref: '#/components/schemas/RankEvalMetricRatingTreshold' + - type: object + RankEvalMetricDiscountedCumulativeGain: + allOf: + - $ref: '#/components/schemas/RankEvalMetricBase' + - type: object + properties: + normalize: + externalDocs: + url: https://en.wikipedia.org/wiki/Discounted_cumulative_gain#Normalized_DCG + description: If set to true, this metric will calculate the Normalized DCG. + type: boolean + RankEvalMetricExpectedReciprocalRank: + allOf: + - $ref: '#/components/schemas/RankEvalMetricBase' + - type: object + properties: + maximum_relevance: + description: The highest relevance grade used in the user-supplied relevance judgments. + type: number + required: + - maximum_relevance + RankEvalMetricDetail: + type: object + properties: + metric_score: + description: The metric_score in the details section shows the contribution of this query to the global quality metric + score + type: number + unrated_docs: + description: The unrated_docs section contains an _index and _id entry for each document in the search result for this + query that didn’t have a ratings value. This can be used to ask the user to supply ratings for these + documents + type: array + items: + $ref: '#/components/schemas/UnratedDocument' + hits: + description: The hits section shows a grouping of the search results with their supplied ratings + type: array + items: + $ref: '#/components/schemas/RankEvalHitItem' + metric_details: + description: The metric_details give additional information about the calculated quality metric (e.g. how many of the + retrieved documents were relevant). The content varies for each metric but allows for better interpretation + of the results + type: object + additionalProperties: + type: object + additionalProperties: + type: object + required: + - metric_score + - unrated_docs + - hits + - metric_details + UnratedDocument: + type: object + properties: + _id: + $ref: '_common.yaml#/components/schemas/Id' + _index: + $ref: '_common.yaml#/components/schemas/IndexName' + required: + - _id + - _index + RankEvalHitItem: + type: object + properties: + hit: + $ref: '#/components/schemas/RankEvalHit' + rating: + oneOf: + - type: number + - nullable: true + type: string + required: + - hit + RankEvalHit: + type: object + properties: + _id: + $ref: '_common.yaml#/components/schemas/Id' + _index: + $ref: '_common.yaml#/components/schemas/IndexName' + _score: + type: number + required: + - _id + - _index + - _score diff --git a/spec/schemas/_core.reindex.yaml b/spec/schemas/_core.reindex.yaml new file mode 100644 index 00000000..ccc9e12c --- /dev/null +++ b/spec/schemas/_core.reindex.yaml @@ -0,0 +1,69 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.reindex category + description: Schemas of _core.reindex category + version: 1.0.0 +paths: {} +components: + schemas: + Destination: + type: object + properties: + index: + $ref: '_common.yaml#/components/schemas/IndexName' + op_type: + $ref: '_common.yaml#/components/schemas/OpType' + pipeline: + description: The name of the pipeline to use. + type: string + routing: + $ref: '_common.yaml#/components/schemas/Routing' + version_type: + $ref: '_common.yaml#/components/schemas/VersionType' + required: + - index + Source: + type: object + properties: + index: + $ref: '_common.yaml#/components/schemas/Indices' + query: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + remote: + $ref: '#/components/schemas/RemoteSource' + size: + description: >- + The number of documents to index per batch. + + Use when indexing from remote to ensure that the batches fit within the on-heap buffer, which defaults to a maximum size of 100 MB. + type: number + slice: + $ref: '_common.yaml#/components/schemas/SlicedScroll' + sort: + $ref: '_common.yaml#/components/schemas/Sort' + _source: + $ref: '_common.yaml#/components/schemas/Fields' + runtime_mappings: + $ref: '_common.mapping.yaml#/components/schemas/RuntimeFields' + required: + - index + RemoteSource: + type: object + properties: + connect_timeout: + $ref: '_common.yaml#/components/schemas/Duration' + headers: + description: An object containing the headers of the request. + type: object + additionalProperties: + type: string + host: + $ref: '_common.yaml#/components/schemas/Host' + username: + $ref: '_common.yaml#/components/schemas/Username' + password: + $ref: '_common.yaml#/components/schemas/Password' + socket_timeout: + $ref: '_common.yaml#/components/schemas/Duration' + required: + - host diff --git a/spec/schemas/_core.reindex_rethrottle.yaml b/spec/schemas/_core.reindex_rethrottle.yaml new file mode 100644 index 00000000..409ce881 --- /dev/null +++ b/spec/schemas/_core.reindex_rethrottle.yaml @@ -0,0 +1,104 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.reindex_rethrottle category + description: Schemas of _core.reindex_rethrottle category + version: 1.0.0 +paths: {} +components: + schemas: + ReindexNode: + allOf: + - $ref: '_common.yaml#/components/schemas/BaseNode' + - type: object + properties: + tasks: + type: object + additionalProperties: + $ref: '#/components/schemas/ReindexTask' + required: + - tasks + ReindexTask: + type: object + properties: + action: + type: string + cancellable: + type: boolean + description: + type: string + id: + type: number + node: + $ref: '_common.yaml#/components/schemas/Name' + running_time_in_nanos: + $ref: '_common.yaml#/components/schemas/DurationValueUnitNanos' + start_time_in_millis: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + status: + $ref: '#/components/schemas/ReindexStatus' + type: + type: string + headers: + $ref: '_common.yaml#/components/schemas/HttpHeaders' + required: + - action + - cancellable + - description + - id + - node + - running_time_in_nanos + - start_time_in_millis + - status + - type + - headers + ReindexStatus: + type: object + properties: + batches: + description: The number of scroll responses pulled back by the reindex. + type: number + created: + description: The number of documents that were successfully created. + type: number + deleted: + description: The number of documents that were successfully deleted. + type: number + noops: + description: The number of documents that were ignored because the script used for the reindex returned a `noop` value + for `ctx.op`. + type: number + requests_per_second: + description: The number of requests per second effectively executed during the reindex. + type: number + retries: + $ref: '_common.yaml#/components/schemas/Retries' + throttled: + $ref: '_common.yaml#/components/schemas/Duration' + throttled_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + throttled_until: + $ref: '_common.yaml#/components/schemas/Duration' + throttled_until_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + total: + description: The number of documents that were successfully processed. + type: number + updated: + description: The number of documents that were successfully updated, for example, a document with same ID already + existed prior to reindex updating it. + type: number + version_conflicts: + description: The number of version conflicts that reindex hits. + type: number + required: + - batches + - created + - deleted + - noops + - requests_per_second + - retries + - throttled_millis + - throttled_until_millis + - total + - updated + - version_conflicts diff --git a/spec/schemas/_core.scripts_painless_execute.yaml b/spec/schemas/_core.scripts_painless_execute.yaml new file mode 100644 index 00000000..9c631c3a --- /dev/null +++ b/spec/schemas/_core.scripts_painless_execute.yaml @@ -0,0 +1,22 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.scripts_painless_execute category + description: Schemas of _core.scripts_painless_execute category + version: 1.0.0 +paths: {} +components: + schemas: + PainlessContextSetup: + type: object + properties: + document: + description: Document that’s temporarily indexed in-memory and accessible from the script. + type: object + index: + $ref: '_common.yaml#/components/schemas/IndexName' + query: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + required: + - document + - index + - query diff --git a/spec/schemas/_core.search.yaml b/spec/schemas/_core.search.yaml new file mode 100644 index 00000000..f108bce5 --- /dev/null +++ b/spec/schemas/_core.search.yaml @@ -0,0 +1,898 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.search category + description: Schemas of _core.search category + version: 1.0.0 +paths: {} +components: + schemas: + HitsMetadata: + type: object + properties: + total: + description: Total hit count information, present only if `track_total_hits` wasn't `false` in the search request. + oneOf: + - $ref: '#/components/schemas/TotalHits' + - type: number + hits: + type: array + items: + $ref: '#/components/schemas/Hit' + max_score: + oneOf: + - type: number + - nullable: true + type: string + required: + - hits + TotalHits: + type: object + properties: + relation: + $ref: '#/components/schemas/TotalHitsRelation' + value: + type: number + required: + - relation + - value + TotalHitsRelation: + type: string + enum: + - eq + - gte + Hit: + type: object + properties: + _index: + $ref: '_common.yaml#/components/schemas/IndexName' + _id: + $ref: '_common.yaml#/components/schemas/Id' + _score: + oneOf: + - type: number + - nullable: true + type: string + _explanation: + $ref: '_core.explain.yaml#/components/schemas/Explanation' + fields: + type: object + additionalProperties: + type: object + highlight: + type: object + additionalProperties: + type: array + items: + type: string + inner_hits: + type: object + additionalProperties: + $ref: '#/components/schemas/InnerHitsResult' + matched_queries: + type: array + items: + type: string + _nested: + $ref: '#/components/schemas/NestedIdentity' + _ignored: + type: array + items: + type: string + ignored_field_values: + type: object + additionalProperties: + type: array + items: + type: string + _shard: + type: string + _node: + type: string + _routing: + type: string + _source: + type: object + _seq_no: + $ref: '_common.yaml#/components/schemas/SequenceNumber' + _primary_term: + type: number + _version: + $ref: '_common.yaml#/components/schemas/VersionNumber' + sort: + $ref: '_common.yaml#/components/schemas/SortResults' + required: + - _index + - _id + InnerHitsResult: + type: object + properties: + hits: + $ref: '#/components/schemas/HitsMetadata' + required: + - hits + NestedIdentity: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + offset: + type: number + _nested: + $ref: '#/components/schemas/NestedIdentity' + required: + - field + - offset + Profile: + type: object + properties: + shards: + type: array + items: + $ref: '#/components/schemas/ShardProfile' + required: + - shards + ShardProfile: + type: object + properties: + aggregations: + type: array + items: + $ref: '#/components/schemas/AggregationProfile' + id: + type: string + searches: + type: array + items: + $ref: '#/components/schemas/SearchProfile' + fetch: + $ref: '#/components/schemas/FetchProfile' + required: + - aggregations + - id + - searches + AggregationProfile: + type: object + properties: + breakdown: + $ref: '#/components/schemas/AggregationBreakdown' + description: + type: string + time_in_nanos: + $ref: '_common.yaml#/components/schemas/DurationValueUnitNanos' + type: + type: string + debug: + $ref: '#/components/schemas/AggregationProfileDebug' + children: + type: array + items: + $ref: '#/components/schemas/AggregationProfile' + required: + - breakdown + - description + - time_in_nanos + - type + AggregationBreakdown: + type: object + properties: + build_aggregation: + type: number + build_aggregation_count: + type: number + build_leaf_collector: + type: number + build_leaf_collector_count: + type: number + collect: + type: number + collect_count: + type: number + initialize: + type: number + initialize_count: + type: number + post_collection: + type: number + post_collection_count: + type: number + reduce: + type: number + reduce_count: + type: number + required: + - build_aggregation + - build_aggregation_count + - build_leaf_collector + - build_leaf_collector_count + - collect + - collect_count + - initialize + - initialize_count + - reduce + - reduce_count + AggregationProfileDebug: + type: object + properties: + segments_with_multi_valued_ords: + type: number + collection_strategy: + type: string + segments_with_single_valued_ords: + type: number + total_buckets: + type: number + built_buckets: + type: number + result_strategy: + type: string + has_filter: + type: boolean + delegate: + type: string + delegate_debug: + $ref: '#/components/schemas/AggregationProfileDebug' + chars_fetched: + type: number + extract_count: + type: number + extract_ns: + type: number + values_fetched: + type: number + collect_analyzed_ns: + type: number + collect_analyzed_count: + type: number + surviving_buckets: + type: number + ordinals_collectors_used: + type: number + ordinals_collectors_overhead_too_high: + type: number + string_hashing_collectors_used: + type: number + numeric_collectors_used: + type: number + empty_collectors_used: + type: number + deferred_aggregators: + type: array + items: + type: string + segments_with_doc_count_field: + type: number + segments_with_deleted_docs: + type: number + filters: + type: array + items: + $ref: '#/components/schemas/AggregationProfileDelegateDebugFilter' + segments_counted: + type: number + segments_collected: + type: number + map_reducer: + type: string + AggregationProfileDelegateDebugFilter: + type: object + properties: + results_from_metadata: + type: number + query: + type: string + specialized_for: + type: string + segments_counted_in_constant_time: + type: number + SearchProfile: + type: object + properties: + collector: + type: array + items: + $ref: '#/components/schemas/Collector' + query: + type: array + items: + $ref: '#/components/schemas/QueryProfile' + rewrite_time: + type: number + required: + - collector + - query + - rewrite_time + Collector: + type: object + properties: + name: + type: string + reason: + type: string + time_in_nanos: + $ref: '_common.yaml#/components/schemas/DurationValueUnitNanos' + children: + type: array + items: + $ref: '#/components/schemas/Collector' + required: + - name + - reason + - time_in_nanos + QueryProfile: + type: object + properties: + breakdown: + $ref: '#/components/schemas/QueryBreakdown' + description: + type: string + time_in_nanos: + $ref: '_common.yaml#/components/schemas/DurationValueUnitNanos' + type: + type: string + children: + type: array + items: + $ref: '#/components/schemas/QueryProfile' + required: + - breakdown + - description + - time_in_nanos + - type + QueryBreakdown: + type: object + properties: + advance: + type: number + advance_count: + type: number + build_scorer: + type: number + build_scorer_count: + type: number + create_weight: + type: number + create_weight_count: + type: number + match: + type: number + match_count: + type: number + shallow_advance: + type: number + shallow_advance_count: + type: number + next_doc: + type: number + next_doc_count: + type: number + score: + type: number + score_count: + type: number + compute_max_score: + type: number + compute_max_score_count: + type: number + set_min_competitive_score: + type: number + set_min_competitive_score_count: + type: number + required: + - advance + - advance_count + - build_scorer + - build_scorer_count + - create_weight + - create_weight_count + - match + - match_count + - shallow_advance + - shallow_advance_count + - next_doc + - next_doc_count + - score + - score_count + - compute_max_score + - compute_max_score_count + - set_min_competitive_score + - set_min_competitive_score_count + FetchProfile: + type: object + properties: + type: + type: string + description: + type: string + time_in_nanos: + $ref: '_common.yaml#/components/schemas/DurationValueUnitNanos' + breakdown: + $ref: '#/components/schemas/FetchProfileBreakdown' + debug: + $ref: '#/components/schemas/FetchProfileDebug' + children: + type: array + items: + $ref: '#/components/schemas/FetchProfile' + required: + - type + - description + - time_in_nanos + - breakdown + FetchProfileBreakdown: + type: object + properties: + load_source: + type: number + load_source_count: + type: number + load_stored_fields: + type: number + load_stored_fields_count: + type: number + next_reader: + type: number + next_reader_count: + type: number + process_count: + type: number + process: + type: number + FetchProfileDebug: + type: object + properties: + stored_fields: + type: array + items: + type: string + fast_path: + type: number + Suggest: + oneOf: + - $ref: '#/components/schemas/CompletionSuggest' + - $ref: '#/components/schemas/PhraseSuggest' + - $ref: '#/components/schemas/TermSuggest' + CompletionSuggest: + allOf: + - $ref: '#/components/schemas/SuggestBase' + - type: object + properties: + options: + oneOf: + - $ref: '#/components/schemas/CompletionSuggestOption' + - type: array + items: + $ref: '#/components/schemas/CompletionSuggestOption' + required: + - options + CompletionSuggestOption: + type: object + properties: + collate_match: + type: boolean + contexts: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/Context' + fields: + type: object + additionalProperties: + type: object + _id: + type: string + _index: + $ref: '_common.yaml#/components/schemas/IndexName' + _routing: + $ref: '_common.yaml#/components/schemas/Routing' + _score: + type: number + _source: + type: object + text: + type: string + score: + type: number + required: + - text + Context: + description: Text or location that we want similar documents for or a lookup to a document's field for the text. + oneOf: + - type: string + - $ref: '_common.yaml#/components/schemas/GeoLocation' + SuggestBase: + type: object + properties: + length: + type: number + offset: + type: number + text: + type: string + required: + - length + - offset + - text + PhraseSuggest: + allOf: + - $ref: '#/components/schemas/SuggestBase' + - type: object + properties: + options: + oneOf: + - $ref: '#/components/schemas/PhraseSuggestOption' + - type: array + items: + $ref: '#/components/schemas/PhraseSuggestOption' + required: + - options + PhraseSuggestOption: + type: object + properties: + text: + type: string + score: + type: number + highlighted: + type: string + collate_match: + type: boolean + required: + - text + - score + TermSuggest: + allOf: + - $ref: '#/components/schemas/SuggestBase' + - type: object + properties: + options: + oneOf: + - $ref: '#/components/schemas/TermSuggestOption' + - type: array + items: + $ref: '#/components/schemas/TermSuggestOption' + required: + - options + TermSuggestOption: + type: object + properties: + text: + type: string + score: + type: number + freq: + type: number + highlighted: + type: string + collate_match: + type: boolean + required: + - text + - score + - freq + TrackHits: + description: |- + 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. + oneOf: + - type: boolean + - type: number + SourceConfigParam: + description: |- + 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. + oneOf: + - type: boolean + - $ref: '_common.yaml#/components/schemas/Fields' + InnerHits: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + size: + description: The maximum number of hits to return per `inner_hits`. + type: number + from: + description: Inner hit starting document offset. + type: number + collapse: + $ref: '#/components/schemas/FieldCollapse' + docvalue_fields: + type: array + items: + $ref: '_common.query_dsl.yaml#/components/schemas/FieldAndFormat' + explain: + type: boolean + highlight: + $ref: '#/components/schemas/Highlight' + ignore_unmapped: + type: boolean + script_fields: + type: object + additionalProperties: + $ref: '_common.yaml#/components/schemas/ScriptField' + seq_no_primary_term: + type: boolean + fields: + $ref: '_common.yaml#/components/schemas/Fields' + sort: + $ref: '_common.yaml#/components/schemas/Sort' + _source: + $ref: '#/components/schemas/SourceConfig' + stored_field: + $ref: '_common.yaml#/components/schemas/Fields' + track_scores: + type: boolean + version: + type: boolean + FieldCollapse: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + inner_hits: + description: The number of inner hits and their sort order + oneOf: + - $ref: '#/components/schemas/InnerHits' + - type: array + items: + $ref: '#/components/schemas/InnerHits' + max_concurrent_group_searches: + description: The number of concurrent requests allowed to retrieve the inner_hits per group + type: number + collapse: + $ref: '#/components/schemas/FieldCollapse' + required: + - field + Highlight: + allOf: + - $ref: '#/components/schemas/HighlightBase' + - type: object + properties: + encoder: + $ref: '#/components/schemas/HighlighterEncoder' + fields: + type: object + additionalProperties: + $ref: '#/components/schemas/HighlightField' + required: + - fields + HighlighterEncoder: + type: string + enum: + - default + - html + HighlightField: + allOf: + - $ref: '#/components/schemas/HighlightBase' + - type: object + properties: + fragment_offset: + type: number + matched_fields: + $ref: '_common.yaml#/components/schemas/Fields' + analyzer: + $ref: '_common.analysis.yaml#/components/schemas/Analyzer' + HighlightBase: + type: object + properties: + type: + $ref: '#/components/schemas/HighlighterType' + boundary_chars: + description: A string that contains each boundary character. + type: string + boundary_max_scan: + description: How far to scan for boundary characters. + type: number + boundary_scanner: + $ref: '#/components/schemas/BoundaryScanner' + boundary_scanner_locale: + description: |- + Controls which locale is used to search for sentence and word boundaries. + This parameter takes a form of a language tag, for example: `"en-US"`, `"fr-FR"`, `"ja-JP"`. + type: string + force_source: + deprecated: true + type: boolean + fragmenter: + $ref: '#/components/schemas/HighlighterFragmenter' + fragment_size: + description: The size of the highlighted fragment in characters. + type: number + highlight_filter: + type: boolean + highlight_query: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + max_fragment_length: + type: number + max_analyzed_offset: + description: >- + If set to a non-negative value, highlighting stops at this defined maximum limit. + + The rest of the text is not processed, thus not highlighted and no error is returned + + The `max_analyzed_offset` query setting does not override the `index.highlight.max_analyzed_offset` setting, which prevails when it’s set to lower value than the query setting. + type: number + no_match_size: + description: The amount of text you want to return from the beginning of the field if there are no matching fragments to + highlight. + type: number + number_of_fragments: + description: >- + The maximum number of fragments to return. + + If the number of fragments is set to `0`, no fragments are returned. + + Instead, the entire field contents are highlighted and returned. + + This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. + + If `number_of_fragments` is `0`, `fragment_size` is ignored. + type: number + options: + type: object + additionalProperties: + type: object + order: + $ref: '#/components/schemas/HighlighterOrder' + phrase_limit: + description: >- + Controls the number of matching phrases in a document that are considered. + + Prevents the `fvh` highlighter from analyzing too many phrases and consuming too much memory. + + When using `matched_fields`, `phrase_limit` phrases per matched field are considered. Raising the limit increases query time and consumes more memory. + + Only supported by the `fvh` highlighter. + type: number + post_tags: + description: |- + Use in conjunction with `pre_tags` to define the HTML tags to use for the highlighted text. + By default, highlighted text is wrapped in `` and `` tags. + type: array + items: + type: string + pre_tags: + description: |- + Use in conjunction with `post_tags` to define the HTML tags to use for the highlighted text. + By default, highlighted text is wrapped in `` and `` tags. + type: array + items: + type: string + require_field_match: + description: |- + By default, only fields that contains a query match are highlighted. + Set to `false` to highlight all fields. + type: boolean + tags_schema: + $ref: '#/components/schemas/HighlighterTagsSchema' + HighlighterType: + type: string + enum: + - plain + - fvh + - unified + BoundaryScanner: + type: string + enum: + - chars + - sentence + - word + HighlighterFragmenter: + type: string + enum: + - simple + - span + HighlighterOrder: + type: string + enum: + - score + HighlighterTagsSchema: + type: string + enum: + - styled + SourceConfig: + description: Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. + oneOf: + - type: boolean + - $ref: '#/components/schemas/SourceFilter' + SourceFilter: + type: object + properties: + excludes: + $ref: '_common.yaml#/components/schemas/Fields' + includes: + $ref: '_common.yaml#/components/schemas/Fields' + Rescore: + type: object + properties: + query: + $ref: '#/components/schemas/RescoreQuery' + window_size: + type: number + required: + - query + RescoreQuery: + type: object + properties: + rescore_query: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + query_weight: + description: Relative importance of the original query versus the rescore query. + type: number + rescore_query_weight: + description: Relative importance of the rescore query versus the original query. + type: number + score_mode: + $ref: '#/components/schemas/ScoreMode' + required: + - rescore_query + ScoreMode: + type: string + enum: + - avg + - max + - min + - multiply + - total + Suggester: + type: object + properties: + text: + description: Global suggest text, to avoid repetition when the same text is used in several suggesters + type: string + PointInTimeReference: + type: object + properties: + id: + $ref: '_common.yaml#/components/schemas/Id' + keep_alive: + $ref: '_common.yaml#/components/schemas/Duration' + required: + - id + ResponseBody: + type: object + properties: + took: + type: number + timed_out: + type: boolean + _shards: + $ref: '_common.yaml#/components/schemas/ShardStatistics' + hits: + $ref: '#/components/schemas/HitsMetadata' + aggregations: + type: object + additionalProperties: + $ref: '_common.aggregations.yaml#/components/schemas/Aggregate' + _clusters: + $ref: '_common.yaml#/components/schemas/ClusterStatistics' + fields: + type: object + additionalProperties: + type: object + max_score: + type: number + num_reduce_phases: + type: number + profile: + $ref: '#/components/schemas/Profile' + pit_id: + $ref: '_common.yaml#/components/schemas/Id' + _scroll_id: + $ref: '_common.yaml#/components/schemas/ScrollId' + suggest: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/Suggest' + terminated_early: + type: boolean + required: + - took + - timed_out + - _shards + - hits diff --git a/spec/schemas/_core.search_shards.yaml b/spec/schemas/_core.search_shards.yaml new file mode 100644 index 00000000..ad83a3f1 --- /dev/null +++ b/spec/schemas/_core.search_shards.yaml @@ -0,0 +1,17 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.search_shards category + description: Schemas of _core.search_shards category + version: 1.0.0 +paths: {} +components: + schemas: + ShardStoreIndex: + type: object + properties: + aliases: + type: array + items: + $ref: '_common.yaml#/components/schemas/Name' + filter: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' diff --git a/spec/schemas/_core.termvectors.yaml b/spec/schemas/_core.termvectors.yaml new file mode 100644 index 00000000..7cca6587 --- /dev/null +++ b/spec/schemas/_core.termvectors.yaml @@ -0,0 +1,93 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.termvectors category + description: Schemas of _core.termvectors category + version: 1.0.0 +paths: {} +components: + schemas: + Filter: + type: object + properties: + max_doc_freq: + description: |- + Ignore words which occur in more than this many docs. + Defaults to unbounded. + type: number + max_num_terms: + description: Maximum number of terms that must be returned per field. + type: number + max_term_freq: + description: |- + Ignore words with more than this frequency in the source doc. + Defaults to unbounded. + type: number + max_word_length: + description: |- + The maximum word length above which words will be ignored. + Defaults to unbounded. + type: number + min_doc_freq: + description: Ignore terms which do not occur in at least this many docs. + type: number + min_term_freq: + description: Ignore words with less than this frequency in the source doc. + type: number + min_word_length: + description: The minimum word length below which words will be ignored. + type: number + TermVector: + type: object + properties: + field_statistics: + $ref: '#/components/schemas/FieldStatistics' + terms: + type: object + additionalProperties: + $ref: '#/components/schemas/Term' + required: + - field_statistics + - terms + FieldStatistics: + type: object + properties: + doc_count: + type: number + sum_doc_freq: + type: number + sum_ttf: + type: number + required: + - doc_count + - sum_doc_freq + - sum_ttf + Term: + type: object + properties: + doc_freq: + type: number + score: + type: number + term_freq: + type: number + tokens: + type: array + items: + $ref: '#/components/schemas/Token' + ttf: + type: number + required: + - term_freq + Token: + type: object + properties: + end_offset: + type: number + payload: + type: string + position: + type: number + start_offset: + type: number + required: + - position diff --git a/spec/schemas/_core.update.yaml b/spec/schemas/_core.update.yaml new file mode 100644 index 00000000..f6a346c7 --- /dev/null +++ b/spec/schemas/_core.update.yaml @@ -0,0 +1,15 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.update category + description: Schemas of _core.update category + version: 1.0.0 +paths: {} +components: + schemas: + UpdateWriteResponseBase: + allOf: + - $ref: '_common.yaml#/components/schemas/WriteResponseBase' + - type: object + properties: + get: + $ref: '_common.yaml#/components/schemas/InlineGet' diff --git a/spec/schemas/_core.update_by_query_rethrottle.yaml b/spec/schemas/_core.update_by_query_rethrottle.yaml new file mode 100644 index 00000000..c91fc4c5 --- /dev/null +++ b/spec/schemas/_core.update_by_query_rethrottle.yaml @@ -0,0 +1,19 @@ +openapi: 3.1.0 +info: + title: Schemas of _core.update_by_query_rethrottle category + description: Schemas of _core.update_by_query_rethrottle category + version: 1.0.0 +paths: {} +components: + schemas: + UpdateByQueryRethrottleNode: + allOf: + - $ref: '_common.yaml#/components/schemas/BaseNode' + - type: object + properties: + tasks: + type: object + additionalProperties: + $ref: 'tasks._common.yaml#/components/schemas/TaskInfo' + required: + - tasks diff --git a/spec/schemas/cat._common.yaml b/spec/schemas/cat._common.yaml new file mode 100644 index 00000000..d455d437 --- /dev/null +++ b/spec/schemas/cat._common.yaml @@ -0,0 +1,92 @@ +openapi: 3.1.0 +info: + title: Schemas of cat._common category + description: Schemas of cat._common category + version: 1.0.0 +paths: {} +components: + schemas: + CatPitSegmentsRecord: + type: object + properties: + index: + type: string + shard: + type: string + prirep: + type: string + ip: + type: string + segment: + type: string + generation: + type: string + docs.count: + type: string + docs.deleted: + type: string + size: + type: string + size.memory: + type: string + committed: + type: string + searchable: + type: string + version: + type: string + compound: + type: string + CatSegmentReplicationRecord: + type: object + properties: + shardId: + type: string + target_node: + type: string + target_host: + type: string + checkpoints_behind: + type: string + bytes_behind: + type: string + current_lag: + type: string + last_completed_lag: + type: string + rejected_requests: + type: string + stage: + type: string + time: + type: string + files_fetched: + type: string + files_percent: + type: string + bytes_fetched: + type: string + bytes_percent: + type: string + start_time: + type: string + stop_time: + type: string + files: + type: string + files_total: + type: string + bytes: + type: string + bytes_total: + type: string + replicating_stage_time_taken: + type: string + get_checkpoint_info_stage_time_taken: + type: string + file_diff_stage_time_taken: + type: string + get_files_stage_time_taken: + type: string + finalize_replication_stage_time_taken: + type: string diff --git a/spec/schemas/cat.aliases.yaml b/spec/schemas/cat.aliases.yaml new file mode 100644 index 00000000..c8edd85d --- /dev/null +++ b/spec/schemas/cat.aliases.yaml @@ -0,0 +1,28 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.aliases category + description: Schemas of cat.aliases category + version: 1.0.0 +paths: {} +components: + schemas: + AliasesRecord: + type: object + properties: + alias: + description: alias name + type: string + index: + $ref: '_common.yaml#/components/schemas/IndexName' + filter: + description: filter + type: string + routing.index: + description: index routing + type: string + routing.search: + description: search routing + type: string + is_write_index: + description: write index + type: string diff --git a/spec/schemas/cat.allocation.yaml b/spec/schemas/cat.allocation.yaml new file mode 100644 index 00000000..5026bbce --- /dev/null +++ b/spec/schemas/cat.allocation.yaml @@ -0,0 +1,72 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.allocation category + description: Schemas of cat.allocation category + version: 1.0.0 +paths: {} +components: + schemas: + AllocationRecord: + type: object + properties: + shards: + description: Number of primary and replica shards assigned to the node. + type: string + disk.indices: + description: >- + Disk space used by the node’s shards. Does not include disk space for the translog or unassigned shards. + + IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index. + oneOf: + - $ref: '_common.yaml#/components/schemas/ByteSize' + - nullable: true + type: string + disk.used: + description: >- + Total disk space in use. + + Opensearch retrieves this metric from the node’s operating system (OS). + + The metric includes disk space for: Opensearch, including the translog and unassigned shards; the node’s operating system; any other applications or files on the node. + + Unlike `disk.indices`, this metric does not double-count disk space for hard-linked files. + oneOf: + - $ref: '_common.yaml#/components/schemas/ByteSize' + - nullable: true + type: string + disk.avail: + description: |- + Free disk space available to Opensearch. + Opensearch retrieves this metric from the node’s operating system. + Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space. + oneOf: + - $ref: '_common.yaml#/components/schemas/ByteSize' + - nullable: true + type: string + disk.total: + description: Total disk space for the node, including in-use and available space. + oneOf: + - $ref: '_common.yaml#/components/schemas/ByteSize' + - nullable: true + type: string + disk.percent: + description: Total percentage of disk space in use. Calculated as `disk.used / disk.total`. + oneOf: + - $ref: '_common.yaml#/components/schemas/Percentage' + - nullable: true + type: string + host: + description: Network host for the node. Set using the `network.host` setting. + oneOf: + - $ref: '_common.yaml#/components/schemas/Host' + - nullable: true + type: string + ip: + description: IP address and port for the node. + oneOf: + - $ref: '_common.yaml#/components/schemas/Ip' + - nullable: true + type: string + node: + description: Name for the node. Set using the `node.name` setting. + type: string diff --git a/spec/schemas/cat.count.yaml b/spec/schemas/cat.count.yaml new file mode 100644 index 00000000..97488a62 --- /dev/null +++ b/spec/schemas/cat.count.yaml @@ -0,0 +1,18 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.count category + description: Schemas of cat.count category + version: 1.0.0 +paths: {} +components: + schemas: + CountRecord: + type: object + properties: + epoch: + $ref: '_common.yaml#/components/schemas/StringifiedEpochTimeUnitSeconds' + timestamp: + $ref: '_common.yaml#/components/schemas/TimeOfDay' + count: + description: the document count + type: string diff --git a/spec/schemas/cat.fielddata.yaml b/spec/schemas/cat.fielddata.yaml new file mode 100644 index 00000000..94dee473 --- /dev/null +++ b/spec/schemas/cat.fielddata.yaml @@ -0,0 +1,29 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.fielddata category + description: Schemas of cat.fielddata category + version: 1.0.0 +paths: {} +components: + schemas: + FielddataRecord: + type: object + properties: + id: + description: node id + type: string + host: + description: host name + type: string + ip: + description: ip address + type: string + node: + description: node name + type: string + field: + description: field name + type: string + size: + description: field data usage + type: string diff --git a/spec/schemas/cat.health.yaml b/spec/schemas/cat.health.yaml new file mode 100644 index 00000000..7b4e4636 --- /dev/null +++ b/spec/schemas/cat.health.yaml @@ -0,0 +1,51 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.health category + description: Schemas of cat.health category + version: 1.0.0 +paths: {} +components: + schemas: + HealthRecord: + type: object + properties: + epoch: + $ref: '_common.yaml#/components/schemas/StringifiedEpochTimeUnitSeconds' + timestamp: + $ref: '_common.yaml#/components/schemas/TimeOfDay' + cluster: + description: cluster name + type: string + status: + description: health status + type: string + node.total: + description: total number of nodes + type: string + node.data: + description: number of nodes that can store data + type: string + shards: + description: total number of shards + type: string + pri: + description: number of primary shards + type: string + relo: + description: number of relocating nodes + type: string + init: + description: number of initializing nodes + type: string + unassign: + description: number of unassigned shards + type: string + pending_tasks: + description: number of pending tasks + type: string + max_task_wait_time: + description: wait time of longest task pending + type: string + active_shards_percent: + description: active number of shards in percent + type: string diff --git a/spec/schemas/cat.help.yaml b/spec/schemas/cat.help.yaml new file mode 100644 index 00000000..0ada833f --- /dev/null +++ b/spec/schemas/cat.help.yaml @@ -0,0 +1,15 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.help category + description: Schemas of cat.help category + version: 1.0.0 +paths: {} +components: + schemas: + HelpRecord: + type: object + properties: + endpoint: + type: string + required: + - endpoint diff --git a/spec/schemas/cat.indices.yaml b/spec/schemas/cat.indices.yaml new file mode 100644 index 00000000..d1fc08bd --- /dev/null +++ b/spec/schemas/cat.indices.yaml @@ -0,0 +1,448 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.indices category + description: Schemas of cat.indices category + version: 1.0.0 +paths: {} +components: + schemas: + IndicesRecord: + type: object + properties: + health: + description: current health status + type: string + status: + description: open/close status + type: string + index: + description: index name + type: string + uuid: + description: index uuid + type: string + pri: + description: number of primary shards + type: string + rep: + description: number of replica shards + type: string + docs.count: + description: available docs + oneOf: + - type: string + - nullable: true + type: string + docs.deleted: + description: deleted docs + oneOf: + - type: string + - nullable: true + type: string + creation.date: + description: index creation date (millisecond value) + type: string + creation.date.string: + description: index creation date (as string) + type: string + store.size: + description: store size of primaries & replicas + oneOf: + - type: string + - nullable: true + type: string + pri.store.size: + description: store size of primaries + oneOf: + - type: string + - nullable: true + type: string + completion.size: + description: size of completion + type: string + pri.completion.size: + description: size of completion + type: string + fielddata.memory_size: + description: used fielddata cache + type: string + pri.fielddata.memory_size: + description: used fielddata cache + type: string + fielddata.evictions: + description: fielddata evictions + type: string + pri.fielddata.evictions: + description: fielddata evictions + type: string + query_cache.memory_size: + description: used query cache + type: string + pri.query_cache.memory_size: + description: used query cache + type: string + query_cache.evictions: + description: query cache evictions + type: string + pri.query_cache.evictions: + description: query cache evictions + type: string + request_cache.memory_size: + description: used request cache + type: string + pri.request_cache.memory_size: + description: used request cache + type: string + request_cache.evictions: + description: request cache evictions + type: string + pri.request_cache.evictions: + description: request cache evictions + type: string + request_cache.hit_count: + description: request cache hit count + type: string + pri.request_cache.hit_count: + description: request cache hit count + type: string + request_cache.miss_count: + description: request cache miss count + type: string + pri.request_cache.miss_count: + description: request cache miss count + type: string + flush.total: + description: number of flushes + type: string + pri.flush.total: + description: number of flushes + type: string + flush.total_time: + description: time spent in flush + type: string + pri.flush.total_time: + description: time spent in flush + type: string + get.current: + description: number of current get ops + type: string + pri.get.current: + description: number of current get ops + type: string + get.time: + description: time spent in get + type: string + pri.get.time: + description: time spent in get + type: string + get.total: + description: number of get ops + type: string + pri.get.total: + description: number of get ops + type: string + get.exists_time: + description: time spent in successful gets + type: string + pri.get.exists_time: + description: time spent in successful gets + type: string + get.exists_total: + description: number of successful gets + type: string + pri.get.exists_total: + description: number of successful gets + type: string + get.missing_time: + description: time spent in failed gets + type: string + pri.get.missing_time: + description: time spent in failed gets + type: string + get.missing_total: + description: number of failed gets + type: string + pri.get.missing_total: + description: number of failed gets + type: string + indexing.delete_current: + description: number of current deletions + type: string + pri.indexing.delete_current: + description: number of current deletions + type: string + indexing.delete_time: + description: time spent in deletions + type: string + pri.indexing.delete_time: + description: time spent in deletions + type: string + indexing.delete_total: + description: number of delete ops + type: string + pri.indexing.delete_total: + description: number of delete ops + type: string + indexing.index_current: + description: number of current indexing ops + type: string + pri.indexing.index_current: + description: number of current indexing ops + type: string + indexing.index_time: + description: time spent in indexing + type: string + pri.indexing.index_time: + description: time spent in indexing + type: string + indexing.index_total: + description: number of indexing ops + type: string + pri.indexing.index_total: + description: number of indexing ops + type: string + indexing.index_failed: + description: number of failed indexing ops + type: string + pri.indexing.index_failed: + description: number of failed indexing ops + type: string + merges.current: + description: number of current merges + type: string + pri.merges.current: + description: number of current merges + type: string + merges.current_docs: + description: number of current merging docs + type: string + pri.merges.current_docs: + description: number of current merging docs + type: string + merges.current_size: + description: size of current merges + type: string + pri.merges.current_size: + description: size of current merges + type: string + merges.total: + description: number of completed merge ops + type: string + pri.merges.total: + description: number of completed merge ops + type: string + merges.total_docs: + description: docs merged + type: string + pri.merges.total_docs: + description: docs merged + type: string + merges.total_size: + description: size merged + type: string + pri.merges.total_size: + description: size merged + type: string + merges.total_time: + description: time spent in merges + type: string + pri.merges.total_time: + description: time spent in merges + type: string + refresh.total: + description: total refreshes + type: string + pri.refresh.total: + description: total refreshes + type: string + refresh.time: + description: time spent in refreshes + type: string + pri.refresh.time: + description: time spent in refreshes + type: string + refresh.external_total: + description: total external refreshes + type: string + pri.refresh.external_total: + description: total external refreshes + type: string + refresh.external_time: + description: time spent in external refreshes + type: string + pri.refresh.external_time: + description: time spent in external refreshes + type: string + refresh.listeners: + description: number of pending refresh listeners + type: string + pri.refresh.listeners: + description: number of pending refresh listeners + type: string + search.fetch_current: + description: current fetch phase ops + type: string + pri.search.fetch_current: + description: current fetch phase ops + type: string + search.fetch_time: + description: time spent in fetch phase + type: string + pri.search.fetch_time: + description: time spent in fetch phase + type: string + search.fetch_total: + description: total fetch ops + type: string + pri.search.fetch_total: + description: total fetch ops + type: string + search.open_contexts: + description: open search contexts + type: string + pri.search.open_contexts: + description: open search contexts + type: string + search.query_current: + description: current query phase ops + type: string + pri.search.query_current: + description: current query phase ops + type: string + search.query_time: + description: time spent in query phase + type: string + pri.search.query_time: + description: time spent in query phase + type: string + search.query_total: + description: total query phase ops + type: string + pri.search.query_total: + description: total query phase ops + type: string + search.scroll_current: + description: open scroll contexts + type: string + pri.search.scroll_current: + description: open scroll contexts + type: string + search.scroll_time: + description: time scroll contexts held open + type: string + pri.search.scroll_time: + description: time scroll contexts held open + type: string + search.scroll_total: + description: completed scroll contexts + type: string + pri.search.scroll_total: + description: completed scroll contexts + type: string + segments.count: + description: number of segments + type: string + pri.segments.count: + description: number of segments + type: string + segments.memory: + description: memory used by segments + type: string + pri.segments.memory: + description: memory used by segments + type: string + segments.index_writer_memory: + description: memory used by index writer + type: string + pri.segments.index_writer_memory: + description: memory used by index writer + type: string + segments.version_map_memory: + description: memory used by version map + type: string + pri.segments.version_map_memory: + description: memory used by version map + type: string + segments.fixed_bitset_memory: + description: memory used by fixed bit sets for nested object field types and export type filters for types referred in + _parent fields + type: string + pri.segments.fixed_bitset_memory: + description: memory used by fixed bit sets for nested object field types and export type filters for types referred in + _parent fields + type: string + warmer.current: + description: current warmer ops + type: string + pri.warmer.current: + description: current warmer ops + type: string + warmer.total: + description: total warmer ops + type: string + pri.warmer.total: + description: total warmer ops + type: string + warmer.total_time: + description: time spent in warmers + type: string + pri.warmer.total_time: + description: time spent in warmers + type: string + suggest.current: + description: number of current suggest ops + type: string + pri.suggest.current: + description: number of current suggest ops + type: string + suggest.time: + description: time spend in suggest + type: string + pri.suggest.time: + description: time spend in suggest + type: string + suggest.total: + description: number of suggest ops + type: string + pri.suggest.total: + description: number of suggest ops + type: string + memory.total: + description: total used memory + type: string + pri.memory.total: + description: total user memory + type: string + search.throttled: + description: indicates if the index is search throttled + type: string + bulk.total_operations: + description: number of bulk shard ops + type: string + pri.bulk.total_operations: + description: number of bulk shard ops + type: string + bulk.total_time: + description: time spend in shard bulk + type: string + pri.bulk.total_time: + description: time spend in shard bulk + type: string + bulk.total_size_in_bytes: + description: total size in bytes of shard bulk + type: string + pri.bulk.total_size_in_bytes: + description: total size in bytes of shard bulk + type: string + bulk.avg_time: + description: average time spend in shard bulk + type: string + pri.bulk.avg_time: + description: average time spend in shard bulk + type: string + bulk.avg_size_in_bytes: + description: average size in bytes of shard bulk + type: string + pri.bulk.avg_size_in_bytes: + description: average size in bytes of shard bulk + type: string diff --git a/spec/schemas/cat.master.yaml b/spec/schemas/cat.master.yaml new file mode 100644 index 00000000..3dd491d1 --- /dev/null +++ b/spec/schemas/cat.master.yaml @@ -0,0 +1,23 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.master category + description: Schemas of cat.master category + version: 1.0.0 +paths: {} +components: + schemas: + MasterRecord: + type: object + properties: + id: + description: node id + type: string + host: + description: host name + type: string + ip: + description: ip address + type: string + node: + description: node name + type: string diff --git a/spec/schemas/cat.nodeattrs.yaml b/spec/schemas/cat.nodeattrs.yaml new file mode 100644 index 00000000..81506fc6 --- /dev/null +++ b/spec/schemas/cat.nodeattrs.yaml @@ -0,0 +1,35 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.nodeattrs category + description: Schemas of cat.nodeattrs category + version: 1.0.0 +paths: {} +components: + schemas: + NodeAttributesRecord: + type: object + properties: + node: + description: The node name. + type: string + id: + description: The unique node identifier. + type: string + pid: + description: The process identifier. + type: string + host: + description: The host name. + type: string + ip: + description: The IP address. + type: string + port: + description: The bound transport port. + type: string + attr: + description: The attribute name. + type: string + value: + description: The attribute value. + type: string diff --git a/spec/schemas/cat.nodes.yaml b/spec/schemas/cat.nodes.yaml new file mode 100644 index 00000000..af83ec51 --- /dev/null +++ b/spec/schemas/cat.nodes.yaml @@ -0,0 +1,295 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.nodes category + description: Schemas of cat.nodes category + version: 1.0.0 +paths: {} +components: + schemas: + NodesRecord: + type: object + properties: + id: + $ref: '_common.yaml#/components/schemas/Id' + pid: + description: The process identifier. + type: string + ip: + description: The IP address. + type: string + port: + description: The bound transport port. + type: string + http_address: + description: The bound HTTP address. + type: string + version: + $ref: '_common.yaml#/components/schemas/VersionString' + flavor: + description: The Opensearch distribution flavor. + type: string + type: + description: The Opensearch distribution type. + type: string + build: + description: The Opensearch build hash. + type: string + jdk: + description: The Java version. + type: string + disk.total: + $ref: '_common.yaml#/components/schemas/ByteSize' + disk.used: + $ref: '_common.yaml#/components/schemas/ByteSize' + disk.avail: + $ref: '_common.yaml#/components/schemas/ByteSize' + disk.used_percent: + $ref: '_common.yaml#/components/schemas/Percentage' + heap.current: + description: The used heap. + type: string + heap.percent: + $ref: '_common.yaml#/components/schemas/Percentage' + heap.max: + description: The maximum configured heap. + type: string + ram.current: + description: The used machine memory. + type: string + ram.percent: + $ref: '_common.yaml#/components/schemas/Percentage' + ram.max: + description: The total machine memory. + type: string + file_desc.current: + description: The used file descriptors. + type: string + file_desc.percent: + $ref: '_common.yaml#/components/schemas/Percentage' + file_desc.max: + description: The maximum number of file descriptors. + type: string + cpu: + description: The recent system CPU usage as a percentage. + type: string + load_1m: + description: The load average for the most recent minute. + type: string + load_5m: + description: The load average for the last five minutes. + type: string + load_15m: + description: The load average for the last fifteen minutes. + type: string + uptime: + description: The node uptime. + type: string + node.role: + description: >- + The roles of the node. + + Returned values include `c`(cold node), `d`(data node), `f`(frozen node), `h`(hot node), `i`(ingest node), `l`(machine learning node), `m` (master eligible node), `r`(remote cluster client node), `s`(content node), `t`(transform node), `v`(voting-only node), `w`(warm node),and `-`(coordinating node only). + type: string + master: + description: |- + Indicates whether the node is the elected master node. + Returned values include `*`(elected master) and `-`(not elected master). + type: string + name: + $ref: '_common.yaml#/components/schemas/Name' + completion.size: + description: The size of completion. + type: string + fielddata.memory_size: + description: The used fielddata cache. + type: string + fielddata.evictions: + description: The fielddata evictions. + type: string + query_cache.memory_size: + description: The used query cache. + type: string + query_cache.evictions: + description: The query cache evictions. + type: string + query_cache.hit_count: + description: The query cache hit counts. + type: string + query_cache.miss_count: + description: The query cache miss counts. + type: string + request_cache.memory_size: + description: The used request cache. + type: string + request_cache.evictions: + description: The request cache evictions. + type: string + request_cache.hit_count: + description: The request cache hit counts. + type: string + request_cache.miss_count: + description: The request cache miss counts. + type: string + flush.total: + description: The number of flushes. + type: string + flush.total_time: + description: The time spent in flush. + type: string + get.current: + description: The number of current get ops. + type: string + get.time: + description: The time spent in get. + type: string + get.total: + description: The number of get ops. + type: string + get.exists_time: + description: The time spent in successful gets. + type: string + get.exists_total: + description: The number of successful get operations. + type: string + get.missing_time: + description: The time spent in failed gets. + type: string + get.missing_total: + description: The number of failed gets. + type: string + indexing.delete_current: + description: The number of current deletions. + type: string + indexing.delete_time: + description: The time spent in deletions. + type: string + indexing.delete_total: + description: The number of delete operations. + type: string + indexing.index_current: + description: The number of current indexing operations. + type: string + indexing.index_time: + description: The time spent in indexing. + type: string + indexing.index_total: + description: The number of indexing operations. + type: string + indexing.index_failed: + description: The number of failed indexing operations. + type: string + merges.current: + description: The number of current merges. + type: string + merges.current_docs: + description: The number of current merging docs. + type: string + merges.current_size: + description: The size of current merges. + type: string + merges.total: + description: The number of completed merge operations. + type: string + merges.total_docs: + description: The docs merged. + type: string + merges.total_size: + description: The size merged. + type: string + merges.total_time: + description: The time spent in merges. + type: string + refresh.total: + description: The total refreshes. + type: string + refresh.time: + description: The time spent in refreshes. + type: string + refresh.external_total: + description: The total external refreshes. + type: string + refresh.external_time: + description: The time spent in external refreshes. + type: string + refresh.listeners: + description: The number of pending refresh listeners. + type: string + script.compilations: + description: The total script compilations. + type: string + script.cache_evictions: + description: The total compiled scripts evicted from the cache. + type: string + script.compilation_limit_triggered: + description: The script cache compilation limit triggered. + type: string + search.fetch_current: + description: The current fetch phase operations. + type: string + search.fetch_time: + description: The time spent in fetch phase. + type: string + search.fetch_total: + description: The total fetch operations. + type: string + search.open_contexts: + description: The open search contexts. + type: string + search.query_current: + description: The current query phase operations. + type: string + search.query_time: + description: The time spent in query phase. + type: string + search.query_total: + description: The total query phase operations. + type: string + search.scroll_current: + description: The open scroll contexts. + type: string + search.scroll_time: + description: The time scroll contexts held open. + type: string + search.scroll_total: + description: The completed scroll contexts. + type: string + segments.count: + description: The number of segments. + type: string + segments.memory: + description: The memory used by segments. + type: string + segments.index_writer_memory: + description: The memory used by the index writer. + type: string + segments.version_map_memory: + description: The memory used by the version map. + type: string + segments.fixed_bitset_memory: + description: The memory used by fixed bit sets for nested object field types and export type filters for types referred + in _parent fields. + type: string + suggest.current: + description: The number of current suggest operations. + type: string + suggest.time: + description: The time spend in suggest. + type: string + suggest.total: + description: The number of suggest operations. + type: string + bulk.total_operations: + description: The number of bulk shard operations. + type: string + bulk.total_time: + description: The time spend in shard bulk. + type: string + bulk.total_size_in_bytes: + description: The total size in bytes of shard bulk. + type: string + bulk.avg_time: + description: The average time spend in shard bulk. + type: string + bulk.avg_size_in_bytes: + description: The average size in bytes of shard bulk. + type: string diff --git a/spec/schemas/cat.pending_tasks.yaml b/spec/schemas/cat.pending_tasks.yaml new file mode 100644 index 00000000..41e98293 --- /dev/null +++ b/spec/schemas/cat.pending_tasks.yaml @@ -0,0 +1,23 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.pending_tasks category + description: Schemas of cat.pending_tasks category + version: 1.0.0 +paths: {} +components: + schemas: + PendingTasksRecord: + type: object + properties: + insertOrder: + description: The task insertion order. + type: string + timeInQueue: + description: Indicates how long the task has been in queue. + type: string + priority: + description: The task priority. + type: string + source: + description: The task source. + type: string diff --git a/spec/schemas/cat.plugins.yaml b/spec/schemas/cat.plugins.yaml new file mode 100644 index 00000000..3e470dff --- /dev/null +++ b/spec/schemas/cat.plugins.yaml @@ -0,0 +1,26 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.plugins category + description: Schemas of cat.plugins category + version: 1.0.0 +paths: {} +components: + schemas: + PluginsRecord: + type: object + properties: + id: + $ref: '_common.yaml#/components/schemas/NodeId' + name: + $ref: '_common.yaml#/components/schemas/Name' + component: + description: The component name. + type: string + version: + $ref: '_common.yaml#/components/schemas/VersionString' + description: + description: The plugin details. + type: string + type: + description: The plugin type. + type: string diff --git a/spec/schemas/cat.recovery.yaml b/spec/schemas/cat.recovery.yaml new file mode 100644 index 00000000..3b9d8bd1 --- /dev/null +++ b/spec/schemas/cat.recovery.yaml @@ -0,0 +1,80 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.recovery category + description: Schemas of cat.recovery category + version: 1.0.0 +paths: {} +components: + schemas: + RecoveryRecord: + type: object + properties: + index: + $ref: '_common.yaml#/components/schemas/IndexName' + shard: + description: The shard name. + type: string + start_time: + $ref: '_common.yaml#/components/schemas/DateTime' + start_time_millis: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + stop_time: + $ref: '_common.yaml#/components/schemas/DateTime' + stop_time_millis: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + time: + $ref: '_common.yaml#/components/schemas/Duration' + type: + description: The recovery type. + type: string + stage: + description: The recovery stage. + type: string + source_host: + description: The source host. + type: string + source_node: + description: The source node name. + type: string + target_host: + description: The target host. + type: string + target_node: + description: The target node name. + type: string + repository: + description: The repository name. + type: string + snapshot: + description: The snapshot name. + type: string + files: + description: The number of files to recover. + type: string + files_recovered: + description: The files recovered. + type: string + files_percent: + $ref: '_common.yaml#/components/schemas/Percentage' + files_total: + description: The total number of files. + type: string + bytes: + description: The number of bytes to recover. + type: string + bytes_recovered: + description: The bytes recovered. + type: string + bytes_percent: + $ref: '_common.yaml#/components/schemas/Percentage' + bytes_total: + description: The total number of bytes. + type: string + translog_ops: + description: The number of translog operations to recover. + type: string + translog_ops_recovered: + description: The translog operations recovered. + type: string + translog_ops_percent: + $ref: '_common.yaml#/components/schemas/Percentage' diff --git a/spec/schemas/cat.repositories.yaml b/spec/schemas/cat.repositories.yaml new file mode 100644 index 00000000..c7163972 --- /dev/null +++ b/spec/schemas/cat.repositories.yaml @@ -0,0 +1,17 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.repositories category + description: Schemas of cat.repositories category + version: 1.0.0 +paths: {} +components: + schemas: + RepositoriesRecord: + type: object + properties: + id: + description: The unique repository identifier. + type: string + type: + description: The repository type. + type: string diff --git a/spec/schemas/cat.segments.yaml b/spec/schemas/cat.segments.yaml new file mode 100644 index 00000000..bbc9ff54 --- /dev/null +++ b/spec/schemas/cat.segments.yaml @@ -0,0 +1,75 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.segments category + description: Schemas of cat.segments category + version: 1.0.0 +paths: {} +components: + schemas: + SegmentsRecord: + type: object + properties: + index: + $ref: '_common.yaml#/components/schemas/IndexName' + shard: + description: The shard name. + type: string + prirep: + description: 'The shard type: `primary` or `replica`.' + type: string + ip: + description: The IP address of the node where it lives. + type: string + id: + $ref: '_common.yaml#/components/schemas/NodeId' + segment: + description: The segment name, which is derived from the segment generation and used internally to create file names in + the directory of the shard. + type: string + generation: + description: >- + The segment generation number. + + Opensearch increments this generation number for each segment written then uses this number to derive the segment name. + type: string + docs.count: + description: |- + The number of documents in the segment. + This excludes deleted documents and counts any nested documents separately from their parents. + It also excludes documents which were indexed recently and do not yet belong to a segment. + type: string + docs.deleted: + description: >- + The number of deleted documents in the segment, which might be higher or lower than the number of delete + operations you have performed. + + This number excludes deletes that were performed recently and do not yet belong to a segment. + + Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. + + Also, Opensearch creates extra deleted documents to internally track the recent history of operations on a shard. + type: string + size: + $ref: '_common.yaml#/components/schemas/ByteSize' + size.memory: + $ref: '_common.yaml#/components/schemas/ByteSize' + committed: + description: >- + If `true`, the segment is synced to disk. + + Segments that are synced can survive a hard reboot. + + If `false`, the data from uncommitted segments is also stored in the transaction log so that Opensearch is able to replay changes on the next start. + type: string + searchable: + description: |- + If `true`, the segment is searchable. + If `false`, the segment has most likely been written to disk but needs a refresh to be searchable. + type: string + version: + $ref: '_common.yaml#/components/schemas/VersionString' + compound: + description: |- + If `true`, the segment is stored in a compound file. + This means Lucene merged all files from the segment in a single file to save file descriptors. + type: string diff --git a/spec/schemas/cat.shards.yaml b/spec/schemas/cat.shards.yaml new file mode 100644 index 00000000..8e48eaca --- /dev/null +++ b/spec/schemas/cat.shards.yaml @@ -0,0 +1,300 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.shards category + description: Schemas of cat.shards category + version: 1.0.0 +paths: {} +components: + schemas: + ShardsRecord: + type: object + properties: + index: + description: The index name. + type: string + shard: + description: The shard name. + type: string + prirep: + description: 'The shard type: `primary` or `replica`.' + type: string + state: + description: |- + The shard state. + Returned values include: + `INITIALIZING`: The shard is recovering from a peer shard or gateway. + `RELOCATING`: The shard is relocating. + `STARTED`: The shard has started. + `UNASSIGNED`: The shard is not assigned to any node. + type: string + docs: + description: The number of documents in the shard. + oneOf: + - type: string + - nullable: true + type: string + store: + description: The disk space used by the shard. + oneOf: + - type: string + - nullable: true + type: string + ip: + description: The IP address of the node. + oneOf: + - type: string + - nullable: true + type: string + id: + description: The unique identifier for the node. + type: string + node: + description: The name of node. + oneOf: + - type: string + - nullable: true + type: string + sync_id: + description: The sync identifier. + type: string + unassigned.reason: + description: >- + The reason for the last change to the state of an unassigned shard. + + It does not explain why the shard is currently unassigned; use the cluster allocation explain API for that information. + + Returned values include: + + `ALLOCATION_FAILED`: Unassigned as a result of a failed allocation of the shard. + + `CLUSTER_RECOVERED`: Unassigned as a result of a full cluster recovery. + + `DANGLING_INDEX_IMPORTED`: Unassigned as a result of importing a dangling index. + + `EXISTING_INDEX_RESTORED`: Unassigned as a result of restoring into a closed index. + + `FORCED_EMPTY_PRIMARY`: The shard’s allocation was last modified by forcing an empty primary using the cluster reroute API. + + `INDEX_CLOSED`: Unassigned because the index was closed. + + `INDEX_CREATED`: Unassigned as a result of an API creation of an index. + + `INDEX_REOPENED`: Unassigned as a result of opening a closed index. + + `MANUAL_ALLOCATION`: The shard’s allocation was last modified by the cluster reroute API. + + `NEW_INDEX_RESTORED`: Unassigned as a result of restoring into a new index. + + `NODE_LEFT`: Unassigned as a result of the node hosting it leaving the cluster. + + `NODE_RESTARTING`: Similar to `NODE_LEFT`, except that the node was registered as restarting using the node shutdown API. + + `PRIMARY_FAILED`: The shard was initializing as a replica, but the primary shard failed before the initialization completed. + + `REALLOCATED_REPLICA`: A better replica location is identified and causes the existing replica allocation to be cancelled. + + `REINITIALIZED`: When a shard moves from started back to initializing. + + `REPLICA_ADDED`: Unassigned as a result of explicit addition of a replica. + + `REROUTE_CANCELLED`: Unassigned as a result of explicit cancel reroute command. + type: string + unassigned.at: + description: The time at which the shard became unassigned in Coordinated Universal Time (UTC). + type: string + unassigned.for: + description: The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC). + type: string + unassigned.details: + description: >- + Additional details as to why the shard became unassigned. + + It does not explain why the shard is not assigned; use the cluster allocation explain API for that information. + type: string + recoverysource.type: + description: The type of recovery source. + type: string + completion.size: + description: The size of completion. + type: string + fielddata.memory_size: + description: The used fielddata cache memory. + type: string + fielddata.evictions: + description: The fielddata cache evictions. + type: string + query_cache.memory_size: + description: The used query cache memory. + type: string + query_cache.evictions: + description: The query cache evictions. + type: string + flush.total: + description: The number of flushes. + type: string + flush.total_time: + description: The time spent in flush. + type: string + get.current: + description: The number of current get operations. + type: string + get.time: + description: The time spent in get operations. + type: string + get.total: + description: The number of get operations. + type: string + get.exists_time: + description: The time spent in successful get operations. + type: string + get.exists_total: + description: The number of successful get operations. + type: string + get.missing_time: + description: The time spent in failed get operations. + type: string + get.missing_total: + description: The number of failed get operations. + type: string + indexing.delete_current: + description: The number of current deletion operations. + type: string + indexing.delete_time: + description: The time spent in deletion operations. + type: string + indexing.delete_total: + description: The number of delete operations. + type: string + indexing.index_current: + description: The number of current indexing operations. + type: string + indexing.index_time: + description: The time spent in indexing operations. + type: string + indexing.index_total: + description: The number of indexing operations. + type: string + indexing.index_failed: + description: The number of failed indexing operations. + type: string + merges.current: + description: The number of current merge operations. + type: string + merges.current_docs: + description: The number of current merging documents. + type: string + merges.current_size: + description: The size of current merge operations. + type: string + merges.total: + description: The number of completed merge operations. + type: string + merges.total_docs: + description: The nuber of merged documents. + type: string + merges.total_size: + description: The size of current merges. + type: string + merges.total_time: + description: The time spent merging documents. + type: string + refresh.total: + description: The total number of refreshes. + type: string + refresh.time: + description: The time spent in refreshes. + type: string + refresh.external_total: + description: The total nunber of external refreshes. + type: string + refresh.external_time: + description: The time spent in external refreshes. + type: string + refresh.listeners: + description: The number of pending refresh listeners. + type: string + search.fetch_current: + description: The current fetch phase operations. + type: string + search.fetch_time: + description: The time spent in fetch phase. + type: string + search.fetch_total: + description: The total number of fetch operations. + type: string + search.open_contexts: + description: The number of open search contexts. + type: string + search.query_current: + description: The current query phase operations. + type: string + search.query_time: + description: The time spent in query phase. + type: string + search.query_total: + description: The total number of query phase operations. + type: string + search.scroll_current: + description: The open scroll contexts. + type: string + search.scroll_time: + description: The time scroll contexts were held open. + type: string + search.scroll_total: + description: The number of completed scroll contexts. + type: string + segments.count: + description: The number of segments. + type: string + segments.memory: + description: The memory used by segments. + type: string + segments.index_writer_memory: + description: The memory used by the index writer. + type: string + segments.version_map_memory: + description: The memory used by the version map. + type: string + segments.fixed_bitset_memory: + description: The memory used by fixed bit sets for nested object field types and export type filters for types referred + in `_parent` fields. + type: string + seq_no.max: + description: The maximum sequence number. + type: string + seq_no.local_checkpoint: + description: The local checkpoint. + type: string + seq_no.global_checkpoint: + description: The global checkpoint. + type: string + warmer.current: + description: The number of current warmer operations. + type: string + warmer.total: + description: The total number of warmer operations. + type: string + warmer.total_time: + description: The time spent in warmer operations. + type: string + path.data: + description: The shard data path. + type: string + path.state: + description: The shard state path. + type: string + bulk.total_operations: + description: The number of bulk shard operations. + type: string + bulk.total_time: + description: The time spent in shard bulk operations. + type: string + bulk.total_size_in_bytes: + description: The total size in bytes of shard bulk operations. + type: string + bulk.avg_time: + description: The average time spent in shard bulk operations. + type: string + bulk.avg_size_in_bytes: + description: The average size in bytes of shard bulk operations. + type: string diff --git a/spec/schemas/cat.snapshots.yaml b/spec/schemas/cat.snapshots.yaml new file mode 100644 index 00000000..af46e1ba --- /dev/null +++ b/spec/schemas/cat.snapshots.yaml @@ -0,0 +1,52 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.snapshots category + description: Schemas of cat.snapshots category + version: 1.0.0 +paths: {} +components: + schemas: + SnapshotsRecord: + type: object + properties: + id: + description: The unique identifier for the snapshot. + type: string + repository: + description: The repository name. + type: string + status: + description: |- + The state of the snapshot process. + Returned values include: + `FAILED`: The snapshot process failed. + `INCOMPATIBLE`: The snapshot process is incompatible with the current cluster version. + `IN_PROGRESS`: The snapshot process started but has not completed. + `PARTIAL`: The snapshot process completed with a partial success. + `SUCCESS`: The snapshot process completed with a full success. + type: string + start_epoch: + $ref: '_common.yaml#/components/schemas/StringifiedEpochTimeUnitSeconds' + start_time: + $ref: '_common.yaml#/components/schemas/ScheduleTimeOfDay' + end_epoch: + $ref: '_common.yaml#/components/schemas/StringifiedEpochTimeUnitSeconds' + end_time: + $ref: '_common.yaml#/components/schemas/TimeOfDay' + duration: + $ref: '_common.yaml#/components/schemas/Duration' + indices: + description: The number of indices in the snapshot. + type: string + successful_shards: + description: The number of successful shards in the snapshot. + type: string + failed_shards: + description: The number of failed shards in the snapshot. + type: string + total_shards: + description: The total number of shards in the snapshot. + type: string + reason: + description: The reason for any snapshot failures. + type: string diff --git a/spec/schemas/cat.tasks.yaml b/spec/schemas/cat.tasks.yaml new file mode 100644 index 00000000..ce54f2c5 --- /dev/null +++ b/spec/schemas/cat.tasks.yaml @@ -0,0 +1,55 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.tasks category + description: Schemas of cat.tasks category + version: 1.0.0 +paths: {} +components: + schemas: + TasksRecord: + type: object + properties: + id: + $ref: '_common.yaml#/components/schemas/Id' + action: + description: The task action. + type: string + task_id: + $ref: '_common.yaml#/components/schemas/Id' + parent_task_id: + description: The parent task identifier. + type: string + type: + description: The task type. + type: string + start_time: + description: The start time in milliseconds. + type: string + timestamp: + description: The start time in `HH:MM:SS` format. + type: string + running_time_ns: + description: The running time in nanoseconds. + type: string + running_time: + description: The running time. + type: string + node_id: + $ref: '_common.yaml#/components/schemas/NodeId' + ip: + description: The IP address for the node. + type: string + port: + description: The bound transport port for the node. + type: string + node: + description: The node name. + type: string + version: + $ref: '_common.yaml#/components/schemas/VersionString' + x_opaque_id: + description: The X-Opaque-ID header. + type: string + description: + description: The task action description. + type: string diff --git a/spec/schemas/cat.templates.yaml b/spec/schemas/cat.templates.yaml new file mode 100644 index 00000000..aab5d128 --- /dev/null +++ b/spec/schemas/cat.templates.yaml @@ -0,0 +1,28 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.templates category + description: Schemas of cat.templates category + version: 1.0.0 +paths: {} +components: + schemas: + TemplatesRecord: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + index_patterns: + description: The template index patterns. + type: string + order: + description: The template application order or priority number. + type: string + version: + description: The template version. + oneOf: + - $ref: '_common.yaml#/components/schemas/VersionString' + - nullable: true + type: string + composed_of: + description: The component templates that comprise the index template. + type: string diff --git a/spec/schemas/cat.thread_pool.yaml b/spec/schemas/cat.thread_pool.yaml new file mode 100644 index 00000000..759ecf7b --- /dev/null +++ b/spec/schemas/cat.thread_pool.yaml @@ -0,0 +1,84 @@ +openapi: 3.1.0 +info: + title: Schemas of cat.thread_pool category + description: Schemas of cat.thread_pool category + version: 1.0.0 +paths: {} +components: + schemas: + ThreadPoolRecord: + type: object + properties: + node_name: + description: The node name. + type: string + node_id: + $ref: '_common.yaml#/components/schemas/NodeId' + ephemeral_node_id: + description: The ephemeral node identifier. + type: string + pid: + description: The process identifier. + type: string + host: + description: The host name for the current node. + type: string + ip: + description: The IP address for the current node. + type: string + port: + description: The bound transport port for the current node. + type: string + name: + description: The thread pool name. + type: string + type: + description: |- + The thread pool type. + Returned values include `fixed`, `fixed_auto_queue_size`, `direct`, and `scaling`. + type: string + active: + description: The number of active threads in the current thread pool. + type: string + pool_size: + description: The number of threads in the current thread pool. + type: string + queue: + description: The number of tasks currently in queue. + type: string + queue_size: + description: The maximum number of tasks permitted in the queue. + type: string + rejected: + description: The number of rejected tasks. + type: string + largest: + description: The highest number of active threads in the current thread pool. + type: string + completed: + description: The number of completed tasks. + type: string + core: + description: The core number of active threads allowed in a scaling thread pool. + oneOf: + - type: string + - nullable: true + type: string + max: + description: The maximum number of active threads allowed in a scaling thread pool. + oneOf: + - type: string + - nullable: true + type: string + size: + description: The number of active threads allowed in a fixed thread pool. + oneOf: + - type: string + - nullable: true + type: string + keep_alive: + description: The thread keep alive time. + oneOf: + - type: string + - nullable: true + type: string diff --git a/spec/schemas/cluster._common.yaml b/spec/schemas/cluster._common.yaml new file mode 100644 index 00000000..5d708595 --- /dev/null +++ b/spec/schemas/cluster._common.yaml @@ -0,0 +1,48 @@ +openapi: 3.1.0 +info: + title: Schemas of cluster._common category + description: Schemas of cluster._common category + version: 1.0.0 +paths: {} +components: + schemas: + ComponentTemplate: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + component_template: + $ref: '#/components/schemas/ComponentTemplateNode' + required: + - name + - component_template + ComponentTemplateNode: + type: object + properties: + template: + $ref: '#/components/schemas/ComponentTemplateSummary' + version: + $ref: '_common.yaml#/components/schemas/VersionNumber' + _meta: + $ref: '_common.yaml#/components/schemas/Metadata' + required: + - template + ComponentTemplateSummary: + type: object + properties: + _meta: + $ref: '_common.yaml#/components/schemas/Metadata' + version: + $ref: '_common.yaml#/components/schemas/VersionNumber' + settings: + type: object + additionalProperties: + $ref: 'indices._common.yaml#/components/schemas/IndexSettings' + mappings: + $ref: '_common.mapping.yaml#/components/schemas/TypeMapping' + aliases: + type: object + additionalProperties: + $ref: 'indices._common.yaml#/components/schemas/AliasDefinition' + lifecycle: + $ref: 'indices._common.yaml#/components/schemas/DataStreamLifecycleWithRollover' diff --git a/spec/schemas/cluster.allocation_explain.yaml b/spec/schemas/cluster.allocation_explain.yaml new file mode 100644 index 00000000..d88c8a1e --- /dev/null +++ b/spec/schemas/cluster.allocation_explain.yaml @@ -0,0 +1,232 @@ +openapi: 3.1.0 +info: + title: Schemas of cluster.allocation_explain category + description: Schemas of cluster.allocation_explain category + version: 1.0.0 +paths: {} +components: + schemas: + Decision: + type: string + enum: + - yes + - no + - worse_balance + - throttled + - awaiting_info + - allocation_delayed + - no_valid_shard_copy + - no_attempt + AllocationDecision: + type: object + properties: + decider: + type: string + decision: + $ref: '#/components/schemas/AllocationExplainDecision' + explanation: + type: string + required: + - decider + - decision + - explanation + AllocationExplainDecision: + type: string + enum: + - NO + - YES + - THROTTLE + - ALWAYS + ClusterInfo: + type: object + properties: + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/NodeDiskUsage' + shard_sizes: + type: object + additionalProperties: + type: number + shard_data_set_sizes: + type: object + additionalProperties: + type: string + shard_paths: + type: object + additionalProperties: + type: string + reserved_sizes: + type: array + items: + $ref: '#/components/schemas/ReservedSize' + required: + - nodes + - shard_sizes + - shard_paths + - reserved_sizes + NodeDiskUsage: + type: object + properties: + node_name: + $ref: '_common.yaml#/components/schemas/Name' + least_available: + $ref: '#/components/schemas/DiskUsage' + most_available: + $ref: '#/components/schemas/DiskUsage' + required: + - node_name + - least_available + - most_available + DiskUsage: + type: object + properties: + path: + type: string + total_bytes: + type: number + used_bytes: + type: number + free_bytes: + type: number + free_disk_percent: + type: number + used_disk_percent: + type: number + required: + - path + - total_bytes + - used_bytes + - free_bytes + - free_disk_percent + - used_disk_percent + ReservedSize: + type: object + properties: + node_id: + $ref: '_common.yaml#/components/schemas/Id' + path: + type: string + total: + type: number + shards: + type: array + items: + type: string + required: + - node_id + - path + - total + - shards + CurrentNode: + type: object + properties: + id: + $ref: '_common.yaml#/components/schemas/Id' + name: + $ref: '_common.yaml#/components/schemas/Name' + attributes: + type: object + additionalProperties: + type: string + transport_address: + $ref: '_common.yaml#/components/schemas/TransportAddress' + weight_ranking: + type: number + required: + - id + - name + - attributes + - transport_address + - weight_ranking + NodeAllocationExplanation: + type: object + properties: + deciders: + type: array + items: + $ref: '#/components/schemas/AllocationDecision' + node_attributes: + type: object + additionalProperties: + type: string + node_decision: + $ref: '#/components/schemas/Decision' + node_id: + $ref: '_common.yaml#/components/schemas/Id' + node_name: + $ref: '_common.yaml#/components/schemas/Name' + store: + $ref: '#/components/schemas/AllocationStore' + transport_address: + $ref: '_common.yaml#/components/schemas/TransportAddress' + weight_ranking: + type: number + required: + - deciders + - node_attributes + - node_decision + - node_id + - node_name + - transport_address + - weight_ranking + AllocationStore: + type: object + properties: + allocation_id: + type: string + found: + type: boolean + in_sync: + type: boolean + matching_size_in_bytes: + type: number + matching_sync_id: + type: boolean + store_exception: + type: string + required: + - allocation_id + - found + - in_sync + - matching_size_in_bytes + - matching_sync_id + - store_exception + UnassignedInformation: + type: object + properties: + at: + $ref: '_common.yaml#/components/schemas/DateTime' + last_allocation_status: + type: string + reason: + $ref: '#/components/schemas/UnassignedInformationReason' + details: + type: string + failed_allocation_attempts: + type: number + delayed: + type: boolean + allocation_status: + type: string + required: + - at + - reason + UnassignedInformationReason: + type: string + enum: + - INDEX_CREATED + - CLUSTER_RECOVERED + - INDEX_REOPENED + - DANGLING_INDEX_IMPORTED + - NEW_INDEX_RESTORED + - EXISTING_INDEX_RESTORED + - REPLICA_ADDED + - ALLOCATION_FAILED + - NODE_LEFT + - REROUTE_CANCELLED + - REINITIALIZED + - REALLOCATED_REPLICA + - PRIMARY_FAILED + - FORCED_EMPTY_PRIMARY + - MANUAL_ALLOCATION diff --git a/spec/schemas/cluster.health.yaml b/spec/schemas/cluster.health.yaml new file mode 100644 index 00000000..c116f569 --- /dev/null +++ b/spec/schemas/cluster.health.yaml @@ -0,0 +1,129 @@ +openapi: 3.1.0 +info: + title: Schemas of cluster.health category + description: Schemas of cluster.health category + version: 1.0.0 +paths: {} +components: + schemas: + HealthResponseBody: + type: object + properties: + active_primary_shards: + description: The number of active primary shards. + type: number + active_shards: + description: The total number of active primary and replica shards. + type: number + active_shards_percent_as_number: + $ref: '_common.yaml#/components/schemas/Percentage' + cluster_name: + $ref: '_common.yaml#/components/schemas/Name' + delayed_unassigned_shards: + description: The number of shards whose allocation has been delayed by the timeout settings. + type: number + indices: + type: object + additionalProperties: + $ref: '#/components/schemas/IndexHealthStats' + initializing_shards: + description: The number of shards that are under initialization. + type: number + number_of_data_nodes: + description: The number of nodes that are dedicated data nodes. + type: number + number_of_in_flight_fetch: + description: The number of unfinished fetches. + type: number + number_of_nodes: + description: The number of nodes within the cluster. + type: number + number_of_pending_tasks: + description: The number of cluster-level changes that have not yet been executed. + type: number + relocating_shards: + description: The number of shards that are under relocation. + type: number + status: + $ref: '_common.yaml#/components/schemas/HealthStatus' + task_max_waiting_in_queue: + $ref: '_common.yaml#/components/schemas/Duration' + task_max_waiting_in_queue_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + timed_out: + description: If false the response returned within the period of time that is specified by the timeout parameter (30s by + default) + type: boolean + unassigned_shards: + description: The number of shards that are not allocated. + type: number + required: + - active_primary_shards + - active_shards + - active_shards_percent_as_number + - cluster_name + - delayed_unassigned_shards + - initializing_shards + - number_of_data_nodes + - number_of_in_flight_fetch + - number_of_nodes + - number_of_pending_tasks + - relocating_shards + - status + - task_max_waiting_in_queue_millis + - timed_out + - unassigned_shards + IndexHealthStats: + type: object + properties: + active_primary_shards: + type: number + active_shards: + type: number + initializing_shards: + type: number + number_of_replicas: + type: number + number_of_shards: + type: number + relocating_shards: + type: number + shards: + type: object + additionalProperties: + $ref: '#/components/schemas/ShardHealthStats' + status: + $ref: '_common.yaml#/components/schemas/HealthStatus' + unassigned_shards: + type: number + required: + - active_primary_shards + - active_shards + - initializing_shards + - number_of_replicas + - number_of_shards + - relocating_shards + - status + - unassigned_shards + ShardHealthStats: + type: object + properties: + active_shards: + type: number + initializing_shards: + type: number + primary_active: + type: boolean + relocating_shards: + type: number + status: + $ref: '_common.yaml#/components/schemas/HealthStatus' + unassigned_shards: + type: number + required: + - active_shards + - initializing_shards + - primary_active + - relocating_shards + - status + - unassigned_shards diff --git a/spec/schemas/cluster.pending_tasks.yaml b/spec/schemas/cluster.pending_tasks.yaml new file mode 100644 index 00000000..da9f6e49 --- /dev/null +++ b/spec/schemas/cluster.pending_tasks.yaml @@ -0,0 +1,36 @@ +openapi: 3.1.0 +info: + title: Schemas of cluster.pending_tasks category + description: Schemas of cluster.pending_tasks category + version: 1.0.0 +paths: {} +components: + schemas: + PendingTask: + type: object + properties: + executing: + description: Indicates whether the pending tasks are currently executing or not. + type: boolean + insert_order: + description: The number that represents when the task has been inserted into the task queue. + type: number + priority: + description: >- + The priority of the pending task. + + The valid priorities in descending priority order are: `IMMEDIATE` > `URGENT` > `HIGH` > `NORMAL` > `LOW` > `LANGUID`. + type: string + source: + description: A general description of the cluster task that may include a reason and origin. + type: string + time_in_queue: + $ref: '_common.yaml#/components/schemas/Duration' + time_in_queue_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + required: + - executing + - insert_order + - priority + - source + - time_in_queue_millis diff --git a/spec/schemas/cluster.remote_info.yaml b/spec/schemas/cluster.remote_info.yaml new file mode 100644 index 00000000..21b63fe3 --- /dev/null +++ b/spec/schemas/cluster.remote_info.yaml @@ -0,0 +1,73 @@ +openapi: 3.1.0 +info: + title: Schemas of cluster.remote_info category + description: Schemas of cluster.remote_info category + version: 1.0.0 +paths: {} +components: + schemas: + ClusterRemoteInfo: + discriminator: + propertyName: mode + oneOf: + - $ref: '#/components/schemas/ClusterRemoteSniffInfo' + - $ref: '#/components/schemas/ClusterRemoteProxyInfo' + ClusterRemoteSniffInfo: + type: object + properties: + mode: + type: string + enum: + - sniff + connected: + type: boolean + max_connections_per_cluster: + type: number + num_nodes_connected: + type: number + initial_connect_timeout: + $ref: '_common.yaml#/components/schemas/Duration' + skip_unavailable: + type: boolean + seeds: + type: array + items: + type: string + required: + - mode + - connected + - max_connections_per_cluster + - num_nodes_connected + - initial_connect_timeout + - skip_unavailable + - seeds + ClusterRemoteProxyInfo: + type: object + properties: + mode: + type: string + enum: + - proxy + connected: + type: boolean + initial_connect_timeout: + $ref: '_common.yaml#/components/schemas/Duration' + skip_unavailable: + type: boolean + proxy_address: + type: string + server_name: + type: string + num_proxy_sockets_connected: + type: number + max_proxy_socket_connections: + type: number + required: + - mode + - connected + - initial_connect_timeout + - skip_unavailable + - proxy_address + - server_name + - num_proxy_sockets_connected + - max_proxy_socket_connections diff --git a/spec/schemas/cluster.reroute.yaml b/spec/schemas/cluster.reroute.yaml new file mode 100644 index 00000000..788a2e19 --- /dev/null +++ b/spec/schemas/cluster.reroute.yaml @@ -0,0 +1,134 @@ +openapi: 3.1.0 +info: + title: Schemas of cluster.reroute category + description: Schemas of cluster.reroute category + version: 1.0.0 +paths: {} +components: + schemas: + Command: + type: object + properties: + cancel: + $ref: '#/components/schemas/CommandCancelAction' + move: + $ref: '#/components/schemas/CommandMoveAction' + allocate_replica: + $ref: '#/components/schemas/CommandAllocateReplicaAction' + allocate_stale_primary: + $ref: '#/components/schemas/CommandAllocatePrimaryAction' + allocate_empty_primary: + $ref: '#/components/schemas/CommandAllocatePrimaryAction' + CommandCancelAction: + type: object + properties: + index: + $ref: '_common.yaml#/components/schemas/IndexName' + shard: + type: number + node: + type: string + allow_primary: + type: boolean + required: + - index + - shard + - node + CommandMoveAction: + type: object + properties: + index: + $ref: '_common.yaml#/components/schemas/IndexName' + shard: + type: number + from_node: + description: The node to move the shard from + type: string + to_node: + description: The node to move the shard to + type: string + required: + - index + - shard + - from_node + - to_node + CommandAllocateReplicaAction: + type: object + properties: + index: + $ref: '_common.yaml#/components/schemas/IndexName' + shard: + type: number + node: + type: string + required: + - index + - shard + - node + CommandAllocatePrimaryAction: + type: object + properties: + index: + $ref: '_common.yaml#/components/schemas/IndexName' + shard: + type: number + node: + type: string + accept_data_loss: + 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 + type: boolean + required: + - index + - shard + - node + - accept_data_loss + RerouteExplanation: + type: object + properties: + command: + type: string + decisions: + type: array + items: + $ref: '#/components/schemas/RerouteDecision' + parameters: + $ref: '#/components/schemas/RerouteParameters' + required: + - command + - decisions + - parameters + RerouteDecision: + type: object + properties: + decider: + type: string + decision: + type: string + explanation: + type: string + required: + - decider + - decision + - explanation + RerouteParameters: + type: object + properties: + allow_primary: + type: boolean + index: + $ref: '_common.yaml#/components/schemas/IndexName' + node: + $ref: '_common.yaml#/components/schemas/NodeName' + shard: + type: number + from_node: + $ref: '_common.yaml#/components/schemas/NodeName' + to_node: + $ref: '_common.yaml#/components/schemas/NodeName' + required: + - allow_primary + - index + - node + - shard diff --git a/spec/schemas/cluster.stats.yaml b/spec/schemas/cluster.stats.yaml new file mode 100644 index 00000000..91ea85cc --- /dev/null +++ b/spec/schemas/cluster.stats.yaml @@ -0,0 +1,729 @@ +openapi: 3.1.0 +info: + title: Schemas of cluster.stats category + description: Schemas of cluster.stats category + version: 1.0.0 +paths: {} +components: + schemas: + StatsResponseBase: + allOf: + - $ref: 'nodes._common.yaml#/components/schemas/NodesResponseBase' + - type: object + properties: + cluster_name: + $ref: '_common.yaml#/components/schemas/Name' + cluster_uuid: + $ref: '_common.yaml#/components/schemas/Uuid' + indices: + $ref: '#/components/schemas/ClusterIndices' + nodes: + $ref: '#/components/schemas/ClusterNodes' + status: + $ref: '_common.yaml#/components/schemas/HealthStatus' + timestamp: + description: Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed. + type: number + required: + - cluster_name + - cluster_uuid + - indices + - nodes + - status + - timestamp + ClusterIndices: + type: object + properties: + analysis: + $ref: '#/components/schemas/CharFilterTypes' + completion: + $ref: '_common.yaml#/components/schemas/CompletionStats' + count: + description: Total number of indices with shards assigned to selected nodes. + type: number + docs: + $ref: '_common.yaml#/components/schemas/DocStats' + fielddata: + $ref: '_common.yaml#/components/schemas/FielddataStats' + query_cache: + $ref: '_common.yaml#/components/schemas/QueryCacheStats' + segments: + $ref: '_common.yaml#/components/schemas/SegmentsStats' + shards: + $ref: '#/components/schemas/ClusterIndicesShards' + store: + $ref: '_common.yaml#/components/schemas/StoreStats' + mappings: + $ref: '#/components/schemas/FieldTypesMappings' + versions: + description: Contains statistics about analyzers and analyzer components used in selected nodes. + type: array + items: + $ref: '#/components/schemas/IndicesVersions' + required: + - analysis + - completion + - count + - docs + - fielddata + - query_cache + - segments + - shards + - store + - mappings + CharFilterTypes: + type: object + properties: + analyzer_types: + description: Contains statistics about analyzer types used in selected nodes. + type: array + items: + $ref: '#/components/schemas/FieldTypes' + built_in_analyzers: + description: Contains statistics about built-in analyzers used in selected nodes. + type: array + items: + $ref: '#/components/schemas/FieldTypes' + built_in_char_filters: + description: Contains statistics about built-in character filters used in selected nodes. + type: array + items: + $ref: '#/components/schemas/FieldTypes' + built_in_filters: + description: Contains statistics about built-in token filters used in selected nodes. + type: array + items: + $ref: '#/components/schemas/FieldTypes' + built_in_tokenizers: + description: Contains statistics about built-in tokenizers used in selected nodes. + type: array + items: + $ref: '#/components/schemas/FieldTypes' + char_filter_types: + description: Contains statistics about character filter types used in selected nodes. + type: array + items: + $ref: '#/components/schemas/FieldTypes' + filter_types: + description: Contains statistics about token filter types used in selected nodes. + type: array + items: + $ref: '#/components/schemas/FieldTypes' + tokenizer_types: + description: Contains statistics about tokenizer types used in selected nodes. + type: array + items: + $ref: '#/components/schemas/FieldTypes' + required: + - analyzer_types + - built_in_analyzers + - built_in_char_filters + - built_in_filters + - built_in_tokenizers + - char_filter_types + - filter_types + - tokenizer_types + FieldTypes: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + count: + description: The number of occurrences of the field type in selected nodes. + type: number + index_count: + description: The number of indices containing the field type in selected nodes. + type: number + indexed_vector_count: + description: For dense_vector field types, number of indexed vector types in selected nodes. + type: number + indexed_vector_dim_max: + description: For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes. + type: number + indexed_vector_dim_min: + description: For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes. + type: number + script_count: + description: The number of fields that declare a script. + type: number + required: + - name + - count + - index_count + ClusterIndicesShards: + type: object + properties: + index: + $ref: '#/components/schemas/ClusterIndicesShardsIndex' + primaries: + description: Number of primary shards assigned to selected nodes. + type: number + replication: + description: Ratio of replica shards to primary shards across all selected nodes. + type: number + total: + description: Total number of shards assigned to selected nodes. + type: number + ClusterIndicesShardsIndex: + type: object + properties: + primaries: + $ref: '#/components/schemas/ClusterShardMetrics' + replication: + $ref: '#/components/schemas/ClusterShardMetrics' + shards: + $ref: '#/components/schemas/ClusterShardMetrics' + required: + - primaries + - replication + - shards + ClusterShardMetrics: + type: object + properties: + avg: + description: Mean number of shards in an index, counting only shards assigned to selected nodes. + type: number + max: + description: Maximum number of shards in an index, counting only shards assigned to selected nodes. + type: number + min: + description: Minimum number of shards in an index, counting only shards assigned to selected nodes. + type: number + required: + - avg + - max + - min + FieldTypesMappings: + type: object + properties: + field_types: + description: Contains statistics about field data types used in selected nodes. + type: array + items: + $ref: '#/components/schemas/FieldTypes' + runtime_field_types: + description: Contains statistics about runtime field data types used in selected nodes. + type: array + items: + $ref: '#/components/schemas/RuntimeFieldTypes' + total_field_count: + description: Total number of fields in all non-system indices. + type: number + total_deduplicated_field_count: + description: Total number of fields in all non-system indices, accounting for mapping deduplication. + type: number + total_deduplicated_mapping_size: + $ref: '_common.yaml#/components/schemas/ByteSize' + total_deduplicated_mapping_size_in_bytes: + description: Total size of all mappings, in bytes, after deduplication and compression. + type: number + required: + - field_types + RuntimeFieldTypes: + type: object + properties: + chars_max: + description: Maximum number of characters for a single runtime field script. + type: number + chars_total: + description: Total number of characters for the scripts that define the current runtime field data type. + type: number + count: + description: Number of runtime fields mapped to the field data type in selected nodes. + type: number + doc_max: + description: Maximum number of accesses to doc_values for a single runtime field script + type: number + doc_total: + description: Total number of accesses to doc_values for the scripts that define the current runtime field data type. + type: number + index_count: + description: Number of indices containing a mapping of the runtime field data type in selected nodes. + type: number + lang: + description: Script languages used for the runtime fields scripts. + type: array + items: + type: string + lines_max: + description: Maximum number of lines for a single runtime field script. + type: number + lines_total: + description: Total number of lines for the scripts that define the current runtime field data type. + type: number + name: + $ref: '_common.yaml#/components/schemas/Name' + scriptless_count: + description: Number of runtime fields that don’t declare a script. + type: number + shadowed_count: + description: Number of runtime fields that shadow an indexed field. + type: number + source_max: + description: Maximum number of accesses to _source for a single runtime field script. + type: number + source_total: + description: Total number of accesses to _source for the scripts that define the current runtime field data type. + type: number + required: + - chars_max + - chars_total + - count + - doc_max + - doc_total + - index_count + - lang + - lines_max + - lines_total + - name + - scriptless_count + - shadowed_count + - source_max + - source_total + IndicesVersions: + type: object + properties: + index_count: + type: number + primary_shard_count: + type: number + total_primary_bytes: + type: number + version: + $ref: '_common.yaml#/components/schemas/VersionString' + required: + - index_count + - primary_shard_count + - total_primary_bytes + - version + ClusterNodes: + type: object + properties: + count: + $ref: '#/components/schemas/ClusterNodeCount' + discovery_types: + description: Contains statistics about the discovery types used by selected nodes. + type: object + additionalProperties: + type: number + fs: + $ref: '#/components/schemas/ClusterFileSystem' + indexing_pressure: + $ref: '#/components/schemas/IndexingPressure' + ingest: + $ref: '#/components/schemas/ClusterIngest' + jvm: + $ref: '#/components/schemas/ClusterJvm' + network_types: + $ref: '#/components/schemas/ClusterNetworkTypes' + os: + $ref: '#/components/schemas/ClusterOperatingSystem' + packaging_types: + description: Contains statistics about Opensearch distributions installed on selected nodes. + type: array + items: + $ref: '#/components/schemas/NodePackagingType' + plugins: + description: |- + Contains statistics about installed plugins and modules by selected nodes. + If no plugins or modules are installed, this array is empty. + type: array + items: + $ref: '_common.yaml#/components/schemas/PluginStats' + process: + $ref: '#/components/schemas/ClusterProcess' + versions: + description: Array of Opensearch versions used on selected nodes. + type: array + items: + $ref: '_common.yaml#/components/schemas/VersionString' + required: + - count + - discovery_types + - fs + - indexing_pressure + - ingest + - jvm + - network_types + - os + - packaging_types + - plugins + - process + - versions + ClusterNodeCount: + type: object + properties: + coordinating_only: + type: number + data: + type: number + data_cold: + type: number + data_content: + type: number + data_frozen: + type: number + data_hot: + type: number + data_warm: + type: number + ingest: + type: number + master: + type: number + ml: + type: number + remote_cluster_client: + type: number + total: + type: number + transform: + type: number + voting_only: + type: number + required: + - coordinating_only + - data + - data_cold + - data_content + - data_hot + - data_warm + - ingest + - master + - ml + - remote_cluster_client + - total + - transform + - voting_only + ClusterFileSystem: + type: object + properties: + available_in_bytes: + description: >- + Total number of bytes available to JVM in file stores across all selected nodes. + + Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`. + + This is the actual amount of free disk space the selected Opensearch nodes can use. + type: number + free_in_bytes: + description: Total number of unallocated bytes in file stores across all selected nodes. + type: number + total_in_bytes: + description: Total size, in bytes, of all file stores across all selected nodes. + type: number + required: + - available_in_bytes + - free_in_bytes + - total_in_bytes + IndexingPressure: + type: object + properties: + memory: + $ref: '#/components/schemas/IndexingPressureMemory' + required: + - memory + IndexingPressureMemory: + type: object + properties: + current: + $ref: '#/components/schemas/IndexingPressureMemorySummary' + limit_in_bytes: + type: number + total: + $ref: '#/components/schemas/IndexingPressureMemorySummary' + required: + - current + - limit_in_bytes + - total + IndexingPressureMemorySummary: + type: object + properties: + all_in_bytes: + type: number + combined_coordinating_and_primary_in_bytes: + type: number + coordinating_in_bytes: + type: number + coordinating_rejections: + type: number + primary_in_bytes: + type: number + primary_rejections: + type: number + replica_in_bytes: + type: number + replica_rejections: + type: number + required: + - all_in_bytes + - combined_coordinating_and_primary_in_bytes + - coordinating_in_bytes + - primary_in_bytes + - replica_in_bytes + ClusterIngest: + type: object + properties: + number_of_pipelines: + type: number + processor_stats: + type: object + additionalProperties: + $ref: '#/components/schemas/ClusterProcessor' + required: + - number_of_pipelines + - processor_stats + ClusterProcessor: + type: object + properties: + count: + type: number + current: + type: number + failed: + type: number + time: + $ref: '_common.yaml#/components/schemas/Duration' + time_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + required: + - count + - current + - failed + - time_in_millis + ClusterJvm: + type: object + properties: + max_uptime_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + mem: + $ref: '#/components/schemas/ClusterJvmMemory' + threads: + description: Number of active threads in use by JVM across all selected nodes. + type: number + versions: + description: Contains statistics about the JVM versions used by selected nodes. + type: array + items: + $ref: '#/components/schemas/ClusterJvmVersion' + required: + - max_uptime_in_millis + - mem + - threads + - versions + ClusterJvmMemory: + type: object + properties: + heap_max_in_bytes: + description: Maximum amount of memory, in bytes, available for use by the heap across all selected nodes. + type: number + heap_used_in_bytes: + description: Memory, in bytes, currently in use by the heap across all selected nodes. + type: number + required: + - heap_max_in_bytes + - heap_used_in_bytes + ClusterJvmVersion: + type: object + properties: + bundled_jdk: + description: Always `true`. All distributions come with a bundled Java Development Kit (JDK). + type: boolean + count: + description: Total number of selected nodes using JVM. + type: number + using_bundled_jdk: + description: If `true`, a bundled JDK is in use by JVM. + type: boolean + version: + $ref: '_common.yaml#/components/schemas/VersionString' + vm_name: + description: Name of the JVM. + type: string + vm_vendor: + description: Vendor of the JVM. + type: string + vm_version: + $ref: '_common.yaml#/components/schemas/VersionString' + required: + - bundled_jdk + - count + - using_bundled_jdk + - version + - vm_name + - vm_vendor + - vm_version + ClusterNetworkTypes: + type: object + properties: + http_types: + description: Contains statistics about the HTTP network types used by selected nodes. + type: object + additionalProperties: + type: number + transport_types: + description: Contains statistics about the transport network types used by selected nodes. + type: object + additionalProperties: + type: number + required: + - http_types + - transport_types + ClusterOperatingSystem: + type: object + properties: + allocated_processors: + description: >- + Number of processors used to calculate thread pool size across all selected nodes. + + This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system. + + In both cases, this number will never be larger than 32. + type: number + architectures: + description: Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes. + type: array + items: + $ref: '#/components/schemas/ClusterOperatingSystemArchitecture' + available_processors: + description: Number of processors available to JVM across all selected nodes. + type: number + mem: + $ref: '#/components/schemas/OperatingSystemMemoryInfo' + names: + description: Contains statistics about operating systems used by selected nodes. + type: array + items: + $ref: '#/components/schemas/ClusterOperatingSystemName' + pretty_names: + description: Contains statistics about operating systems used by selected nodes. + type: array + items: + $ref: '#/components/schemas/ClusterOperatingSystemPrettyName' + required: + - allocated_processors + - available_processors + - mem + - names + - pretty_names + ClusterOperatingSystemArchitecture: + type: object + properties: + arch: + description: Name of an architecture used by one or more selected nodes. + type: string + count: + description: Number of selected nodes using the architecture. + type: number + required: + - arch + - count + OperatingSystemMemoryInfo: + type: object + properties: + adjusted_total_in_bytes: + description: Total amount, in bytes, of memory across all selected nodes, but using the value specified using the + `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system + property was set. + type: number + free_in_bytes: + description: Amount, in bytes, of free physical memory across all selected nodes. + type: number + free_percent: + description: Percentage of free physical memory across all selected nodes. + type: number + total_in_bytes: + description: Total amount, in bytes, of physical memory across all selected nodes. + type: number + used_in_bytes: + description: Amount, in bytes, of physical memory in use across all selected nodes. + type: number + used_percent: + description: Percentage of physical memory in use across all selected nodes. + type: number + required: + - free_in_bytes + - free_percent + - total_in_bytes + - used_in_bytes + - used_percent + ClusterOperatingSystemName: + type: object + properties: + count: + description: Number of selected nodes using the operating system. + type: number + name: + $ref: '_common.yaml#/components/schemas/Name' + required: + - count + - name + ClusterOperatingSystemPrettyName: + type: object + properties: + count: + description: Number of selected nodes using the operating system. + type: number + pretty_name: + $ref: '_common.yaml#/components/schemas/Name' + required: + - count + - pretty_name + NodePackagingType: + type: object + properties: + count: + description: Number of selected nodes using the distribution flavor and file type. + type: number + flavor: + description: Type of Opensearch distribution. This is always `default`. + type: string + type: + description: File type (such as `tar` or `zip`) used for the distribution package. + type: string + required: + - count + - flavor + - type + ClusterProcess: + type: object + properties: + cpu: + $ref: '#/components/schemas/ClusterProcessCpu' + open_file_descriptors: + $ref: '#/components/schemas/ClusterProcessOpenFileDescriptors' + required: + - cpu + - open_file_descriptors + ClusterProcessCpu: + type: object + properties: + percent: + description: |- + Percentage of CPU used across all selected nodes. + Returns `-1` if not supported. + type: number + required: + - percent + ClusterProcessOpenFileDescriptors: + type: object + properties: + avg: + description: |- + Average number of concurrently open file descriptors. + Returns `-1` if not supported. + type: number + max: + description: |- + Maximum number of concurrently open file descriptors allowed across all selected nodes. + Returns `-1` if not supported. + type: number + min: + description: |- + Minimum number of concurrently open file descriptors across all selected nodes. + Returns -1 if not supported. + type: number + required: + - avg + - max + - min diff --git a/spec/schemas/dangling_indices.list_dangling_indices.yaml b/spec/schemas/dangling_indices.list_dangling_indices.yaml new file mode 100644 index 00000000..2dd47e5b --- /dev/null +++ b/spec/schemas/dangling_indices.list_dangling_indices.yaml @@ -0,0 +1,24 @@ +openapi: 3.1.0 +info: + title: Schemas of dangling_indices.list_dangling_indices category + description: Schemas of dangling_indices.list_dangling_indices category + version: 1.0.0 +paths: {} +components: + schemas: + DanglingIndex: + type: object + properties: + index_name: + type: string + index_uuid: + type: string + creation_date_millis: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + node_ids: + $ref: '_common.yaml#/components/schemas/Ids' + required: + - index_name + - index_uuid + - creation_date_millis + - node_ids diff --git a/spec/schemas/indices._common.yaml b/spec/schemas/indices._common.yaml new file mode 100644 index 00000000..3ef7c60b --- /dev/null +++ b/spec/schemas/indices._common.yaml @@ -0,0 +1,1055 @@ +openapi: 3.1.0 +info: + title: Schemas of indices._common category + description: Schemas of indices._common category + version: 1.0.0 +paths: {} +components: + schemas: + IndexSettings: + type: object + properties: + index: + $ref: '#/components/schemas/IndexSettings' + mode: + type: string + routing_path: + oneOf: + - type: string + - type: array + items: + type: string + soft_deletes: + $ref: '#/components/schemas/SoftDeletes' + sort: + $ref: '#/components/schemas/IndexSegmentSort' + number_of_shards: + oneOf: + - type: number + - type: string + number_of_replicas: + oneOf: + - type: number + - type: string + number_of_routing_shards: + type: number + check_on_startup: + $ref: '#/components/schemas/IndexCheckOnStartup' + codec: + type: string + routing_partition_size: + $ref: '_common.yaml#/components/schemas/Stringifiedinteger' + load_fixed_bitset_filters_eagerly: + type: boolean + hidden: + oneOf: + - type: boolean + - type: string + auto_expand_replicas: + type: string + merge: + $ref: '#/components/schemas/Merge' + search: + $ref: '#/components/schemas/SettingsSearch' + refresh_interval: + $ref: '_common.yaml#/components/schemas/Duration' + max_result_window: + type: number + max_inner_result_window: + type: number + max_rescore_window: + type: number + max_docvalue_fields_search: + type: number + max_script_fields: + type: number + max_ngram_diff: + type: number + max_shingle_diff: + type: number + blocks: + $ref: '#/components/schemas/IndexSettingBlocks' + max_refresh_listeners: + type: number + analyze: + $ref: '#/components/schemas/SettingsAnalyze' + highlight: + $ref: '#/components/schemas/SettingsHighlight' + max_terms_count: + type: number + max_regex_length: + type: number + routing: + $ref: '#/components/schemas/IndexRouting' + gc_deletes: + $ref: '_common.yaml#/components/schemas/Duration' + default_pipeline: + $ref: '_common.yaml#/components/schemas/PipelineName' + final_pipeline: + $ref: '_common.yaml#/components/schemas/PipelineName' + lifecycle: + $ref: '#/components/schemas/IndexSettingsLifecycle' + provided_name: + $ref: '_common.yaml#/components/schemas/Name' + creation_date: + $ref: '_common.yaml#/components/schemas/StringifiedEpochTimeUnitMillis' + creation_date_string: + $ref: '_common.yaml#/components/schemas/DateTime' + uuid: + $ref: '_common.yaml#/components/schemas/Uuid' + version: + $ref: '#/components/schemas/IndexVersioning' + verified_before_close: + oneOf: + - type: boolean + - type: string + format: + oneOf: + - type: string + - type: number + max_slices_per_scroll: + type: number + translog: + $ref: '#/components/schemas/Translog' + query_string: + $ref: '#/components/schemas/SettingsQueryString' + priority: + oneOf: + - type: number + - type: string + top_metrics_max_size: + type: number + analysis: + $ref: '#/components/schemas/IndexSettingsAnalysis' + settings: + $ref: '#/components/schemas/IndexSettings' + time_series: + $ref: '#/components/schemas/IndexSettingsTimeSeries' + queries: + $ref: '#/components/schemas/Queries' + similarity: + $ref: '#/components/schemas/SettingsSimilarity' + mapping: + $ref: '#/components/schemas/MappingLimitSettings' + indexing.slowlog: + $ref: '#/components/schemas/IndexingSlowlogSettings' + indexing_pressure: + $ref: '#/components/schemas/IndexingPressure' + store: + $ref: '#/components/schemas/Storage' + description: The index settings to be updated + SoftDeletes: + type: object + properties: + enabled: + description: Indicates whether soft deletes are enabled on the index. + type: boolean + retention_lease: + $ref: '#/components/schemas/RetentionLease' + RetentionLease: + type: object + properties: + period: + $ref: '_common.yaml#/components/schemas/Duration' + required: + - period + IndexSegmentSort: + type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Fields' + order: + oneOf: + - $ref: '#/components/schemas/SegmentSortOrder' + - type: array + items: + $ref: '#/components/schemas/SegmentSortOrder' + mode: + oneOf: + - $ref: '#/components/schemas/SegmentSortMode' + - type: array + items: + $ref: '#/components/schemas/SegmentSortMode' + missing: + oneOf: + - $ref: '#/components/schemas/SegmentSortMissing' + - type: array + items: + $ref: '#/components/schemas/SegmentSortMissing' + SegmentSortOrder: + type: string + enum: + - asc + - desc + SegmentSortMode: + type: string + enum: + - min + - max + SegmentSortMissing: + type: string + enum: + - _last + - _first + IndexCheckOnStartup: + type: string + enum: + - 'true' + - 'false' + - checksum + Merge: + type: object + properties: + scheduler: + $ref: '#/components/schemas/MergeScheduler' + MergeScheduler: + type: object + properties: + max_thread_count: + $ref: '_common.yaml#/components/schemas/Stringifiedinteger' + max_merge_count: + $ref: '_common.yaml#/components/schemas/Stringifiedinteger' + SettingsSearch: + type: object + properties: + idle: + $ref: '#/components/schemas/SearchIdle' + slowlog: + $ref: '#/components/schemas/SlowlogSettings' + SearchIdle: + type: object + properties: + after: + $ref: '_common.yaml#/components/schemas/Duration' + SlowlogSettings: + type: object + properties: + level: + type: string + source: + type: number + reformat: + type: boolean + threshold: + $ref: '#/components/schemas/SlowlogTresholds' + SlowlogTresholds: + type: object + properties: + query: + $ref: '#/components/schemas/SlowlogTresholdLevels' + fetch: + $ref: '#/components/schemas/SlowlogTresholdLevels' + SlowlogTresholdLevels: + type: object + properties: + warn: + $ref: '_common.yaml#/components/schemas/Duration' + info: + $ref: '_common.yaml#/components/schemas/Duration' + debug: + $ref: '_common.yaml#/components/schemas/Duration' + trace: + $ref: '_common.yaml#/components/schemas/Duration' + IndexSettingBlocks: + type: object + properties: + read_only: + $ref: '_common.yaml#/components/schemas/Stringifiedboolean' + read_only_allow_delete: + $ref: '_common.yaml#/components/schemas/Stringifiedboolean' + read: + $ref: '_common.yaml#/components/schemas/Stringifiedboolean' + write: + $ref: '_common.yaml#/components/schemas/Stringifiedboolean' + metadata: + $ref: '_common.yaml#/components/schemas/Stringifiedboolean' + SettingsAnalyze: + type: object + properties: + max_token_count: + $ref: '_common.yaml#/components/schemas/Stringifiedinteger' + SettingsHighlight: + type: object + properties: + max_analyzed_offset: + type: number + IndexRouting: + type: object + properties: + allocation: + $ref: '#/components/schemas/IndexRoutingAllocation' + rebalance: + $ref: '#/components/schemas/IndexRoutingRebalance' + IndexRoutingAllocation: + type: object + properties: + enable: + $ref: '#/components/schemas/IndexRoutingAllocationOptions' + include: + $ref: '#/components/schemas/IndexRoutingAllocationInclude' + initial_recovery: + $ref: '#/components/schemas/IndexRoutingAllocationInitialRecovery' + disk: + $ref: '#/components/schemas/IndexRoutingAllocationDisk' + IndexRoutingAllocationOptions: + type: string + enum: + - all + - primaries + - new_primaries + - none + IndexRoutingAllocationInclude: + type: object + properties: + _tier_preference: + type: string + _id: + $ref: '_common.yaml#/components/schemas/Id' + IndexRoutingAllocationInitialRecovery: + type: object + properties: + _id: + $ref: '_common.yaml#/components/schemas/Id' + IndexRoutingAllocationDisk: + type: object + properties: + threshold_enabled: + oneOf: + - type: boolean + - type: string + IndexRoutingRebalance: + type: object + properties: + enable: + $ref: '#/components/schemas/IndexRoutingRebalanceOptions' + required: + - enable + IndexRoutingRebalanceOptions: + type: string + enum: + - all + - primaries + - replicas + - none + IndexSettingsLifecycle: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + indexing_complete: + $ref: '_common.yaml#/components/schemas/Stringifiedboolean' + origination_date: + description: >- + 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. + type: number + parse_origination_date: + description: >- + 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. + type: boolean + step: + $ref: '#/components/schemas/IndexSettingsLifecycleStep' + rollover_alias: + description: >- + 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. + type: string + required: + - name + IndexSettingsLifecycleStep: + type: object + properties: + wait_time_threshold: + $ref: '_common.yaml#/components/schemas/Duration' + IndexVersioning: + type: object + properties: + created: + $ref: '_common.yaml#/components/schemas/VersionString' + created_string: + type: string + Translog: + type: object + properties: + sync_interval: + $ref: '_common.yaml#/components/schemas/Duration' + durability: + $ref: '#/components/schemas/TranslogDurability' + flush_threshold_size: + $ref: '_common.yaml#/components/schemas/ByteSize' + retention: + $ref: '#/components/schemas/TranslogRetention' + TranslogDurability: + type: string + enum: + - request + - async + TranslogRetention: + type: object + properties: + size: + $ref: '_common.yaml#/components/schemas/ByteSize' + age: + $ref: '_common.yaml#/components/schemas/Duration' + SettingsQueryString: + type: object + properties: + lenient: + $ref: '_common.yaml#/components/schemas/Stringifiedboolean' + required: + - lenient + IndexSettingsAnalysis: + type: object + properties: + analyzer: + type: object + additionalProperties: + $ref: '_common.analysis.yaml#/components/schemas/Analyzer' + char_filter: + type: object + additionalProperties: + $ref: '_common.analysis.yaml#/components/schemas/CharFilter' + filter: + type: object + additionalProperties: + $ref: '_common.analysis.yaml#/components/schemas/TokenFilter' + normalizer: + type: object + additionalProperties: + $ref: '_common.analysis.yaml#/components/schemas/Normalizer' + tokenizer: + type: object + additionalProperties: + $ref: '_common.analysis.yaml#/components/schemas/Tokenizer' + IndexSettingsTimeSeries: + type: object + properties: + end_time: + $ref: '_common.yaml#/components/schemas/DateTime' + start_time: + $ref: '_common.yaml#/components/schemas/DateTime' + Queries: + type: object + properties: + cache: + $ref: '#/components/schemas/CacheQueries' + CacheQueries: + type: object + properties: + enabled: + type: boolean + required: + - enabled + SettingsSimilarity: + type: object + properties: + bm25: + $ref: '#/components/schemas/SettingsSimilarityBm25' + dfi: + $ref: '#/components/schemas/SettingsSimilarityDfi' + dfr: + $ref: '#/components/schemas/SettingsSimilarityDfr' + ib: + $ref: '#/components/schemas/SettingsSimilarityIb' + lmd: + $ref: '#/components/schemas/SettingsSimilarityLmd' + lmj: + $ref: '#/components/schemas/SettingsSimilarityLmj' + scripted_tfidf: + $ref: '#/components/schemas/SettingsSimilarityScriptedTfidf' + SettingsSimilarityBm25: + type: object + properties: + b: + type: number + discount_overlaps: + type: boolean + k1: + type: number + type: + type: string + enum: + - BM25 + required: + - b + - discount_overlaps + - k1 + - type + SettingsSimilarityDfi: + type: object + properties: + independence_measure: + $ref: '_common.yaml#/components/schemas/DFIIndependenceMeasure' + type: + type: string + enum: + - DFI + required: + - independence_measure + - type + SettingsSimilarityDfr: + type: object + properties: + after_effect: + $ref: '_common.yaml#/components/schemas/DFRAfterEffect' + basic_model: + $ref: '_common.yaml#/components/schemas/DFRBasicModel' + normalization: + $ref: '_common.yaml#/components/schemas/Normalization' + type: + type: string + enum: + - DFR + required: + - after_effect + - basic_model + - normalization + - type + SettingsSimilarityIb: + type: object + properties: + distribution: + $ref: '_common.yaml#/components/schemas/IBDistribution' + lambda: + $ref: '_common.yaml#/components/schemas/IBLambda' + normalization: + $ref: '_common.yaml#/components/schemas/Normalization' + type: + type: string + enum: + - IB + required: + - distribution + - lambda + - normalization + - type + SettingsSimilarityLmd: + type: object + properties: + mu: + type: number + type: + type: string + enum: + - LMDirichlet + required: + - mu + - type + SettingsSimilarityLmj: + type: object + properties: + lambda: + type: number + type: + type: string + enum: + - LMJelinekMercer + required: + - lambda + - type + SettingsSimilarityScriptedTfidf: + type: object + properties: + script: + $ref: '_common.yaml#/components/schemas/Script' + type: + type: string + enum: + - scripted + required: + - script + - type + MappingLimitSettings: + type: object + properties: + coerce: + type: boolean + total_fields: + $ref: '#/components/schemas/MappingLimitSettingsTotalFields' + depth: + $ref: '#/components/schemas/MappingLimitSettingsDepth' + nested_fields: + $ref: '#/components/schemas/MappingLimitSettingsNestedFields' + nested_objects: + $ref: '#/components/schemas/MappingLimitSettingsNestedObjects' + field_name_length: + $ref: '#/components/schemas/MappingLimitSettingsFieldNameLength' + dimension_fields: + $ref: '#/components/schemas/MappingLimitSettingsDimensionFields' + ignore_malformed: + type: boolean + MappingLimitSettingsTotalFields: + type: object + properties: + limit: + description: >- + 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. + type: number + MappingLimitSettingsDepth: + type: object + properties: + limit: + description: >- + 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. + type: number + MappingLimitSettingsNestedFields: + type: object + properties: + limit: + description: >- + 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. + type: number + MappingLimitSettingsNestedObjects: + type: object + properties: + limit: + description: >- + 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. + type: number + MappingLimitSettingsFieldNameLength: + type: object + properties: + limit: + description: >- + 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). + type: number + MappingLimitSettingsDimensionFields: + type: object + properties: + limit: + description: >- + [preview] This functionality is in technical preview and may be changed or removed in a future release. + + Opensearch will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. + type: number + IndexingSlowlogSettings: + type: object + properties: + level: + type: string + source: + type: number + reformat: + type: boolean + threshold: + $ref: '#/components/schemas/IndexingSlowlogTresholds' + IndexingSlowlogTresholds: + type: object + properties: + index: + $ref: '#/components/schemas/SlowlogTresholdLevels' + IndexingPressure: + type: object + properties: + memory: + $ref: '#/components/schemas/IndexingPressureMemory' + required: + - memory + IndexingPressureMemory: + type: object + properties: + limit: + description: >- + 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. + type: number + Storage: + type: object + properties: + type: + $ref: '#/components/schemas/StorageType' + allow_mmap: + description: >- + 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. + type: boolean + required: + - type + StorageType: + type: string + enum: + - fs + - niofs + - mmapfs + - hybridfs + NumericFielddata: + type: object + properties: + format: + $ref: '#/components/schemas/NumericFielddataFormat' + required: + - format + NumericFielddataFormat: + type: string + enum: + - array + - disabled + FielddataFrequencyFilter: + type: object + properties: + max: + type: number + min: + type: number + min_segment_size: + type: number + required: + - max + - min + - min_segment_size + AliasDefinition: + type: object + properties: + filter: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + index_routing: + description: |- + Value used to route indexing operations to a specific shard. + If specified, this overwrites the `routing` value for indexing operations. + type: string + is_write_index: + description: If `true`, the index is the write index for the alias. + type: boolean + routing: + description: Value used to route indexing and search operations to a specific shard. + type: string + search_routing: + description: |- + Value used to route search operations to a specific shard. + If specified, this overwrites the `routing` value for search operations. + type: string + is_hidden: + description: |- + If `true`, the alias is hidden. + All indices for the alias must have the same `is_hidden` value. + type: boolean + DataStreamLifecycleWithRollover: + type: object + properties: + data_retention: + $ref: '_common.yaml#/components/schemas/Duration' + downsampling: + $ref: '#/components/schemas/DataStreamLifecycleDownsampling' + rollover: + $ref: '#/components/schemas/DataStreamLifecycleRolloverConditions' + DataStreamLifecycleDownsampling: + type: object + properties: + rounds: + description: The list of downsampling rounds to execute as part of this downsampling configuration + type: array + items: + $ref: '#/components/schemas/DownsamplingRound' + required: + - rounds + DownsamplingRound: + type: object + properties: + after: + $ref: '_common.yaml#/components/schemas/Duration' + config: + $ref: '#/components/schemas/DownsampleConfig' + required: + - after + - config + DownsampleConfig: + type: object + properties: + fixed_interval: + $ref: '_common.yaml#/components/schemas/DurationLarge' + required: + - fixed_interval + DataStreamLifecycleRolloverConditions: + type: object + properties: + min_age: + $ref: '_common.yaml#/components/schemas/Duration' + max_age: + type: string + min_docs: + type: number + max_docs: + type: number + min_size: + $ref: '_common.yaml#/components/schemas/ByteSize' + max_size: + $ref: '_common.yaml#/components/schemas/ByteSize' + min_primary_shard_size: + $ref: '_common.yaml#/components/schemas/ByteSize' + max_primary_shard_size: + $ref: '_common.yaml#/components/schemas/ByteSize' + min_primary_shard_docs: + type: number + max_primary_shard_docs: + type: number + IndexState: + type: object + properties: + aliases: + type: object + additionalProperties: + $ref: '#/components/schemas/Alias' + mappings: + $ref: '_common.mapping.yaml#/components/schemas/TypeMapping' + settings: + $ref: '#/components/schemas/IndexSettings' + defaults: + $ref: '#/components/schemas/IndexSettings' + data_stream: + $ref: '_common.yaml#/components/schemas/DataStreamName' + lifecycle: + $ref: '#/components/schemas/DataStreamLifecycle' + Alias: + type: object + properties: + filter: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + index_routing: + $ref: '_common.yaml#/components/schemas/Routing' + is_hidden: + description: |- + If `true`, the alias is hidden. + All indices for the alias must have the same `is_hidden` value. + type: boolean + is_write_index: + description: If `true`, the index is the write index for the alias. + type: boolean + routing: + $ref: '_common.yaml#/components/schemas/Routing' + search_routing: + $ref: '_common.yaml#/components/schemas/Routing' + DataStreamLifecycle: + type: object + properties: + data_retention: + $ref: '_common.yaml#/components/schemas/Duration' + downsampling: + $ref: '#/components/schemas/DataStreamLifecycleDownsampling' + DataStream: + type: object + properties: + _meta: + $ref: '_common.yaml#/components/schemas/Metadata' + allow_custom_routing: + description: If `true`, the data stream allows custom routing on write request. + type: boolean + generation: + description: Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, + starting at 1. + type: number + hidden: + description: If `true`, the data stream is hidden. + type: boolean + ilm_policy: + $ref: '_common.yaml#/components/schemas/Name' + next_generation_managed_by: + $ref: '#/components/schemas/ManagedBy' + prefer_ilm: + description: Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream. + type: boolean + indices: + description: |- + Array of objects containing information about the data stream’s backing indices. + The last item in this array contains information about the stream’s current write index. + type: array + items: + $ref: '#/components/schemas/DataStreamIndex' + lifecycle: + $ref: '#/components/schemas/DataStreamLifecycleWithRollover' + name: + $ref: '_common.yaml#/components/schemas/DataStreamName' + replicated: + description: If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can + not write into this data stream or change its mappings. + type: boolean + status: + $ref: '_common.yaml#/components/schemas/HealthStatus' + system: + description: If `true`, the data stream is created and managed by an Opensearch stack component and cannot be modified + through normal user interaction. + type: boolean + template: + $ref: '_common.yaml#/components/schemas/Name' + timestamp_field: + $ref: '#/components/schemas/DataStreamTimestampField' + required: + - generation + - hidden + - next_generation_managed_by + - prefer_ilm + - indices + - name + - status + - template + - timestamp_field + ManagedBy: + type: string + enum: + - Index Lifecycle Management + - Data stream lifecycle + - Unmanaged + DataStreamIndex: + type: object + properties: + index_name: + $ref: '_common.yaml#/components/schemas/IndexName' + index_uuid: + $ref: '_common.yaml#/components/schemas/Uuid' + ilm_policy: + $ref: '_common.yaml#/components/schemas/Name' + managed_by: + $ref: '#/components/schemas/ManagedBy' + prefer_ilm: + description: Indicates if ILM should take precedence over DSL in case both are configured to manage this index. + type: boolean + required: + - index_name + - index_uuid + - managed_by + - prefer_ilm + DataStreamTimestampField: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Field' + required: + - name + IndexTemplate: + type: object + properties: + index_patterns: + $ref: '_common.yaml#/components/schemas/Names' + composed_of: + description: >- + An ordered list of component template names. + + Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. + type: array + items: + $ref: '_common.yaml#/components/schemas/Name' + template: + $ref: '#/components/schemas/IndexTemplateSummary' + version: + $ref: '_common.yaml#/components/schemas/VersionNumber' + priority: + description: |- + Priority to determine index template precedence when a new data stream or index is created. + The index template with the highest priority is chosen. + If no priority is specified the template is treated as though it is of priority 0 (lowest priority). + This number is not automatically generated by Opensearch. + type: number + _meta: + $ref: '_common.yaml#/components/schemas/Metadata' + allow_auto_create: + type: boolean + data_stream: + $ref: '#/components/schemas/IndexTemplateDataStreamConfiguration' + required: + - index_patterns + - composed_of + description: New index template definition to be simulated, if no index template name is specified + IndexTemplateSummary: + type: object + properties: + aliases: + description: |- + Aliases to add. + If the index template includes a `data_stream` object, these are data stream aliases. + Otherwise, these are index aliases. + Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + type: object + additionalProperties: + $ref: '#/components/schemas/Alias' + mappings: + $ref: '_common.mapping.yaml#/components/schemas/TypeMapping' + settings: + $ref: '#/components/schemas/IndexSettings' + lifecycle: + $ref: '#/components/schemas/DataStreamLifecycleWithRollover' + IndexTemplateDataStreamConfiguration: + type: object + properties: + hidden: + description: If true, the data stream is hidden. + type: boolean + allow_custom_routing: + description: If true, the data stream supports custom routing. + type: boolean + TemplateMapping: + type: object + properties: + aliases: + type: object + additionalProperties: + $ref: '#/components/schemas/Alias' + index_patterns: + type: array + items: + $ref: '_common.yaml#/components/schemas/Name' + mappings: + $ref: '_common.mapping.yaml#/components/schemas/TypeMapping' + order: + type: number + settings: + type: object + additionalProperties: + type: object + version: + $ref: '_common.yaml#/components/schemas/VersionNumber' + required: + - aliases + - index_patterns + - mappings + - order + - settings + DataStreamVisibility: + type: object + properties: + hidden: + type: boolean diff --git a/spec/schemas/indices.add_block.yaml b/spec/schemas/indices.add_block.yaml new file mode 100644 index 00000000..17a7301b --- /dev/null +++ b/spec/schemas/indices.add_block.yaml @@ -0,0 +1,25 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.add_block category + description: Schemas of indices.add_block category + version: 1.0.0 +paths: {} +components: + schemas: + IndicesBlockOptions: + type: string + enum: + - metadata + - read + - read_only + - write + IndicesBlockStatus: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/IndexName' + blocked: + type: boolean + required: + - name + - blocked diff --git a/spec/schemas/indices.analyze.yaml b/spec/schemas/indices.analyze.yaml new file mode 100644 index 00000000..bd1492d8 --- /dev/null +++ b/spec/schemas/indices.analyze.yaml @@ -0,0 +1,120 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.analyze category + description: Schemas of indices.analyze category + version: 1.0.0 +paths: {} +components: + schemas: + TextToAnalyze: + oneOf: + - type: string + - type: array + items: + type: string + AnalyzeDetail: + type: object + properties: + analyzer: + $ref: '#/components/schemas/AnalyzerDetail' + charfilters: + type: array + items: + $ref: '#/components/schemas/CharFilterDetail' + custom_analyzer: + type: boolean + tokenfilters: + type: array + items: + $ref: '#/components/schemas/TokenDetail' + tokenizer: + $ref: '#/components/schemas/TokenDetail' + required: + - custom_analyzer + AnalyzerDetail: + type: object + properties: + name: + type: string + tokens: + type: array + items: + $ref: '#/components/schemas/ExplainAnalyzeToken' + required: + - name + - tokens + ExplainAnalyzeToken: + type: object + properties: + bytes: + type: string + end_offset: + type: number + keyword: + type: boolean + position: + type: number + positionLength: + type: number + start_offset: + type: number + termFrequency: + type: number + token: + type: string + type: + type: string + required: + - bytes + - end_offset + - position + - positionLength + - start_offset + - termFrequency + - token + - type + CharFilterDetail: + type: object + properties: + filtered_text: + type: array + items: + type: string + name: + type: string + required: + - filtered_text + - name + TokenDetail: + type: object + properties: + name: + type: string + tokens: + type: array + items: + $ref: '#/components/schemas/ExplainAnalyzeToken' + required: + - name + - tokens + AnalyzeToken: + type: object + properties: + end_offset: + type: number + position: + type: number + positionLength: + type: number + start_offset: + type: number + token: + type: string + type: + type: string + required: + - end_offset + - position + - start_offset + - token + - type diff --git a/spec/schemas/indices.close.yaml b/spec/schemas/indices.close.yaml new file mode 100644 index 00000000..d1ba7f4c --- /dev/null +++ b/spec/schemas/indices.close.yaml @@ -0,0 +1,28 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.close category + description: Schemas of indices.close category + version: 1.0.0 +paths: {} +components: + schemas: + CloseIndexResult: + type: object + properties: + closed: + type: boolean + shards: + type: object + additionalProperties: + $ref: '#/components/schemas/CloseShardResult' + required: + - closed + CloseShardResult: + type: object + properties: + failures: + type: array + items: + $ref: '_common.yaml#/components/schemas/ShardFailure' + required: + - failures diff --git a/spec/schemas/indices.data_streams_stats.yaml b/spec/schemas/indices.data_streams_stats.yaml new file mode 100644 index 00000000..e222125a --- /dev/null +++ b/spec/schemas/indices.data_streams_stats.yaml @@ -0,0 +1,28 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.data_streams_stats category + description: Schemas of indices.data_streams_stats category + version: 1.0.0 +paths: {} +components: + schemas: + DataStreamsStatsItem: + type: object + properties: + backing_indices: + description: Current number of backing indices for the data stream. + type: number + data_stream: + $ref: '_common.yaml#/components/schemas/Name' + maximum_timestamp: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + store_size: + $ref: '_common.yaml#/components/schemas/ByteSize' + store_size_bytes: + description: Total size, in bytes, of all shards for the data stream’s backing indices. + type: number + required: + - backing_indices + - data_stream + - maximum_timestamp + - store_size_bytes diff --git a/spec/schemas/indices.forcemerge._types.yaml b/spec/schemas/indices.forcemerge._types.yaml new file mode 100644 index 00000000..feb71e3c --- /dev/null +++ b/spec/schemas/indices.forcemerge._types.yaml @@ -0,0 +1,18 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.forcemerge._types category + description: Schemas of indices.forcemerge._types category + version: 1.0.0 +paths: {} +components: + schemas: + ForceMergeResponseBody: + allOf: + - $ref: '_common.yaml#/components/schemas/ShardsOperationResponseBase' + - type: object + properties: + task: + description: |- + task contains a task id returned when wait_for_completion=false, + you can use the task_id to get the status of the task at _tasks/ + type: string diff --git a/spec/schemas/indices.get_alias.yaml b/spec/schemas/indices.get_alias.yaml new file mode 100644 index 00000000..50aa52f7 --- /dev/null +++ b/spec/schemas/indices.get_alias.yaml @@ -0,0 +1,17 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.get_alias category + description: Schemas of indices.get_alias category + version: 1.0.0 +paths: {} +components: + schemas: + IndexAliases: + type: object + properties: + aliases: + type: object + additionalProperties: + $ref: 'indices._common.yaml#/components/schemas/AliasDefinition' + required: + - aliases diff --git a/spec/schemas/indices.get_field_mapping.yaml b/spec/schemas/indices.get_field_mapping.yaml new file mode 100644 index 00000000..24f11fd2 --- /dev/null +++ b/spec/schemas/indices.get_field_mapping.yaml @@ -0,0 +1,17 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.get_field_mapping category + description: Schemas of indices.get_field_mapping category + version: 1.0.0 +paths: {} +components: + schemas: + TypeFieldMappings: + type: object + properties: + mappings: + type: object + additionalProperties: + $ref: '_common.mapping.yaml#/components/schemas/FieldMapping' + required: + - mappings diff --git a/spec/schemas/indices.get_index_template.yaml b/spec/schemas/indices.get_index_template.yaml new file mode 100644 index 00000000..c8b16d0e --- /dev/null +++ b/spec/schemas/indices.get_index_template.yaml @@ -0,0 +1,18 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.get_index_template category + description: Schemas of indices.get_index_template category + version: 1.0.0 +paths: {} +components: + schemas: + IndexTemplateItem: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + index_template: + $ref: 'indices._common.yaml#/components/schemas/IndexTemplate' + required: + - name + - index_template diff --git a/spec/schemas/indices.get_mapping.yaml b/spec/schemas/indices.get_mapping.yaml new file mode 100644 index 00000000..4ba669fe --- /dev/null +++ b/spec/schemas/indices.get_mapping.yaml @@ -0,0 +1,17 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.get_mapping category + description: Schemas of indices.get_mapping category + version: 1.0.0 +paths: {} +components: + schemas: + IndexMappingRecord: + type: object + properties: + item: + $ref: '_common.mapping.yaml#/components/schemas/TypeMapping' + mappings: + $ref: '_common.mapping.yaml#/components/schemas/TypeMapping' + required: + - mappings diff --git a/spec/schemas/indices.put_index_template.yaml b/spec/schemas/indices.put_index_template.yaml new file mode 100644 index 00000000..bdee9bbe --- /dev/null +++ b/spec/schemas/indices.put_index_template.yaml @@ -0,0 +1,26 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.put_index_template category + description: Schemas of indices.put_index_template category + version: 1.0.0 +paths: {} +components: + schemas: + IndexTemplateMapping: + type: object + properties: + aliases: + description: |- + Aliases to add. + If the index template includes a `data_stream` object, these are data stream aliases. + Otherwise, these are index aliases. + Data stream aliases ignore the `index_routing`, `routing`, and `search_routing` options. + type: object + additionalProperties: + $ref: 'indices._common.yaml#/components/schemas/Alias' + mappings: + $ref: '_common.mapping.yaml#/components/schemas/TypeMapping' + settings: + $ref: 'indices._common.yaml#/components/schemas/IndexSettings' + lifecycle: + $ref: 'indices._common.yaml#/components/schemas/DataStreamLifecycle' diff --git a/spec/schemas/indices.recovery.yaml b/spec/schemas/indices.recovery.yaml new file mode 100644 index 00000000..b82d5b14 --- /dev/null +++ b/spec/schemas/indices.recovery.yaml @@ -0,0 +1,226 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.recovery category + description: Schemas of indices.recovery category + version: 1.0.0 +paths: {} +components: + schemas: + RecoveryStatus: + type: object + properties: + shards: + type: array + items: + $ref: '#/components/schemas/ShardRecovery' + required: + - shards + ShardRecovery: + type: object + properties: + id: + type: number + index: + $ref: '#/components/schemas/RecoveryIndexStatus' + primary: + type: boolean + source: + $ref: '#/components/schemas/RecoveryOrigin' + stage: + type: string + start: + $ref: '#/components/schemas/RecoveryStartStatus' + start_time: + $ref: '_common.yaml#/components/schemas/DateTime' + start_time_in_millis: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + stop_time: + $ref: '_common.yaml#/components/schemas/DateTime' + stop_time_in_millis: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + target: + $ref: '#/components/schemas/RecoveryOrigin' + total_time: + $ref: '_common.yaml#/components/schemas/Duration' + total_time_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + translog: + $ref: '#/components/schemas/TranslogStatus' + type: + type: string + verify_index: + $ref: '#/components/schemas/VerifyIndex' + required: + - id + - index + - primary + - source + - stage + - start_time_in_millis + - target + - total_time_in_millis + - translog + - type + - verify_index + RecoveryIndexStatus: + type: object + properties: + bytes: + $ref: '#/components/schemas/RecoveryBytes' + files: + $ref: '#/components/schemas/RecoveryFiles' + size: + $ref: '#/components/schemas/RecoveryBytes' + source_throttle_time: + $ref: '_common.yaml#/components/schemas/Duration' + source_throttle_time_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + target_throttle_time: + $ref: '_common.yaml#/components/schemas/Duration' + target_throttle_time_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + total_time: + $ref: '_common.yaml#/components/schemas/Duration' + total_time_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + required: + - files + - size + - source_throttle_time_in_millis + - target_throttle_time_in_millis + - total_time_in_millis + RecoveryBytes: + type: object + properties: + percent: + $ref: '_common.yaml#/components/schemas/Percentage' + recovered: + $ref: '_common.yaml#/components/schemas/ByteSize' + recovered_in_bytes: + $ref: '_common.yaml#/components/schemas/ByteSize' + recovered_from_snapshot: + $ref: '_common.yaml#/components/schemas/ByteSize' + recovered_from_snapshot_in_bytes: + $ref: '_common.yaml#/components/schemas/ByteSize' + reused: + $ref: '_common.yaml#/components/schemas/ByteSize' + reused_in_bytes: + $ref: '_common.yaml#/components/schemas/ByteSize' + total: + $ref: '_common.yaml#/components/schemas/ByteSize' + total_in_bytes: + $ref: '_common.yaml#/components/schemas/ByteSize' + required: + - percent + - recovered_in_bytes + - reused_in_bytes + - total_in_bytes + RecoveryFiles: + type: object + properties: + details: + type: array + items: + $ref: '#/components/schemas/FileDetails' + percent: + $ref: '_common.yaml#/components/schemas/Percentage' + recovered: + type: number + reused: + type: number + total: + type: number + required: + - percent + - recovered + - reused + - total + FileDetails: + type: object + properties: + length: + type: number + name: + type: string + recovered: + type: number + required: + - length + - name + - recovered + RecoveryOrigin: + type: object + properties: + hostname: + type: string + host: + $ref: '_common.yaml#/components/schemas/Host' + transport_address: + $ref: '_common.yaml#/components/schemas/TransportAddress' + id: + $ref: '_common.yaml#/components/schemas/Id' + ip: + $ref: '_common.yaml#/components/schemas/Ip' + name: + $ref: '_common.yaml#/components/schemas/Name' + bootstrap_new_history_uuid: + type: boolean + repository: + $ref: '_common.yaml#/components/schemas/Name' + snapshot: + $ref: '_common.yaml#/components/schemas/Name' + version: + $ref: '_common.yaml#/components/schemas/VersionString' + restoreUUID: + $ref: '_common.yaml#/components/schemas/Uuid' + index: + $ref: '_common.yaml#/components/schemas/IndexName' + RecoveryStartStatus: + type: object + properties: + check_index_time: + $ref: '_common.yaml#/components/schemas/Duration' + check_index_time_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + total_time: + $ref: '_common.yaml#/components/schemas/Duration' + total_time_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + required: + - check_index_time_in_millis + - total_time_in_millis + TranslogStatus: + type: object + properties: + percent: + $ref: '_common.yaml#/components/schemas/Percentage' + recovered: + type: number + total: + type: number + total_on_start: + type: number + total_time: + $ref: '_common.yaml#/components/schemas/Duration' + total_time_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + required: + - percent + - recovered + - total + - total_on_start + - total_time_in_millis + VerifyIndex: + type: object + properties: + check_index_time: + $ref: '_common.yaml#/components/schemas/Duration' + check_index_time_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + total_time: + $ref: '_common.yaml#/components/schemas/Duration' + total_time_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + required: + - check_index_time_in_millis + - total_time_in_millis diff --git a/spec/schemas/indices.resolve_index.yaml b/spec/schemas/indices.resolve_index.yaml new file mode 100644 index 00000000..72a66cac --- /dev/null +++ b/spec/schemas/indices.resolve_index.yaml @@ -0,0 +1,49 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.resolve_index category + description: Schemas of indices.resolve_index category + version: 1.0.0 +paths: {} +components: + schemas: + ResolveIndexItem: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + aliases: + type: array + items: + type: string + attributes: + type: array + items: + type: string + data_stream: + $ref: '_common.yaml#/components/schemas/DataStreamName' + required: + - name + - attributes + ResolveIndexAliasItem: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + indices: + $ref: '_common.yaml#/components/schemas/Indices' + required: + - name + - indices + ResolveIndexDataStreamsItem: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/DataStreamName' + timestamp_field: + $ref: '_common.yaml#/components/schemas/Field' + backing_indices: + $ref: '_common.yaml#/components/schemas/Indices' + required: + - name + - timestamp_field + - backing_indices diff --git a/spec/schemas/indices.rollover.yaml b/spec/schemas/indices.rollover.yaml new file mode 100644 index 00000000..fb21a336 --- /dev/null +++ b/spec/schemas/indices.rollover.yaml @@ -0,0 +1,41 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.rollover category + description: Schemas of indices.rollover category + version: 1.0.0 +paths: {} +components: + schemas: + RolloverConditions: + type: object + properties: + min_age: + $ref: '_common.yaml#/components/schemas/Duration' + max_age: + $ref: '_common.yaml#/components/schemas/Duration' + max_age_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + min_docs: + type: number + max_docs: + type: number + max_size: + $ref: '_common.yaml#/components/schemas/ByteSize' + max_size_bytes: + type: number + min_size: + $ref: '_common.yaml#/components/schemas/ByteSize' + min_size_bytes: + type: number + max_primary_shard_size: + $ref: '_common.yaml#/components/schemas/ByteSize' + max_primary_shard_size_bytes: + type: number + min_primary_shard_size: + $ref: '_common.yaml#/components/schemas/ByteSize' + min_primary_shard_size_bytes: + type: number + max_primary_shard_docs: + type: number + min_primary_shard_docs: + type: number diff --git a/spec/schemas/indices.segments.yaml b/spec/schemas/indices.segments.yaml new file mode 100644 index 00000000..1cfabe0a --- /dev/null +++ b/spec/schemas/indices.segments.yaml @@ -0,0 +1,85 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.segments category + description: Schemas of indices.segments category + version: 1.0.0 +paths: {} +components: + schemas: + IndexSegment: + type: object + properties: + shards: + type: object + additionalProperties: + oneOf: + - $ref: '#/components/schemas/ShardsSegment' + - type: array + items: + $ref: '#/components/schemas/ShardsSegment' + required: + - shards + ShardsSegment: + type: object + properties: + num_committed_segments: + type: number + routing: + $ref: '#/components/schemas/ShardSegmentRouting' + num_search_segments: + type: number + segments: + type: object + additionalProperties: + $ref: '#/components/schemas/Segment' + required: + - num_committed_segments + - routing + - num_search_segments + - segments + ShardSegmentRouting: + type: object + properties: + node: + type: string + primary: + type: boolean + state: + type: string + required: + - node + - primary + - state + Segment: + type: object + properties: + attributes: + type: object + additionalProperties: + type: string + committed: + type: boolean + compound: + type: boolean + deleted_docs: + type: number + generation: + type: number + search: + type: boolean + size_in_bytes: + type: number + num_docs: + type: number + version: + $ref: '_common.yaml#/components/schemas/VersionString' + required: + - attributes + - committed + - compound + - deleted_docs + - generation + - search + - size_in_bytes + - num_docs + - version diff --git a/spec/schemas/indices.shard_stores.yaml b/spec/schemas/indices.shard_stores.yaml new file mode 100644 index 00000000..770d2003 --- /dev/null +++ b/spec/schemas/indices.shard_stores.yaml @@ -0,0 +1,60 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.shard_stores category + description: Schemas of indices.shard_stores category + version: 1.0.0 +paths: {} +components: + schemas: + ShardStoreStatus: + type: string + enum: + - green + - yellow + - red + - all + IndicesShardStores: + type: object + properties: + shards: + type: object + additionalProperties: + $ref: '#/components/schemas/ShardStoreWrapper' + required: + - shards + ShardStoreWrapper: + type: object + properties: + stores: + type: array + items: + $ref: '#/components/schemas/ShardStore' + required: + - stores + ShardStore: + type: object + properties: + allocation: + $ref: '#/components/schemas/ShardStoreAllocation' + allocation_id: + $ref: '_common.yaml#/components/schemas/Id' + store_exception: + $ref: '#/components/schemas/ShardStoreException' + required: + - allocation + ShardStoreAllocation: + type: string + enum: + - primary + - replica + - unused + ShardStoreException: + type: object + properties: + reason: + type: string + type: + type: string + required: + - reason + - type diff --git a/spec/schemas/indices.simulate_template.yaml b/spec/schemas/indices.simulate_template.yaml new file mode 100644 index 00000000..e2304881 --- /dev/null +++ b/spec/schemas/indices.simulate_template.yaml @@ -0,0 +1,35 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.simulate_template category + description: Schemas of indices.simulate_template category + version: 1.0.0 +paths: {} +components: + schemas: + Overlapping: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + index_patterns: + type: array + items: + type: string + required: + - name + - index_patterns + Template: + type: object + properties: + aliases: + type: object + additionalProperties: + $ref: 'indices._common.yaml#/components/schemas/Alias' + mappings: + $ref: '_common.mapping.yaml#/components/schemas/TypeMapping' + settings: + $ref: 'indices._common.yaml#/components/schemas/IndexSettings' + required: + - aliases + - mappings + - settings diff --git a/spec/schemas/indices.stats.yaml b/spec/schemas/indices.stats.yaml new file mode 100644 index 00000000..c65ef44e --- /dev/null +++ b/spec/schemas/indices.stats.yaml @@ -0,0 +1,292 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.stats category + description: Schemas of indices.stats category + version: 1.0.0 +paths: {} +components: + schemas: + ShardFileSizeInfo: + type: object + properties: + description: + type: string + size_in_bytes: + type: number + min_size_in_bytes: + type: number + max_size_in_bytes: + type: number + average_size_in_bytes: + type: number + count: + type: number + required: + - description + - size_in_bytes + IndicesStats: + type: object + properties: + primaries: + $ref: '#/components/schemas/IndexStats' + shards: + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/ShardStats' + total: + $ref: '#/components/schemas/IndexStats' + uuid: + $ref: '_common.yaml#/components/schemas/Uuid' + health: + $ref: '_common.yaml#/components/schemas/HealthStatus' + status: + $ref: '#/components/schemas/IndexMetadataState' + IndexStats: + type: object + properties: + completion: + $ref: '_common.yaml#/components/schemas/CompletionStats' + docs: + $ref: '_common.yaml#/components/schemas/DocStats' + fielddata: + $ref: '_common.yaml#/components/schemas/FielddataStats' + flush: + $ref: '_common.yaml#/components/schemas/FlushStats' + get: + $ref: '_common.yaml#/components/schemas/GetStats' + indexing: + $ref: '_common.yaml#/components/schemas/IndexingStats' + indices: + $ref: '#/components/schemas/IndicesStats' + merges: + $ref: '_common.yaml#/components/schemas/MergesStats' + query_cache: + $ref: '_common.yaml#/components/schemas/QueryCacheStats' + recovery: + $ref: '_common.yaml#/components/schemas/RecoveryStats' + refresh: + $ref: '_common.yaml#/components/schemas/RefreshStats' + request_cache: + $ref: '_common.yaml#/components/schemas/RequestCacheStats' + search: + $ref: '_common.yaml#/components/schemas/SearchStats' + segments: + $ref: '_common.yaml#/components/schemas/SegmentsStats' + store: + $ref: '_common.yaml#/components/schemas/StoreStats' + translog: + $ref: '_common.yaml#/components/schemas/TranslogStats' + warmer: + $ref: '_common.yaml#/components/schemas/WarmerStats' + bulk: + $ref: '_common.yaml#/components/schemas/BulkStats' + shard_stats: + $ref: '#/components/schemas/ShardsTotalStats' + ShardsTotalStats: + type: object + properties: + total_count: + type: number + required: + - total_count + ShardStats: + type: object + properties: + commit: + $ref: '#/components/schemas/ShardCommit' + completion: + $ref: '_common.yaml#/components/schemas/CompletionStats' + docs: + $ref: '_common.yaml#/components/schemas/DocStats' + fielddata: + $ref: '_common.yaml#/components/schemas/FielddataStats' + flush: + $ref: '_common.yaml#/components/schemas/FlushStats' + get: + $ref: '_common.yaml#/components/schemas/GetStats' + indexing: + $ref: '_common.yaml#/components/schemas/IndexingStats' + mappings: + $ref: '#/components/schemas/MappingStats' + merges: + $ref: '_common.yaml#/components/schemas/MergesStats' + shard_path: + $ref: '#/components/schemas/ShardPath' + query_cache: + $ref: '#/components/schemas/ShardQueryCache' + recovery: + $ref: '_common.yaml#/components/schemas/RecoveryStats' + refresh: + $ref: '_common.yaml#/components/schemas/RefreshStats' + request_cache: + $ref: '_common.yaml#/components/schemas/RequestCacheStats' + retention_leases: + $ref: '#/components/schemas/ShardRetentionLeases' + routing: + $ref: '#/components/schemas/ShardRouting' + search: + $ref: '_common.yaml#/components/schemas/SearchStats' + segments: + $ref: '_common.yaml#/components/schemas/SegmentsStats' + seq_no: + $ref: '#/components/schemas/ShardSequenceNumber' + store: + $ref: '_common.yaml#/components/schemas/StoreStats' + translog: + $ref: '_common.yaml#/components/schemas/TranslogStats' + warmer: + $ref: '_common.yaml#/components/schemas/WarmerStats' + bulk: + $ref: '_common.yaml#/components/schemas/BulkStats' + shards: + type: object + additionalProperties: + type: object + shard_stats: + $ref: '#/components/schemas/ShardsTotalStats' + indices: + $ref: '#/components/schemas/IndicesStats' + ShardCommit: + type: object + properties: + generation: + type: number + id: + $ref: '_common.yaml#/components/schemas/Id' + num_docs: + type: number + user_data: + type: object + additionalProperties: + type: string + required: + - generation + - id + - num_docs + - user_data + MappingStats: + type: object + properties: + total_count: + type: number + total_estimated_overhead: + $ref: '_common.yaml#/components/schemas/ByteSize' + total_estimated_overhead_in_bytes: + type: number + required: + - total_count + - total_estimated_overhead_in_bytes + ShardPath: + type: object + properties: + data_path: + type: string + is_custom_data_path: + type: boolean + state_path: + type: string + required: + - data_path + - is_custom_data_path + - state_path + ShardQueryCache: + type: object + properties: + cache_count: + type: number + cache_size: + type: number + evictions: + type: number + hit_count: + type: number + memory_size_in_bytes: + type: number + miss_count: + type: number + total_count: + type: number + required: + - cache_count + - cache_size + - evictions + - hit_count + - memory_size_in_bytes + - miss_count + - total_count + ShardRetentionLeases: + type: object + properties: + primary_term: + type: number + version: + $ref: '_common.yaml#/components/schemas/VersionNumber' + leases: + type: array + items: + $ref: '#/components/schemas/ShardLease' + required: + - primary_term + - version + - leases + ShardLease: + type: object + properties: + id: + $ref: '_common.yaml#/components/schemas/Id' + retaining_seq_no: + $ref: '_common.yaml#/components/schemas/SequenceNumber' + timestamp: + type: number + source: + type: string + required: + - id + - retaining_seq_no + - timestamp + - source + ShardRouting: + type: object + properties: + node: + type: string + primary: + type: boolean + relocating_node: + oneOf: + - type: string + - nullable: true + type: string + state: + $ref: '#/components/schemas/ShardRoutingState' + required: + - node + - primary + - state + ShardRoutingState: + type: string + enum: + - UNASSIGNED + - INITIALIZING + - STARTED + - RELOCATING + ShardSequenceNumber: + type: object + properties: + global_checkpoint: + type: number + local_checkpoint: + type: number + max_seq_no: + $ref: '_common.yaml#/components/schemas/SequenceNumber' + required: + - global_checkpoint + - local_checkpoint + - max_seq_no + IndexMetadataState: + type: string + enum: + - open + - close diff --git a/spec/schemas/indices.update_aliases.yaml b/spec/schemas/indices.update_aliases.yaml new file mode 100644 index 00000000..ee273091 --- /dev/null +++ b/spec/schemas/indices.update_aliases.yaml @@ -0,0 +1,85 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.update_aliases category + description: Schemas of indices.update_aliases category + version: 1.0.0 +paths: {} +components: + schemas: + Action: + type: object + properties: + add: + $ref: '#/components/schemas/AddAction' + remove: + $ref: '#/components/schemas/RemoveAction' + remove_index: + $ref: '#/components/schemas/RemoveIndexAction' + minProperties: 1 + maxProperties: 1 + AddAction: + type: object + properties: + alias: + $ref: '_common.yaml#/components/schemas/IndexAlias' + aliases: + description: |- + Aliases for the action. + Index alias names support date math. + oneOf: + - $ref: '_common.yaml#/components/schemas/IndexAlias' + - type: array + items: + $ref: '_common.yaml#/components/schemas/IndexAlias' + filter: + $ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer' + index: + $ref: '_common.yaml#/components/schemas/IndexName' + indices: + $ref: '_common.yaml#/components/schemas/Indices' + index_routing: + $ref: '_common.yaml#/components/schemas/Routing' + is_hidden: + description: If `true`, the alias is hidden. + type: boolean + is_write_index: + description: If `true`, sets the write index or data stream for the alias. + type: boolean + routing: + $ref: '_common.yaml#/components/schemas/Routing' + search_routing: + $ref: '_common.yaml#/components/schemas/Routing' + must_exist: + description: If `true`, the alias must exist to perform the action. + type: boolean + RemoveAction: + type: object + properties: + alias: + $ref: '_common.yaml#/components/schemas/IndexAlias' + aliases: + description: |- + Aliases for the action. + Index alias names support date math. + oneOf: + - $ref: '_common.yaml#/components/schemas/IndexAlias' + - type: array + items: + $ref: '_common.yaml#/components/schemas/IndexAlias' + index: + $ref: '_common.yaml#/components/schemas/IndexName' + indices: + $ref: '_common.yaml#/components/schemas/Indices' + must_exist: + description: If `true`, the alias must exist to perform the action. + type: boolean + RemoveIndexAction: + type: object + properties: + index: + $ref: '_common.yaml#/components/schemas/IndexName' + indices: + $ref: '_common.yaml#/components/schemas/Indices' + must_exist: + description: If `true`, the alias must exist to perform the action. + type: boolean diff --git a/spec/schemas/indices.validate_query.yaml b/spec/schemas/indices.validate_query.yaml new file mode 100644 index 00000000..4c13bfa5 --- /dev/null +++ b/spec/schemas/indices.validate_query.yaml @@ -0,0 +1,22 @@ +openapi: 3.1.0 +info: + title: Schemas of indices.validate_query category + description: Schemas of indices.validate_query category + version: 1.0.0 +paths: {} +components: + schemas: + IndicesValidationExplanation: + type: object + properties: + error: + type: string + explanation: + type: string + index: + $ref: '_common.yaml#/components/schemas/IndexName' + valid: + type: boolean + required: + - index + - valid diff --git a/spec/schemas/ingest._common.yaml b/spec/schemas/ingest._common.yaml new file mode 100644 index 00000000..09994da9 --- /dev/null +++ b/spec/schemas/ingest._common.yaml @@ -0,0 +1,895 @@ +openapi: 3.1.0 +info: + title: Schemas of ingest._common category + description: Schemas of ingest._common category + version: 1.0.0 +paths: {} +components: + schemas: + Pipeline: + type: object + properties: + description: + description: Description of the ingest pipeline. + type: string + on_failure: + description: Processors to run immediately after a processor failure. + type: array + items: + $ref: '#/components/schemas/ProcessorContainer' + processors: + description: |- + Processors used to perform transformations on documents before indexing. + Processors run sequentially in the order specified. + type: array + items: + $ref: '#/components/schemas/ProcessorContainer' + version: + $ref: '_common.yaml#/components/schemas/VersionNumber' + _meta: + $ref: '_common.yaml#/components/schemas/Metadata' + required: + - _meta + ProcessorContainer: + type: object + properties: + attachment: + $ref: '#/components/schemas/AttachmentProcessor' + append: + $ref: '#/components/schemas/AppendProcessor' + csv: + $ref: '#/components/schemas/CsvProcessor' + convert: + $ref: '#/components/schemas/ConvertProcessor' + date: + $ref: '#/components/schemas/DateProcessor' + date_index_name: + $ref: '#/components/schemas/DateIndexNameProcessor' + dot_expander: + $ref: '#/components/schemas/DotExpanderProcessor' + enrich: + $ref: '#/components/schemas/EnrichProcessor' + fail: + $ref: '#/components/schemas/FailProcessor' + foreach: + $ref: '#/components/schemas/ForeachProcessor' + json: + $ref: '#/components/schemas/JsonProcessor' + user_agent: + $ref: '#/components/schemas/UserAgentProcessor' + kv: + $ref: '#/components/schemas/KeyValueProcessor' + geoip: + $ref: '#/components/schemas/GeoIpProcessor' + grok: + $ref: '#/components/schemas/GrokProcessor' + gsub: + $ref: '#/components/schemas/GsubProcessor' + join: + $ref: '#/components/schemas/JoinProcessor' + lowercase: + $ref: '#/components/schemas/LowercaseProcessor' + remove: + $ref: '#/components/schemas/RemoveProcessor' + rename: + $ref: '#/components/schemas/RenameProcessor' + script: + $ref: '_common.yaml#/components/schemas/Script' + set: + $ref: '#/components/schemas/SetProcessor' + sort: + $ref: '#/components/schemas/SortProcessor' + split: + $ref: '#/components/schemas/SplitProcessor' + trim: + $ref: '#/components/schemas/TrimProcessor' + uppercase: + $ref: '#/components/schemas/UppercaseProcessor' + urldecode: + $ref: '#/components/schemas/UrlDecodeProcessor' + bytes: + $ref: '#/components/schemas/BytesProcessor' + dissect: + $ref: '#/components/schemas/DissectProcessor' + set_security_user: + $ref: '#/components/schemas/SetSecurityUserProcessor' + pipeline: + $ref: '#/components/schemas/PipelineProcessor' + drop: + $ref: '#/components/schemas/DropProcessor' + circle: + $ref: '#/components/schemas/CircleProcessor' + inference: + $ref: '#/components/schemas/InferenceProcessor' + minProperties: 1 + maxProperties: 1 + AttachmentProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true` and field does not exist, the processor quietly exits without modifying the document. + type: boolean + indexed_chars: + description: |- + The number of chars being used for extraction to prevent huge fields. + Use `-1` for no limit. + type: number + indexed_chars_field: + $ref: '_common.yaml#/components/schemas/Field' + properties: + description: >- + Array of properties to select to be stored. + + Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`. + type: array + items: + type: string + target_field: + $ref: '_common.yaml#/components/schemas/Field' + resource_name: + description: >- + Field containing the name of the resource to decode. + + If specified, the processor passes this resource name to the underlying Tika library to enable Resource Name Based Detection. + type: string + required: + - field + ProcessorBase: + type: object + properties: + description: + description: |- + Description of the processor. + Useful for describing the purpose of the processor or its configuration. + type: string + if: + description: Conditionally execute the processor. + type: string + ignore_failure: + description: Ignore failures for the processor. + type: boolean + on_failure: + description: Handle failures for the processor. + type: array + items: + $ref: '#/components/schemas/ProcessorContainer' + tag: + description: |- + Identifier for the processor. + Useful for debugging and metrics. + type: string + AppendProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + value: + description: The value to be appended. Supports template snippets. + type: array + items: + type: object + allow_duplicates: + description: If `false`, the processor does not append values already present in the field. + type: boolean + required: + - field + - value + CsvProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + empty_value: + description: |- + Value used to fill empty fields. + Empty fields are skipped if this is not provided. + An empty field is one with no value (2 consecutive separators) or empty quotes (`""`). + type: object + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + type: boolean + quote: + description: Quote used in CSV, has to be single character string. + type: string + separator: + description: Separator used in CSV, has to be single character string. + type: string + target_fields: + $ref: '_common.yaml#/components/schemas/Fields' + trim: + description: Trim whitespaces in unquoted fields. + type: boolean + required: + - field + - target_fields + ConvertProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the + document. + type: boolean + target_field: + $ref: '_common.yaml#/components/schemas/Field' + type: + $ref: '#/components/schemas/ConvertType' + required: + - field + - type + ConvertType: + type: string + enum: + - integer + - long + - float + - double + - string + - boolean + - auto + DateProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + formats: + description: |- + An array of the expected date formats. + Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + type: array + items: + type: string + locale: + description: |- + The locale to use when parsing the date, relevant when parsing month names or week days. + Supports template snippets. + type: string + target_field: + $ref: '_common.yaml#/components/schemas/Field' + timezone: + description: |- + The timezone to use when parsing the date. + Supports template snippets. + type: string + required: + - field + - formats + DateIndexNameProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + date_formats: + description: |- + An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. + Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N. + type: array + items: + type: string + date_rounding: + description: |- + 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. + type: string + field: + $ref: '_common.yaml#/components/schemas/Field' + index_name_format: + description: |- + The format to be used when printing the parsed date into the index name. + A valid java time pattern is expected here. + Supports template snippets. + type: string + index_name_prefix: + description: |- + A prefix of the index name to be prepended before the printed date. + Supports template snippets. + type: string + locale: + description: The locale to use when parsing the date from the document being preprocessed, relevant when parsing month + names or week days. + type: string + timezone: + description: The timezone to use when parsing the date and when date math index supports resolves expressions into + concrete index names. + type: string + required: + - date_formats + - date_rounding + - field + DotExpanderProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + path: + description: >- + The field that contains the field to expand. + + Only required if the field to expand is part another object field, because the `field` option can only understand leaf fields. + type: string + required: + - field + EnrichProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + type: boolean + max_matches: + description: >- + The maximum number of matched documents to include under the configured target field. + + The `target_field` will be turned into a json array if `max_matches` is higher than 1, otherwise `target_field` will become a json object. + + In order to avoid documents getting too large, the maximum allowed value is 128. + type: number + override: + description: |- + If processor will update fields with pre-existing non-null-valued field. + When set to `false`, such fields will not be touched. + type: boolean + policy_name: + description: The name of the enrich policy to use. + type: string + shape_relation: + $ref: '_common.yaml#/components/schemas/GeoShapeRelation' + target_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + - policy_name + - target_field + FailProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + message: + description: |- + The error message thrown by the processor. + Supports template snippets. + type: string + required: + - message + ForeachProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true`, the processor silently exits without changing the document if the `field` is `null` or missing. + type: boolean + processor: + $ref: '#/components/schemas/ProcessorContainer' + required: + - field + - processor + JsonProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + add_to_root: + description: |- + Flag that forces the parsed JSON to be added at the top level of the document. + `target_field` must not be set when this option is chosen. + type: boolean + add_to_root_conflict_strategy: + $ref: '#/components/schemas/JsonProcessorConflictStrategy' + allow_duplicate_keys: + description: |- + When set to `true`, the JSON parser will not fail if the JSON contains duplicate keys. + Instead, the last encountered value for any duplicate key wins. + type: boolean + field: + $ref: '_common.yaml#/components/schemas/Field' + target_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + JsonProcessorConflictStrategy: + type: string + enum: + - replace + - merge + UserAgentProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + type: boolean + options: + type: array + items: + $ref: '#/components/schemas/UserAgentProperty' + regex_file: + description: The name of the file in the `config/ingest-user-agent` directory containing the regular expressions for + parsing the user agent string. Both the directory and the file have to be created before starting + Opensearch. If not specified, ingest-user-agent will use the `regexes.yaml` from uap-core it ships with. + type: string + target_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + UserAgentProperty: + type: string + enum: + - NAME + - MAJOR + - MINOR + - PATCH + - OS + - OS_NAME + - OS_MAJOR + - OS_MINOR + - DEVICE + - BUILD + KeyValueProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + exclude_keys: + description: List of keys to exclude from document. + type: array + items: + type: string + field: + $ref: '_common.yaml#/components/schemas/Field' + field_split: + description: Regex pattern to use for splitting key-value pairs. + type: string + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the + document. + type: boolean + include_keys: + description: |- + List of keys to filter and insert into document. + Defaults to including all keys. + type: array + items: + type: string + prefix: + description: Prefix to be added to extracted keys. + type: string + strip_brackets: + description: If `true`. strip brackets `()`, `<>`, `[]` as well as quotes `'` and `"` from extracted values. + type: boolean + target_field: + $ref: '_common.yaml#/components/schemas/Field' + trim_key: + description: String of characters to trim from extracted keys. + type: string + trim_value: + description: String of characters to trim from extracted values. + type: string + value_split: + description: Regex pattern to use for splitting the key from the value within a key-value pair. + type: string + required: + - field + - field_split + - value_split + GeoIpProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + database_file: + description: The database filename referring to a database the module ships with (GeoLite2-City.mmdb, + GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom database in the ingest-geoip config directory. + type: string + field: + $ref: '_common.yaml#/components/schemas/Field' + first_only: + description: If `true`, only the first found geoip data will be returned, even if the field contains an array. + type: boolean + ignore_missing: + description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + type: boolean + properties: + description: Controls what properties are added to the `target_field` based on the geoip lookup. + type: array + items: + type: string + target_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + GrokProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the + document. + type: boolean + pattern_definitions: + description: |- + A map of pattern-name and pattern tuples defining custom patterns to be used by the current processor. + Patterns matching existing names will override the pre-existing definition. + type: object + additionalProperties: + type: string + patterns: + description: |- + An ordered list of grok expression to match and extract named captures with. + Returns on the first expression in the list that matches. + type: array + items: + type: string + trace_match: + description: When `true`, `_ingest._grok_match_index` will be inserted into your matched document’s metadata with the + index into the pattern found in `patterns` that matched. + type: boolean + required: + - field + - patterns + GsubProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the + document. + type: boolean + pattern: + description: The pattern to be replaced. + type: string + replacement: + description: The string to replace the matching patterns with. + type: string + target_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + - pattern + - replacement + JoinProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + separator: + description: The separator character. + type: string + target_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + - separator + LowercaseProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the + document. + type: boolean + target_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + RemoveProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Fields' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the + document. + type: boolean + required: + - field + RenameProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + type: boolean + target_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + - target_field + SetProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + copy_from: + $ref: '_common.yaml#/components/schemas/Field' + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_empty_value: + description: If `true` and `value` is a template snippet that evaluates to `null` or the empty string, the processor + quietly exits without modifying the document. + type: boolean + media_type: + description: |- + The media type for encoding `value`. + Applies only when value is a template snippet. + Must be one of `application/json`, `text/plain`, or `application/x-www-form-urlencoded`. + type: string + override: + description: |- + If `true` processor will update fields with pre-existing non-null-valued field. + When set to `false`, such fields will not be touched. + type: boolean + value: + description: |- + The value to be set for the field. + Supports template snippets. + May specify only one of `value` or `copy_from`. + type: object + required: + - field + SortProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + order: + $ref: '_common.yaml#/components/schemas/SortOrder' + target_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + SplitProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + type: boolean + preserve_trailing: + description: Preserves empty trailing fields, if any. + type: boolean + separator: + description: A regex which matches the separator, for example, `,` or `\s+`. + type: string + target_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + - separator + TrimProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + type: boolean + target_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + UppercaseProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the + document. + type: boolean + target_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + UrlDecodeProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the + document. + type: boolean + target_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + BytesProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the + document. + type: boolean + target_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - field + DissectProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + append_separator: + description: The character(s) that separate the appended fields. + type: string + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true` and `field` does not exist or is `null`, the processor quietly exits without modifying the + document. + type: boolean + pattern: + description: The pattern to apply to the field. + type: string + required: + - field + - pattern + SetSecurityUserProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + field: + $ref: '_common.yaml#/components/schemas/Field' + properties: + description: Controls what user related properties are added to the field. + type: array + items: + type: string + required: + - field + PipelineProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + ignore_missing_pipeline: + description: Whether to ignore missing pipelines instead of failing. + type: boolean + required: + - name + DropProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + CircleProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + error_distance: + description: The difference between the resulting inscribed distance from center to side and the circle’s radius + (measured in meters for `geo_shape`, unit-less for `shape`). + type: number + field: + $ref: '_common.yaml#/components/schemas/Field' + ignore_missing: + description: If `true` and `field` does not exist, the processor quietly exits without modifying the document. + type: boolean + shape_type: + $ref: '#/components/schemas/ShapeType' + target_field: + $ref: '_common.yaml#/components/schemas/Field' + required: + - error_distance + - field + - shape_type + ShapeType: + type: string + enum: + - geo_shape + - shape + InferenceProcessor: + allOf: + - $ref: '#/components/schemas/ProcessorBase' + - type: object + properties: + model_id: + $ref: '_common.yaml#/components/schemas/Id' + target_field: + $ref: '_common.yaml#/components/schemas/Field' + field_map: + description: |- + Maps the document field names to the known field names of the model. + This mapping takes precedence over any default mappings provided in the model configuration. + type: object + additionalProperties: + type: object + inference_config: + $ref: '#/components/schemas/InferenceConfig' + required: + - model_id + InferenceConfig: + type: object + properties: + regression: + $ref: '#/components/schemas/InferenceConfigRegression' + classification: + $ref: '#/components/schemas/InferenceConfigClassification' + minProperties: 1 + maxProperties: 1 + InferenceConfigRegression: + type: object + properties: + results_field: + $ref: '_common.yaml#/components/schemas/Field' + num_top_feature_importance_values: + description: Specifies the maximum number of feature importance values per document. + type: number + InferenceConfigClassification: + type: object + properties: + num_top_classes: + description: Specifies the number of top class predictions to return. + type: number + num_top_feature_importance_values: + description: Specifies the maximum number of feature importance values per document. + type: number + results_field: + $ref: '_common.yaml#/components/schemas/Field' + top_classes_results_field: + $ref: '_common.yaml#/components/schemas/Field' + prediction_field_type: + description: |- + Specifies the type of the predicted field to write. + Valid values are: `string`, `number`, `boolean`. + type: string diff --git a/spec/schemas/ingest.simulate.yaml b/spec/schemas/ingest.simulate.yaml new file mode 100644 index 00000000..1efcc86d --- /dev/null +++ b/spec/schemas/ingest.simulate.yaml @@ -0,0 +1,70 @@ +openapi: 3.1.0 +info: + title: Schemas of ingest.simulate category + description: Schemas of ingest.simulate category + version: 1.0.0 +paths: {} +components: + schemas: + Document: + type: object + properties: + _id: + $ref: '_common.yaml#/components/schemas/Id' + _index: + $ref: '_common.yaml#/components/schemas/IndexName' + _source: + description: JSON body for the document. + type: object + required: + - _source + PipelineSimulation: + type: object + properties: + doc: + $ref: '#/components/schemas/DocumentSimulation' + processor_results: + type: array + items: + $ref: '#/components/schemas/PipelineSimulation' + tag: + type: string + processor_type: + type: string + status: + $ref: '_common.yaml#/components/schemas/ActionStatusOptions' + DocumentSimulation: + type: object + properties: + _id: + $ref: '_common.yaml#/components/schemas/Id' + _index: + $ref: '_common.yaml#/components/schemas/IndexName' + _ingest: + $ref: '#/components/schemas/Ingest' + _routing: + description: Value used to send the document to a specific primary shard. + type: string + _source: + description: JSON body for the document. + type: object + additionalProperties: + type: object + _version: + $ref: '_common.yaml#/components/schemas/StringifiedVersionNumber' + _version_type: + $ref: '_common.yaml#/components/schemas/VersionType' + required: + - _id + - _index + - _ingest + - _source + Ingest: + type: object + properties: + timestamp: + $ref: '_common.yaml#/components/schemas/DateTime' + pipeline: + $ref: '_common.yaml#/components/schemas/Name' + required: + - timestamp diff --git a/spec/schemas/knn._common.yaml b/spec/schemas/knn._common.yaml new file mode 100644 index 00000000..dc1500b8 --- /dev/null +++ b/spec/schemas/knn._common.yaml @@ -0,0 +1,27 @@ +openapi: 3.1.0 +info: + title: Schemas of knn._common category + description: Schemas of knn._common category + version: 1.0.0 +paths: {} +components: + schemas: + DefaultOperator: + type: string + description: The default operator for query string query (AND or OR). + enum: + - AND + - OR + SearchType: + type: string + description: Search operation type. + enum: + - query_then_fetch + - dfs_query_then_fetch + SuggestMode: + type: string + description: Specify suggest mode. + enum: + - missing + - popular + - always diff --git a/spec/schemas/nodes._common.yaml b/spec/schemas/nodes._common.yaml new file mode 100644 index 00000000..c88659a2 --- /dev/null +++ b/spec/schemas/nodes._common.yaml @@ -0,0 +1,971 @@ +openapi: 3.1.0 +info: + title: Schemas of nodes._common category + description: Schemas of nodes._common category + version: 1.0.0 +paths: {} +components: + schemas: + Http: + type: object + properties: + current_open: + description: Current number of open HTTP connections for the node. + type: number + total_opened: + description: Total number of HTTP connections opened for the node. + type: number + clients: + description: >- + Information on current and recently-closed HTTP client connections. + + Clients that have been closed longer than the `http.client_stats.closed_channels.max_age` setting will not be represented here. + type: array + items: + $ref: '#/components/schemas/Client' + Client: + type: object + properties: + id: + description: Unique ID for the HTTP client. + type: number + agent: + description: |- + Reported agent for the HTTP client. + If unavailable, this property is not included in the response. + type: string + local_address: + description: Local address for the HTTP connection. + type: string + remote_address: + description: Remote address for the HTTP connection. + type: string + last_uri: + description: The URI of the client’s most recent request. + type: string + opened_time_millis: + description: Time at which the client opened the connection. + type: number + closed_time_millis: + description: Time at which the client closed the connection if the connection is closed. + type: number + last_request_time_millis: + description: Time of the most recent request from this client. + type: number + request_count: + description: Number of requests from this client. + type: number + request_size_bytes: + description: Cumulative size in bytes of all requests from this client. + type: number + x_opaque_id: + description: |- + Value from the client’s `x-opaque-id` HTTP header. + If unavailable, this property is not included in the response. + type: string + Ingest: + type: object + properties: + pipelines: + description: Contains statistics about ingest pipelines for the node. + type: object + additionalProperties: + $ref: '#/components/schemas/IngestTotal' + total: + $ref: '#/components/schemas/IngestTotal' + IngestTotal: + type: object + properties: + count: + description: Total number of documents ingested during the lifetime of this node. + type: number + current: + description: Total number of documents currently being ingested. + type: number + failed: + description: Total number of failed ingest operations during the lifetime of this node. + type: number + processors: + description: Total number of ingest processors. + type: array + items: + type: object + additionalProperties: + $ref: '#/components/schemas/KeyedProcessor' + time_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + KeyedProcessor: + type: object + properties: + stats: + $ref: '#/components/schemas/Processor' + type: + type: string + Processor: + type: object + properties: + count: + description: Number of documents transformed by the processor. + type: number + current: + description: Number of documents currently being transformed by the processor. + type: number + failed: + description: Number of failed operations for the processor. + type: number + time_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + ThreadCount: + type: object + properties: + active: + description: Number of active threads in the thread pool. + type: number + completed: + description: Number of tasks completed by the thread pool executor. + type: number + largest: + description: Highest number of active threads in the thread pool. + type: number + queue: + description: Number of tasks in queue for the thread pool. + type: number + rejected: + description: Number of tasks rejected by the thread pool executor. + type: number + threads: + description: Number of threads in the thread pool. + type: number + Scripting: + type: object + properties: + cache_evictions: + description: Total number of times the script cache has evicted old data. + type: number + compilations: + description: Total number of inline script compilations performed by the node. + type: number + compilations_history: + description: Contains this recent history of script compilations. + type: object + additionalProperties: + type: number + compilation_limit_triggered: + description: Total number of times the script compilation circuit breaker has limited inline script compilations. + type: number + contexts: + type: array + items: + $ref: '#/components/schemas/Context' + Context: + type: object + properties: + context: + type: string + compilations: + type: number + cache_evictions: + type: number + compilation_limit_triggered: + type: number + NodesResponseBase: + type: object + properties: + _nodes: + $ref: '_common.yaml#/components/schemas/NodeStatistics' + NodeReloadResult: + oneOf: + - $ref: '#/components/schemas/Stats' + - $ref: '#/components/schemas/NodeReloadError' + Stats: + type: object + properties: + adaptive_selection: + description: Statistics about adaptive replica selection. + type: object + additionalProperties: + $ref: '#/components/schemas/AdaptiveSelection' + breakers: + description: Statistics about the field data circuit breaker. + type: object + additionalProperties: + $ref: '#/components/schemas/Breaker' + fs: + $ref: '#/components/schemas/FileSystem' + host: + $ref: '_common.yaml#/components/schemas/Host' + http: + $ref: '#/components/schemas/Http' + ingest: + $ref: '#/components/schemas/Ingest' + ip: + description: IP address and port for the node. + oneOf: + - $ref: '_common.yaml#/components/schemas/Ip' + - type: array + items: + $ref: '_common.yaml#/components/schemas/Ip' + jvm: + $ref: '#/components/schemas/Jvm' + name: + $ref: '_common.yaml#/components/schemas/Name' + os: + $ref: '#/components/schemas/OperatingSystem' + process: + $ref: '#/components/schemas/Process' + roles: + $ref: '_common.yaml#/components/schemas/NodeRoles' + script: + $ref: '#/components/schemas/Scripting' + script_cache: + type: object + additionalProperties: + oneOf: + - $ref: '#/components/schemas/ScriptCache' + - type: array + items: + $ref: '#/components/schemas/ScriptCache' + thread_pool: + description: Statistics about each thread pool, including current size, queue and rejected tasks. + type: object + additionalProperties: + $ref: '#/components/schemas/ThreadCount' + timestamp: + type: number + transport: + $ref: '#/components/schemas/Transport' + transport_address: + $ref: '_common.yaml#/components/schemas/TransportAddress' + attributes: + description: Contains a list of attributes for the node. + type: object + additionalProperties: + type: string + discovery: + $ref: '#/components/schemas/Discovery' + indexing_pressure: + $ref: '#/components/schemas/IndexingPressure' + indices: + $ref: 'indices.stats.yaml#/components/schemas/ShardStats' + AdaptiveSelection: + type: object + properties: + avg_queue_size: + description: The exponentially weighted moving average queue size of search requests on the keyed node. + type: number + avg_response_time: + $ref: '_common.yaml#/components/schemas/Duration' + avg_response_time_ns: + description: The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed + node. + type: number + avg_service_time: + $ref: '_common.yaml#/components/schemas/Duration' + avg_service_time_ns: + description: The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node. + type: number + outgoing_searches: + description: The number of outstanding search requests to the keyed node from the node these stats are for. + type: number + rank: + description: The rank of this node; used for shard selection when routing search requests. + type: string + Breaker: + type: object + properties: + estimated_size: + description: Estimated memory used for the operation. + type: string + estimated_size_in_bytes: + description: Estimated memory used, in bytes, for the operation. + type: number + limit_size: + description: Memory limit for the circuit breaker. + type: string + limit_size_in_bytes: + description: Memory limit, in bytes, for the circuit breaker. + type: number + overhead: + description: A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate. + type: number + tripped: + description: Total number of times the circuit breaker has been triggered and prevented an out of memory error. + type: number + FileSystem: + type: object + properties: + data: + description: List of all file stores. + type: array + items: + $ref: '#/components/schemas/DataPathStats' + timestamp: + description: |- + Last time the file stores statistics were refreshed. + Recorded in milliseconds since the Unix Epoch. + type: number + total: + $ref: '#/components/schemas/FileSystemTotal' + io_stats: + $ref: '#/components/schemas/IoStats' + DataPathStats: + type: object + properties: + available: + description: Total amount of disk space available to this Java virtual machine on this file store. + type: string + available_in_bytes: + description: Total number of bytes available to this Java virtual machine on this file store. + type: number + disk_queue: + type: string + disk_reads: + type: number + disk_read_size: + type: string + disk_read_size_in_bytes: + type: number + disk_writes: + type: number + disk_write_size: + type: string + disk_write_size_in_bytes: + type: number + free: + description: Total amount of unallocated disk space in the file store. + type: string + free_in_bytes: + description: Total number of unallocated bytes in the file store. + type: number + mount: + description: 'Mount point of the file store (for example: `/dev/sda2`).' + type: string + path: + description: Path to the file store. + type: string + total: + description: Total size of the file store. + type: string + total_in_bytes: + description: Total size of the file store in bytes. + type: number + type: + description: 'Type of the file store (ex: ext4).' + type: string + FileSystemTotal: + type: object + properties: + available: + description: |- + Total disk space available to this Java virtual machine on all file stores. + Depending on OS or process level restrictions, this might appear less than `free`. + This is the actual amount of free disk space the Opensearch node can utilise. + type: string + available_in_bytes: + description: |- + Total number of bytes available to this Java virtual machine on all file stores. + Depending on OS or process level restrictions, this might appear less than `free_in_bytes`. + This is the actual amount of free disk space the Opensearch node can utilise. + type: number + free: + description: Total unallocated disk space in all file stores. + type: string + free_in_bytes: + description: Total number of unallocated bytes in all file stores. + type: number + total: + description: Total size of all file stores. + type: string + total_in_bytes: + description: Total size of all file stores in bytes. + type: number + IoStats: + type: object + properties: + devices: + description: >- + Array of disk metrics for each device that is backing an Opensearch data path. + + These disk metrics are probed periodically and averages between the last probe and the current probe are computed. + type: array + items: + $ref: '#/components/schemas/IoStatDevice' + total: + $ref: '#/components/schemas/IoStatDevice' + IoStatDevice: + type: object + properties: + device_name: + description: The Linux device name. + type: string + operations: + description: The total number of read and write operations for the device completed since starting Opensearch. + type: number + read_kilobytes: + description: The total number of kilobytes read for the device since starting Opensearch. + type: number + read_operations: + description: The total number of read operations for the device completed since starting Opensearch. + type: number + write_kilobytes: + description: The total number of kilobytes written for the device since starting Opensearch. + type: number + write_operations: + description: The total number of write operations for the device completed since starting Opensearch. + type: number + Jvm: + type: object + properties: + buffer_pools: + description: Contains statistics about JVM buffer pools for the node. + type: object + additionalProperties: + $ref: '#/components/schemas/NodeBufferPool' + classes: + $ref: '#/components/schemas/JvmClasses' + gc: + $ref: '#/components/schemas/GarbageCollector' + mem: + $ref: '#/components/schemas/JvmMemoryStats' + threads: + $ref: '#/components/schemas/JvmThreads' + timestamp: + description: Last time JVM statistics were refreshed. + type: number + uptime: + description: |- + Human-readable JVM uptime. + Only returned if the `human` query parameter is `true`. + type: string + uptime_in_millis: + description: JVM uptime in milliseconds. + type: number + NodeBufferPool: + type: object + properties: + count: + description: Number of buffer pools. + type: number + total_capacity: + description: Total capacity of buffer pools. + type: string + total_capacity_in_bytes: + description: Total capacity of buffer pools in bytes. + type: number + used: + description: Size of buffer pools. + type: string + used_in_bytes: + description: Size of buffer pools in bytes. + type: number + JvmClasses: + type: object + properties: + current_loaded_count: + description: Number of classes currently loaded by JVM. + type: number + total_loaded_count: + description: Total number of classes loaded since the JVM started. + type: number + total_unloaded_count: + description: Total number of classes unloaded since the JVM started. + type: number + GarbageCollector: + type: object + properties: + collectors: + description: Contains statistics about JVM garbage collectors for the node. + type: object + additionalProperties: + $ref: '#/components/schemas/GarbageCollectorTotal' + GarbageCollectorTotal: + type: object + properties: + collection_count: + description: Total number of JVM garbage collectors that collect objects. + type: number + collection_time: + description: Total time spent by JVM collecting objects. + type: string + collection_time_in_millis: + description: Total time, in milliseconds, spent by JVM collecting objects. + type: number + JvmMemoryStats: + type: object + properties: + heap_used_in_bytes: + description: Memory, in bytes, currently in use by the heap. + type: number + heap_used_percent: + description: Percentage of memory currently in use by the heap. + type: number + heap_committed_in_bytes: + description: Amount of memory, in bytes, available for use by the heap. + type: number + heap_max_in_bytes: + description: Maximum amount of memory, in bytes, available for use by the heap. + type: number + non_heap_used_in_bytes: + description: Non-heap memory used, in bytes. + type: number + non_heap_committed_in_bytes: + description: Amount of non-heap memory available, in bytes. + type: number + pools: + description: Contains statistics about heap memory usage for the node. + type: object + additionalProperties: + $ref: '#/components/schemas/Pool' + Pool: + type: object + properties: + used_in_bytes: + description: Memory, in bytes, used by the heap. + type: number + max_in_bytes: + description: Maximum amount of memory, in bytes, available for use by the heap. + type: number + peak_used_in_bytes: + description: Largest amount of memory, in bytes, historically used by the heap. + type: number + peak_max_in_bytes: + description: Largest amount of memory, in bytes, historically used by the heap. + type: number + JvmThreads: + type: object + properties: + count: + description: Number of active threads in use by JVM. + type: number + peak_count: + description: Highest number of threads used by JVM. + type: number + OperatingSystem: + type: object + properties: + cpu: + $ref: '#/components/schemas/Cpu' + mem: + $ref: '#/components/schemas/ExtendedMemoryStats' + swap: + $ref: '#/components/schemas/MemoryStats' + cgroup: + $ref: '#/components/schemas/Cgroup' + timestamp: + type: number + Cpu: + type: object + properties: + percent: + type: number + sys: + $ref: '_common.yaml#/components/schemas/Duration' + sys_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + total: + $ref: '_common.yaml#/components/schemas/Duration' + total_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + user: + $ref: '_common.yaml#/components/schemas/Duration' + user_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + load_average: + type: object + additionalProperties: + type: number + ExtendedMemoryStats: + allOf: + - $ref: '#/components/schemas/MemoryStats' + - type: object + properties: + free_percent: + description: Percentage of free memory. + type: number + used_percent: + description: Percentage of used memory. + type: number + MemoryStats: + type: object + properties: + adjusted_total_in_bytes: + description: >- + If the amount of physical memory has been overridden using the `es`.`total_memory_bytes` system property + then this reports the overridden value in bytes. + + Otherwise it reports the same value as `total_in_bytes`. + type: number + resident: + type: string + resident_in_bytes: + type: number + share: + type: string + share_in_bytes: + type: number + total_virtual: + type: string + total_virtual_in_bytes: + type: number + total_in_bytes: + description: Total amount of physical memory in bytes. + type: number + free_in_bytes: + description: Amount of free physical memory in bytes. + type: number + used_in_bytes: + description: Amount of used physical memory in bytes. + type: number + Cgroup: + type: object + properties: + cpuacct: + $ref: '#/components/schemas/CpuAcct' + cpu: + $ref: '#/components/schemas/CgroupCpu' + memory: + $ref: '#/components/schemas/CgroupMemory' + CpuAcct: + type: object + properties: + control_group: + description: The `cpuacct` control group to which the Opensearch process belongs. + type: string + usage_nanos: + $ref: '_common.yaml#/components/schemas/DurationValueUnitNanos' + CgroupCpu: + type: object + properties: + control_group: + description: The `cpu` control group to which the Opensearch process belongs. + type: string + cfs_period_micros: + description: The period of time, in microseconds, for how regularly all tasks in the same cgroup as the Opensearch + process should have their access to CPU resources reallocated. + type: number + cfs_quota_micros: + description: The total amount of time, in microseconds, for which all tasks in the same cgroup as the Opensearch process + can run during one period `cfs_period_micros`. + type: number + stat: + $ref: '#/components/schemas/CgroupCpuStat' + CgroupCpuStat: + type: object + properties: + number_of_elapsed_periods: + description: The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed. + type: number + number_of_times_throttled: + description: The number of times all tasks in the same cgroup as the Opensearch process have been throttled. + type: number + time_throttled_nanos: + $ref: '_common.yaml#/components/schemas/DurationValueUnitNanos' + CgroupMemory: + type: object + properties: + control_group: + description: The `memory` control group to which the Opensearch process belongs. + type: string + limit_in_bytes: + description: >- + The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the + Opensearch process. + + This value can be too big to store in a `long`, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns. + + Any value that is too large to parse into a `long` almost certainly means no limit has been set for the cgroup. + type: string + usage_in_bytes: + description: >- + The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the + Opensearch process. + + This value is stored as a string for consistency with `limit_in_bytes`. + type: string + Process: + type: object + properties: + cpu: + $ref: '#/components/schemas/Cpu' + mem: + $ref: '#/components/schemas/MemoryStats' + open_file_descriptors: + description: Number of opened file descriptors associated with the current or `-1` if not supported. + type: number + max_file_descriptors: + description: Maximum number of file descriptors allowed on the system, or `-1` if not supported. + type: number + timestamp: + description: |- + Last time the statistics were refreshed. + Recorded in milliseconds since the Unix Epoch. + type: number + ScriptCache: + type: object + properties: + cache_evictions: + description: Total number of times the script cache has evicted old data. + type: number + compilation_limit_triggered: + description: Total number of times the script compilation circuit breaker has limited inline script compilations. + type: number + compilations: + description: Total number of inline script compilations performed by the node. + type: number + context: + type: string + Transport: + type: object + properties: + inbound_handling_time_histogram: + description: The distribution of the time spent handling each inbound message on a transport thread, represented as a + histogram. + type: array + items: + $ref: '#/components/schemas/TransportHistogram' + outbound_handling_time_histogram: + description: The distribution of the time spent sending each outbound transport message on a transport thread, + represented as a histogram. + type: array + items: + $ref: '#/components/schemas/TransportHistogram' + rx_count: + description: Total number of RX (receive) packets received by the node during internal cluster communication. + type: number + rx_size: + description: Size of RX packets received by the node during internal cluster communication. + type: string + rx_size_in_bytes: + description: Size, in bytes, of RX packets received by the node during internal cluster communication. + type: number + server_open: + description: Current number of inbound TCP connections used for internal communication between nodes. + type: number + tx_count: + description: Total number of TX (transmit) packets sent by the node during internal cluster communication. + type: number + tx_size: + description: Size of TX packets sent by the node during internal cluster communication. + type: string + tx_size_in_bytes: + description: Size, in bytes, of TX packets sent by the node during internal cluster communication. + type: number + total_outbound_connections: + description: |- + The cumulative number of outbound transport connections that this node has opened since it started. + Each transport connection may comprise multiple TCP connections but is only counted once in this statistic. + Transport connections are typically long-lived so this statistic should remain constant in a stable cluster. + type: number + TransportHistogram: + type: object + properties: + count: + description: The number of times a transport thread took a period of time within the bounds of this bucket to handle an + inbound message. + type: number + lt_millis: + description: |- + The exclusive upper bound of the bucket in milliseconds. + May be omitted on the last bucket if this bucket has no upper bound. + type: number + ge_millis: + description: The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket + has no lower bound. + type: number + Discovery: + type: object + properties: + cluster_state_queue: + $ref: '#/components/schemas/ClusterStateQueue' + published_cluster_states: + $ref: '#/components/schemas/PublishedClusterStates' + cluster_state_update: + description: >- + Contains low-level statistics about how long various activities took during cluster state updates while the + node was the elected master. + + Omitted if the node is not master-eligible. + + Every field whose name ends in `_time` within this object is also represented as a raw number of milliseconds in a field whose name ends in `_time_millis`. + + The human-readable fields with a `_time` suffix are only returned if requested with the `?human=true` query parameter. + type: object + additionalProperties: + $ref: '#/components/schemas/ClusterStateUpdate' + serialized_cluster_states: + $ref: '#/components/schemas/SerializedClusterState' + cluster_applier_stats: + $ref: '#/components/schemas/ClusterAppliedStats' + ClusterStateQueue: + type: object + properties: + total: + description: Total number of cluster states in queue. + type: number + pending: + description: Number of pending cluster states in queue. + type: number + committed: + description: Number of committed cluster states in queue. + type: number + PublishedClusterStates: + type: object + properties: + full_states: + description: Number of published cluster states. + type: number + incompatible_diffs: + description: Number of incompatible differences between published cluster states. + type: number + compatible_diffs: + description: Number of compatible differences between published cluster states. + type: number + ClusterStateUpdate: + type: object + properties: + count: + description: The number of cluster state update attempts that did not change the cluster state since the node started. + type: number + computation_time: + $ref: '_common.yaml#/components/schemas/Duration' + computation_time_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + publication_time: + $ref: '_common.yaml#/components/schemas/Duration' + publication_time_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + context_construction_time: + $ref: '_common.yaml#/components/schemas/Duration' + context_construction_time_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + commit_time: + $ref: '_common.yaml#/components/schemas/Duration' + commit_time_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + completion_time: + $ref: '_common.yaml#/components/schemas/Duration' + completion_time_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + master_apply_time: + $ref: '_common.yaml#/components/schemas/Duration' + master_apply_time_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + notification_time: + $ref: '_common.yaml#/components/schemas/Duration' + notification_time_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + required: + - count + SerializedClusterState: + type: object + properties: + full_states: + $ref: '#/components/schemas/SerializedClusterStateDetail' + diffs: + $ref: '#/components/schemas/SerializedClusterStateDetail' + SerializedClusterStateDetail: + type: object + properties: + count: + type: number + uncompressed_size: + type: string + uncompressed_size_in_bytes: + type: number + compressed_size: + type: string + compressed_size_in_bytes: + type: number + ClusterAppliedStats: + type: object + properties: + recordings: + type: array + items: + $ref: '#/components/schemas/Recording' + Recording: + type: object + properties: + name: + type: string + cumulative_execution_count: + type: number + cumulative_execution_time: + $ref: '_common.yaml#/components/schemas/Duration' + cumulative_execution_time_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + IndexingPressure: + type: object + properties: + memory: + $ref: '#/components/schemas/IndexingPressureMemory' + IndexingPressureMemory: + type: object + properties: + limit: + $ref: '_common.yaml#/components/schemas/ByteSize' + limit_in_bytes: + description: |- + Configured memory limit, in bytes, for the indexing requests. + Replica requests have an automatic limit that is 1.5x this value. + type: number + current: + $ref: '#/components/schemas/PressureMemory' + total: + $ref: '#/components/schemas/PressureMemory' + PressureMemory: + type: object + properties: + all: + $ref: '_common.yaml#/components/schemas/ByteSize' + all_in_bytes: + description: Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage. + type: number + combined_coordinating_and_primary: + $ref: '_common.yaml#/components/schemas/ByteSize' + combined_coordinating_and_primary_in_bytes: + description: >- + Memory consumed, in bytes, by indexing requests in the coordinating or primary stage. + + This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. + type: number + coordinating: + $ref: '_common.yaml#/components/schemas/ByteSize' + coordinating_in_bytes: + description: Memory consumed, in bytes, by indexing requests in the coordinating stage. + type: number + primary: + $ref: '_common.yaml#/components/schemas/ByteSize' + primary_in_bytes: + description: Memory consumed, in bytes, by indexing requests in the primary stage. + type: number + replica: + $ref: '_common.yaml#/components/schemas/ByteSize' + replica_in_bytes: + description: Memory consumed, in bytes, by indexing requests in the replica stage. + type: number + coordinating_rejections: + description: Number of indexing requests rejected in the coordinating stage. + type: number + primary_rejections: + description: Number of indexing requests rejected in the primary stage. + type: number + replica_rejections: + description: Number of indexing requests rejected in the replica stage. + type: number + NodeReloadError: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + reload_exception: + $ref: '_common.yaml#/components/schemas/ErrorCause' + required: + - name + SampleType: + type: string + description: The type to sample. + enum: + - cpu + - wait + - block diff --git a/spec/schemas/nodes.info.yaml b/spec/schemas/nodes.info.yaml new file mode 100644 index 00000000..064b4235 --- /dev/null +++ b/spec/schemas/nodes.info.yaml @@ -0,0 +1,661 @@ +openapi: 3.1.0 +info: + title: Schemas of nodes.info category + description: Schemas of nodes.info category + version: 1.0.0 +paths: {} +components: + schemas: + ResponseBase: + allOf: + - $ref: 'nodes._common.yaml#/components/schemas/NodesResponseBase' + - type: object + properties: + cluster_name: + $ref: '_common.yaml#/components/schemas/Name' + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/NodeInfo' + required: + - cluster_name + - nodes + NodeInfo: + type: object + properties: + attributes: + type: object + additionalProperties: + type: string + build_flavor: + type: string + build_hash: + description: Short hash of the last git commit in this release. + type: string + build_type: + type: string + host: + $ref: '_common.yaml#/components/schemas/Host' + http: + $ref: '#/components/schemas/NodeInfoHttp' + ip: + $ref: '_common.yaml#/components/schemas/Ip' + jvm: + $ref: '#/components/schemas/NodeJvmInfo' + name: + $ref: '_common.yaml#/components/schemas/Name' + network: + $ref: '#/components/schemas/NodeInfoNetwork' + os: + $ref: '#/components/schemas/NodeOperatingSystemInfo' + plugins: + type: array + items: + $ref: '_common.yaml#/components/schemas/PluginStats' + process: + $ref: '#/components/schemas/NodeProcessInfo' + roles: + $ref: '_common.yaml#/components/schemas/NodeRoles' + settings: + $ref: '#/components/schemas/NodeInfoSettings' + thread_pool: + type: object + additionalProperties: + $ref: '#/components/schemas/NodeThreadPoolInfo' + total_indexing_buffer: + description: Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This + size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings. + type: number + total_indexing_buffer_in_bytes: + $ref: '_common.yaml#/components/schemas/ByteSize' + transport: + $ref: '#/components/schemas/NodeInfoTransport' + transport_address: + $ref: '_common.yaml#/components/schemas/TransportAddress' + version: + $ref: '_common.yaml#/components/schemas/VersionString' + modules: + type: array + items: + $ref: '_common.yaml#/components/schemas/PluginStats' + ingest: + $ref: '#/components/schemas/NodeInfoIngest' + aggregations: + type: object + additionalProperties: + $ref: '#/components/schemas/NodeInfoAggregation' + required: + - attributes + - build_flavor + - build_hash + - build_type + - host + - ip + - name + - roles + - transport_address + - version + NodeInfoHttp: + type: object + properties: + bound_address: + type: array + items: + type: string + max_content_length: + $ref: '_common.yaml#/components/schemas/ByteSize' + max_content_length_in_bytes: + type: number + publish_address: + type: string + required: + - bound_address + - max_content_length_in_bytes + - publish_address + NodeJvmInfo: + type: object + properties: + gc_collectors: + type: array + items: + type: string + mem: + $ref: '#/components/schemas/NodeInfoJvmMemory' + memory_pools: + type: array + items: + type: string + pid: + type: number + start_time_in_millis: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + version: + $ref: '_common.yaml#/components/schemas/VersionString' + vm_name: + $ref: '_common.yaml#/components/schemas/Name' + vm_vendor: + type: string + vm_version: + $ref: '_common.yaml#/components/schemas/VersionString' + using_bundled_jdk: + type: boolean + using_compressed_ordinary_object_pointers: + oneOf: + - type: boolean + - type: string + input_arguments: + type: array + items: + type: string + required: + - gc_collectors + - mem + - memory_pools + - pid + - start_time_in_millis + - version + - vm_name + - vm_vendor + - vm_version + - using_bundled_jdk + - input_arguments + NodeInfoJvmMemory: + type: object + properties: + direct_max: + $ref: '_common.yaml#/components/schemas/ByteSize' + direct_max_in_bytes: + type: number + heap_init: + $ref: '_common.yaml#/components/schemas/ByteSize' + heap_init_in_bytes: + type: number + heap_max: + $ref: '_common.yaml#/components/schemas/ByteSize' + heap_max_in_bytes: + type: number + non_heap_init: + $ref: '_common.yaml#/components/schemas/ByteSize' + non_heap_init_in_bytes: + type: number + non_heap_max: + $ref: '_common.yaml#/components/schemas/ByteSize' + non_heap_max_in_bytes: + type: number + required: + - direct_max_in_bytes + - heap_init_in_bytes + - heap_max_in_bytes + - non_heap_init_in_bytes + - non_heap_max_in_bytes + NodeInfoNetwork: + type: object + properties: + primary_interface: + $ref: '#/components/schemas/NodeInfoNetworkInterface' + refresh_interval: + type: number + required: + - primary_interface + - refresh_interval + NodeInfoNetworkInterface: + type: object + properties: + address: + type: string + mac_address: + type: string + name: + $ref: '_common.yaml#/components/schemas/Name' + required: + - address + - mac_address + - name + NodeOperatingSystemInfo: + type: object + properties: + arch: + description: 'Name of the JVM architecture (ex: amd64, x86)' + type: string + available_processors: + description: Number of processors available to the Java virtual machine + type: number + allocated_processors: + description: The number of processors actually used to calculate thread pool size. This number can be set with the + node.processors setting of a node and defaults to the number of processors reported by the OS. + type: number + name: + $ref: '_common.yaml#/components/schemas/Name' + pretty_name: + $ref: '_common.yaml#/components/schemas/Name' + refresh_interval_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + version: + $ref: '_common.yaml#/components/schemas/VersionString' + cpu: + $ref: '#/components/schemas/NodeInfoOSCPU' + mem: + $ref: '#/components/schemas/NodeInfoMemory' + swap: + $ref: '#/components/schemas/NodeInfoMemory' + required: + - arch + - available_processors + - name + - pretty_name + - refresh_interval_in_millis + - version + NodeInfoOSCPU: + type: object + properties: + cache_size: + type: string + cache_size_in_bytes: + type: number + cores_per_socket: + type: number + mhz: + type: number + model: + type: string + total_cores: + type: number + total_sockets: + type: number + vendor: + type: string + required: + - cache_size + - cache_size_in_bytes + - cores_per_socket + - mhz + - model + - total_cores + - total_sockets + - vendor + NodeInfoMemory: + type: object + properties: + total: + type: string + total_in_bytes: + type: number + required: + - total + - total_in_bytes + NodeProcessInfo: + type: object + properties: + id: + description: Process identifier (PID) + type: number + mlockall: + description: Indicates if the process address space has been successfully locked in memory + type: boolean + refresh_interval_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + required: + - id + - mlockall + - refresh_interval_in_millis + NodeInfoSettings: + type: object + properties: + cluster: + $ref: '#/components/schemas/NodeInfoSettingsCluster' + node: + $ref: '#/components/schemas/NodeInfoSettingsNode' + path: + $ref: '#/components/schemas/NodeInfoPath' + repositories: + $ref: '#/components/schemas/NodeInfoRepositories' + discovery: + $ref: '#/components/schemas/NodeInfoDiscover' + action: + $ref: '#/components/schemas/NodeInfoAction' + client: + $ref: '#/components/schemas/NodeInfoClient' + http: + $ref: '#/components/schemas/NodeInfoSettingsHttp' + bootstrap: + $ref: '#/components/schemas/NodeInfoBootstrap' + transport: + $ref: '#/components/schemas/NodeInfoSettingsTransport' + network: + $ref: '#/components/schemas/NodeInfoSettingsNetwork' + script: + $ref: '#/components/schemas/NodeInfoScript' + search: + $ref: '#/components/schemas/NodeInfoSearch' + ingest: + $ref: '#/components/schemas/NodeInfoSettingsIngest' + required: + - cluster + - node + - path + - client + - http + - transport + NodeInfoSettingsCluster: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + routing: + $ref: 'indices._common.yaml#/components/schemas/IndexRouting' + election: + $ref: '#/components/schemas/NodeInfoSettingsClusterElection' + initial_master_nodes: + type: string + deprecation_indexing: + $ref: '#/components/schemas/DeprecationIndexing' + required: + - name + - election + NodeInfoSettingsClusterElection: + type: object + properties: + strategy: + $ref: '_common.yaml#/components/schemas/Name' + required: + - strategy + DeprecationIndexing: + type: object + properties: + enabled: + oneOf: + - type: boolean + - type: string + required: + - enabled + NodeInfoSettingsNode: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + attr: + type: object + additionalProperties: + type: object + max_local_storage_nodes: + type: string + required: + - name + - attr + NodeInfoPath: + type: object + properties: + logs: + type: string + home: + type: string + repo: + type: array + items: + type: string + data: + type: array + items: + type: string + required: + - logs + - home + - repo + NodeInfoRepositories: + type: object + properties: + url: + $ref: '#/components/schemas/NodeInfoRepositoriesUrl' + required: + - url + NodeInfoRepositoriesUrl: + type: object + properties: + allowed_urls: + type: string + required: + - allowed_urls + NodeInfoDiscover: + type: object + properties: + seed_hosts: + type: string + required: + - seed_hosts + NodeInfoAction: + type: object + properties: + destructive_requires_name: + type: string + required: + - destructive_requires_name + NodeInfoClient: + type: object + properties: + type: + type: string + required: + - type + NodeInfoSettingsHttp: + type: object + properties: + type: + $ref: '#/components/schemas/NodeInfoSettingsHttpType' + type.default: + type: string + compression: + oneOf: + - type: boolean + - type: string + port: + oneOf: + - type: number + - type: string + required: + - type + NodeInfoSettingsHttpType: + type: object + properties: + default: + type: string + required: + - default + NodeInfoBootstrap: + type: object + properties: + memory_lock: + type: string + required: + - memory_lock + NodeInfoSettingsTransport: + type: object + properties: + type: + $ref: '#/components/schemas/NodeInfoSettingsTransportType' + type.default: + type: string + required: + - type + NodeInfoSettingsTransportType: + type: object + properties: + default: + type: string + required: + - default + NodeInfoSettingsNetwork: + type: object + properties: + host: + $ref: '_common.yaml#/components/schemas/Host' + required: + - host + NodeInfoScript: + type: object + properties: + allowed_types: + type: string + disable_max_compilations_rate: + type: string + required: + - allowed_types + - disable_max_compilations_rate + NodeInfoSearch: + type: object + properties: + remote: + $ref: '#/components/schemas/NodeInfoSearchRemote' + required: + - remote + NodeInfoSearchRemote: + type: object + properties: + connect: + type: string + required: + - connect + NodeInfoSettingsIngest: + type: object + properties: + attachment: + $ref: '#/components/schemas/NodeInfoIngestInfo' + append: + $ref: '#/components/schemas/NodeInfoIngestInfo' + csv: + $ref: '#/components/schemas/NodeInfoIngestInfo' + convert: + $ref: '#/components/schemas/NodeInfoIngestInfo' + date: + $ref: '#/components/schemas/NodeInfoIngestInfo' + date_index_name: + $ref: '#/components/schemas/NodeInfoIngestInfo' + dot_expander: + $ref: '#/components/schemas/NodeInfoIngestInfo' + enrich: + $ref: '#/components/schemas/NodeInfoIngestInfo' + fail: + $ref: '#/components/schemas/NodeInfoIngestInfo' + foreach: + $ref: '#/components/schemas/NodeInfoIngestInfo' + json: + $ref: '#/components/schemas/NodeInfoIngestInfo' + user_agent: + $ref: '#/components/schemas/NodeInfoIngestInfo' + kv: + $ref: '#/components/schemas/NodeInfoIngestInfo' + geoip: + $ref: '#/components/schemas/NodeInfoIngestInfo' + grok: + $ref: '#/components/schemas/NodeInfoIngestInfo' + gsub: + $ref: '#/components/schemas/NodeInfoIngestInfo' + join: + $ref: '#/components/schemas/NodeInfoIngestInfo' + lowercase: + $ref: '#/components/schemas/NodeInfoIngestInfo' + remove: + $ref: '#/components/schemas/NodeInfoIngestInfo' + rename: + $ref: '#/components/schemas/NodeInfoIngestInfo' + script: + $ref: '#/components/schemas/NodeInfoIngestInfo' + set: + $ref: '#/components/schemas/NodeInfoIngestInfo' + sort: + $ref: '#/components/schemas/NodeInfoIngestInfo' + split: + $ref: '#/components/schemas/NodeInfoIngestInfo' + trim: + $ref: '#/components/schemas/NodeInfoIngestInfo' + uppercase: + $ref: '#/components/schemas/NodeInfoIngestInfo' + urldecode: + $ref: '#/components/schemas/NodeInfoIngestInfo' + bytes: + $ref: '#/components/schemas/NodeInfoIngestInfo' + dissect: + $ref: '#/components/schemas/NodeInfoIngestInfo' + set_security_user: + $ref: '#/components/schemas/NodeInfoIngestInfo' + pipeline: + $ref: '#/components/schemas/NodeInfoIngestInfo' + drop: + $ref: '#/components/schemas/NodeInfoIngestInfo' + circle: + $ref: '#/components/schemas/NodeInfoIngestInfo' + inference: + $ref: '#/components/schemas/NodeInfoIngestInfo' + NodeInfoIngestInfo: + type: object + properties: + downloader: + $ref: '#/components/schemas/NodeInfoIngestDownloader' + required: + - downloader + NodeInfoIngestDownloader: + type: object + properties: + enabled: + type: string + required: + - enabled + NodeThreadPoolInfo: + type: object + properties: + core: + type: number + keep_alive: + $ref: '_common.yaml#/components/schemas/Duration' + max: + type: number + queue_size: + type: number + size: + type: number + type: + type: string + required: + - queue_size + - type + NodeInfoTransport: + type: object + properties: + bound_address: + type: array + items: + type: string + publish_address: + type: string + profiles: + type: object + additionalProperties: + type: string + required: + - bound_address + - publish_address + - profiles + NodeInfoIngest: + type: object + properties: + processors: + type: array + items: + $ref: '#/components/schemas/NodeInfoIngestProcessor' + required: + - processors + NodeInfoIngestProcessor: + type: object + properties: + type: + type: string + required: + - type + NodeInfoAggregation: + type: object + properties: + types: + type: array + items: + type: string + required: + - types diff --git a/spec/schemas/nodes.reload_secure_settings.yaml b/spec/schemas/nodes.reload_secure_settings.yaml new file mode 100644 index 00000000..d748653b --- /dev/null +++ b/spec/schemas/nodes.reload_secure_settings.yaml @@ -0,0 +1,22 @@ +openapi: 3.1.0 +info: + title: Schemas of nodes.reload_secure_settings category + description: Schemas of nodes.reload_secure_settings category + version: 1.0.0 +paths: {} +components: + schemas: + ResponseBase: + allOf: + - $ref: 'nodes._common.yaml#/components/schemas/NodesResponseBase' + - type: object + properties: + cluster_name: + $ref: '_common.yaml#/components/schemas/Name' + nodes: + type: object + additionalProperties: + $ref: 'nodes._common.yaml#/components/schemas/NodeReloadResult' + required: + - cluster_name + - nodes diff --git a/spec/schemas/nodes.stats.yaml b/spec/schemas/nodes.stats.yaml new file mode 100644 index 00000000..448daf82 --- /dev/null +++ b/spec/schemas/nodes.stats.yaml @@ -0,0 +1,21 @@ +openapi: 3.1.0 +info: + title: Schemas of nodes.stats category + description: Schemas of nodes.stats category + version: 1.0.0 +paths: {} +components: + schemas: + ResponseBase: + allOf: + - $ref: 'nodes._common.yaml#/components/schemas/NodesResponseBase' + - type: object + properties: + cluster_name: + $ref: '_common.yaml#/components/schemas/Name' + nodes: + type: object + additionalProperties: + $ref: 'nodes._common.yaml#/components/schemas/Stats' + required: + - nodes diff --git a/spec/schemas/nodes.usage.yaml b/spec/schemas/nodes.usage.yaml new file mode 100644 index 00000000..eee12355 --- /dev/null +++ b/spec/schemas/nodes.usage.yaml @@ -0,0 +1,42 @@ +openapi: 3.1.0 +info: + title: Schemas of nodes.usage category + description: Schemas of nodes.usage category + version: 1.0.0 +paths: {} +components: + schemas: + ResponseBase: + allOf: + - $ref: 'nodes._common.yaml#/components/schemas/NodesResponseBase' + - type: object + properties: + cluster_name: + $ref: '_common.yaml#/components/schemas/Name' + nodes: + type: object + additionalProperties: + $ref: '#/components/schemas/NodeUsage' + required: + - cluster_name + - nodes + NodeUsage: + type: object + properties: + rest_actions: + type: object + additionalProperties: + type: number + since: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + timestamp: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + aggregations: + type: object + additionalProperties: + type: object + required: + - rest_actions + - since + - timestamp + - aggregations diff --git a/spec/schemas/notifications._common.yaml b/spec/schemas/notifications._common.yaml new file mode 100644 index 00000000..2ff589d6 --- /dev/null +++ b/spec/schemas/notifications._common.yaml @@ -0,0 +1,289 @@ +openapi: 3.1.0 +info: + title: Schemas of notifications._common category + description: Schemas of notifications._common category + version: 1.0.0 +paths: {} +components: + schemas: + DeleteResponseList: + type: object + additionalProperties: + $ref: '#/components/schemas/RestStatus' + RestStatus: + type: string + enum: + - continue + - switching_protocols + - ok + - created + - accepted + - non_authoritative_information + - no_content + - reset_content + - partial_content + - multi_status + - multiple_choices + - moved_permanently + - found + - see_other + - not_modified + - use_proxy + - temporary_redirect + NotificationsConfigs_GetRequestContent: + type: object + properties: + config_id_list: + type: array + items: + type: string + sort_field: + type: string + sort_order: + type: string + from_index: + type: integer + format: int32 + max_items: + type: integer + format: int32 + NotificationConfigType: + type: string + description: Type of notification configuration. + enum: + - slack + - chime + - microsoft_teams + - webhook + - email + - sns + - ses_account + - smtp_account + - email_group + TotalHitRelation: + type: string + enum: + - eq + - gte + NotificationsConfigsOutputItem: + type: object + properties: + config_id: + type: string + last_updated_time_ms: + type: integer + format: int64 + created_time_ms: + type: integer + format: int64 + config: + $ref: '#/components/schemas/NotificationsConfigItem' + NotificationsConfigItem: + type: object + properties: + name: + type: string + description: + type: string + config_type: + $ref: '#/components/schemas/NotificationConfigType' + is_enabled: + type: boolean + sns: + $ref: '#/components/schemas/SnsItem' + slack: + $ref: '#/components/schemas/SlackItem' + chime: + $ref: '#/components/schemas/Chime' + webhook: + $ref: '#/components/schemas/Webhook' + smtp_account: + $ref: '#/components/schemas/SmtpAccount' + ses_account: + $ref: '#/components/schemas/SesAccount' + email_group: + $ref: '#/components/schemas/EmailGroup' + email: + $ref: '#/components/schemas/Email' + microsoft_teams: + $ref: '#/components/schemas/MicrosoftTeamsItem' + required: + - config_type + - name + SnsItem: + type: object + properties: + topic_arn: + type: string + role_arn: + type: string + required: + - topic_arn + SlackItem: + type: object + properties: + url: + type: string + required: + - url + Chime: + type: object + properties: + url: + type: string + required: + - url + Webhook: + type: object + properties: + url: + type: string + method: + $ref: '#/components/schemas/HttpMethodType' + header_params: + $ref: '#/components/schemas/HeaderParamsMap' + required: + - url + HttpMethodType: + type: string + enum: + - POST + - PUT + - PATCH + HeaderParamsMap: + type: object + additionalProperties: + type: integer + format: int32 + SmtpAccount: + type: object + properties: + host: + type: string + port: + type: integer + format: int32 + method: + $ref: '#/components/schemas/EmailEncryptionMethod' + from_addess: + type: string + required: + - from_addess + - host + - method + - port + EmailEncryptionMethod: + type: string + enum: + - ssl + - start_tls + - none + SesAccount: + type: object + properties: + region: + type: string + role_arn: + type: string + from_addess: + type: string + required: + - from_addess + - region + EmailGroup: + type: object + properties: + recipient_list: + type: array + items: + $ref: '#/components/schemas/RecipientListItem' + email_group_id_list: + type: array + items: + type: string + required: + - recipient_list + RecipientListItem: + type: object + properties: + recipient: + type: string + Email: + type: object + properties: + email_account_id: + type: string + recipient_list: + type: array + items: + $ref: '#/components/schemas/RecipientListItem' + required: + - email_account_id + MicrosoftTeamsItem: + type: object + properties: + url: + type: string + required: + - url + NotificationsConfig: + type: object + properties: + config_id: + type: string + config: + $ref: '#/components/schemas/NotificationsConfigItem' + required: + - config + EventSource: + type: object + properties: + title: + type: string + reference_id: + type: string + severity: + $ref: '#/components/schemas/SeverityType' + tags: + type: array + items: + type: string + SeverityType: + type: string + enum: + - high + - info + - critical + EventStatus: + type: object + properties: + config_id: + type: string + config_name: + type: string + config_type: + $ref: '#/components/schemas/NotificationConfigType' + email_recipient_status: + type: array + items: + $ref: '#/components/schemas/EmailRecipientStatus' + delivery_status: + $ref: '#/components/schemas/DeliveryStatus' + EmailRecipientStatus: + type: object + properties: + recipient: + type: string + delivery_status: + $ref: '#/components/schemas/DeliveryStatus' + DeliveryStatus: + type: object + properties: + status_code: + type: string + status_text: + type: string + NotificationsPluginFeaturesMap: + type: object + additionalProperties: + type: string diff --git a/spec/schemas/remote_store._common.yaml b/spec/schemas/remote_store._common.yaml new file mode 100644 index 00000000..3c0ca505 --- /dev/null +++ b/spec/schemas/remote_store._common.yaml @@ -0,0 +1,31 @@ +openapi: 3.1.0 +info: + title: Schemas of remote_store._common category + description: Schemas of remote_store._common category + version: 1.0.0 +paths: {} +components: + schemas: + RemoteStoreRestoreInfo: + type: object + properties: + snapshot: + type: string + indices: + type: array + items: + type: string + shards: + $ref: '#/components/schemas/RemoteStoreRestoreShardsInfo' + RemoteStoreRestoreShardsInfo: + type: object + properties: + total: + type: integer + format: int32 + failed: + type: integer + format: int32 + successful: + type: integer + format: int32 diff --git a/spec/schemas/search_pipeline._common.yaml b/spec/schemas/search_pipeline._common.yaml new file mode 100644 index 00000000..77f94f06 --- /dev/null +++ b/spec/schemas/search_pipeline._common.yaml @@ -0,0 +1,237 @@ +openapi: 3.1.0 +info: + title: Schemas of search_pipeline._common category + description: Schemas of search_pipeline._common category + version: 1.0.0 +paths: {} +components: + schemas: + SearchPipelineMap: + type: object + additionalProperties: + $ref: '#/components/schemas/SearchPipelineStructure' + SearchPipelineStructure: + type: object + properties: + version: + type: integer + format: int32 + request_processors: + type: array + items: + $ref: '#/components/schemas/RequestProcessor' + response_processors: + type: array + items: + $ref: '#/components/schemas/RequestProcessor' + phase_results_processors: + type: array + items: + $ref: '#/components/schemas/PhaseResultsProcessor' + RequestProcessor: + oneOf: + - type: object + title: filter_query + properties: + filter_query: + $ref: '#/components/schemas/FilterQueryRequestProcessor' + required: + - filter_query + - type: object + title: neural_query_enricher + properties: + neural_query_enricher: + $ref: '#/components/schemas/NeuralQueryEnricherRequestProcessor' + required: + - neural_query_enricher + - type: object + title: script + properties: + script: + $ref: '#/components/schemas/SearchScriptRequestProcessor' + required: + - script + - type: object + title: oversample + properties: + oversample: + $ref: '#/components/schemas/OversampleRequestProcessor' + required: + - oversample + FilterQueryRequestProcessor: + type: object + properties: + tag: + type: string + description: + type: string + ignore_failure: + type: boolean + query: + $ref: '#/components/schemas/UserDefinedObjectStructure' + UserDefinedObjectStructure: + type: object + properties: + bool: {} + boosting: {} + combined_fields: {} + constant_score: {} + dis_max: {} + distance_feature: {} + exists: {} + function_score: {} + fuzzy: + $ref: '#/components/schemas/UserDefinedValueMap' + geo_bounding_box: {} + geo_distance: {} + geo_polygon: {} + geo_shape: {} + has_child: {} + has_parent: {} + ids: {} + intervals: + $ref: '#/components/schemas/UserDefinedValueMap' + knn: {} + match: + $ref: '#/components/schemas/UserDefinedValueMap' + match_all: {} + match_bool_prefix: + $ref: '#/components/schemas/UserDefinedValueMap' + match_none: {} + match_phrase: + $ref: '#/components/schemas/UserDefinedValueMap' + match_phrase_prefix: + $ref: '#/components/schemas/UserDefinedValueMap' + more_like_this: {} + multi_match: {} + nested: {} + parent_id: {} + percolate: {} + pinned: {} + prefix: + $ref: '#/components/schemas/UserDefinedValueMap' + query_string: {} + range: + $ref: '#/components/schemas/UserDefinedValueMap' + rank_feature: {} + regexp: + $ref: '#/components/schemas/UserDefinedValueMap' + script: {} + script_score: {} + shape: {} + simple_query_string: {} + span_containing: {} + field_masking_span: {} + span_first: {} + span_multi: {} + span_near: {} + span_not: {} + span_or: {} + span_term: + $ref: '#/components/schemas/UserDefinedValueMap' + span_within: {} + term: + $ref: '#/components/schemas/UserDefinedValueMap' + terms: {} + terms_set: + $ref: '#/components/schemas/UserDefinedValueMap' + wildcard: + $ref: '#/components/schemas/UserDefinedValueMap' + wrapper: {} + UserDefinedValueMap: + type: object + additionalProperties: {} + NeuralQueryEnricherRequestProcessor: + type: object + properties: + tag: + type: string + description: + type: string + default_model_id: + type: string + neural_field_default_id: + $ref: '#/components/schemas/NeuralFieldMap' + NeuralFieldMap: + type: object + additionalProperties: + type: string + SearchScriptRequestProcessor: + type: object + properties: + tag: + type: string + description: + type: string + ignore_failure: + type: boolean + source: + type: string + lang: + type: string + required: + - source + OversampleRequestProcessor: + type: object + properties: + tag: + type: string + description: + type: string + ignore_failure: + type: boolean + sample_factor: + type: number + format: float + content_prefix: + type: string + required: + - sample_factor + PhaseResultsProcessor: + oneOf: + - type: object + title: normalization-processor + properties: + normalization-processor: + $ref: '#/components/schemas/NormalizationPhaseResultsProcessor' + required: + - normalization-processor + NormalizationPhaseResultsProcessor: + type: object + properties: + tag: + type: string + description: + type: string + ignore_failure: + type: boolean + normalization: + $ref: '#/components/schemas/ScoreNormalization' + combination: + $ref: '#/components/schemas/ScoreCombination' + ScoreNormalization: + type: object + properties: + technique: + $ref: '#/components/schemas/ScoreNormalizationTechnique' + ScoreNormalizationTechnique: + type: string + enum: + - min_max + - l2 + ScoreCombination: + type: object + properties: + technique: + $ref: '#/components/schemas/ScoreCombinationTechnique' + parameters: + type: array + items: + type: number + format: float + ScoreCombinationTechnique: + type: string + enum: + - arithmetic_mean + - geometric_mean + - harmonic_mean diff --git a/spec/schemas/security._common.yaml b/spec/schemas/security._common.yaml new file mode 100644 index 00000000..6fc1ead4 --- /dev/null +++ b/spec/schemas/security._common.yaml @@ -0,0 +1,360 @@ +openapi: 3.1.0 +info: + title: Schemas of security._common category + description: Schemas of security._common category + version: 1.0.0 +paths: {} +components: + schemas: + RoleMapping: + type: object + properties: + hosts: + type: array + items: + type: string + users: + type: array + items: + type: string + reserved: + type: boolean + hidden: + type: boolean + backend_roles: + type: array + items: + type: string + and_backend_roles: + type: array + items: + type: string + description: + type: string + User: + type: object + properties: + hash: + type: string + reserved: + type: boolean + hidden: + type: boolean + backend_roles: + type: array + items: + type: string + attributes: + $ref: '#/components/schemas/UserAttributes' + description: + type: string + opendistro_security_roles: + type: array + items: + type: string + static: + type: boolean + AccountDetails: + type: object + properties: + user_name: + type: string + is_reserved: + type: boolean + is_hidden: + type: boolean + is_internal_user: + type: boolean + user_requested_tenant: + type: string + backend_roles: + type: array + items: + type: string + custom_attribute_names: + type: array + items: + type: string + tenants: + $ref: '#/components/schemas/UserTenants' + roles: + type: array + items: + type: string + UserTenants: + type: object + properties: + global_tenant: + type: boolean + admin_tenant: + type: boolean + admin: + type: boolean + ChangePasswordRequestContent: + type: object + properties: + current_password: + type: string + description: The current password + password: + type: string + description: The new password to set + required: + - current_password + - password + ActionGroupsMap: + type: object + additionalProperties: + $ref: '#/components/schemas/Action_Group' + Action_Group: + type: object + properties: + reserved: + type: boolean + hidden: + type: boolean + allowed_actions: + type: array + items: + type: string + type: + type: string + description: + type: string + static: + type: boolean + PatchOperation: + type: object + properties: + op: + type: string + description: 'The operation to perform. Possible values: remove,add, replace, move, copy, test.' + path: + type: string + description: The path to the resource. + value: + description: The new values used for the update. + required: + - op + - path + AuditConfigWithReadOnly: + type: object + properties: + _readonly: + type: array + items: + type: string + config: + $ref: '#/components/schemas/AuditConfig' + AuditConfig: + type: object + properties: + compliance: + $ref: '#/components/schemas/ComplianceConfig' + enabled: + type: boolean + audit: + $ref: '#/components/schemas/AuditLogsConfig' + ComplianceConfig: + type: object + properties: + enabled: + type: boolean + write_log_diffs: + type: boolean + read_watched_fields: {} + read_ignore_users: + type: array + items: + type: string + write_watched_indices: + type: array + items: + type: string + write_ignore_users: + type: array + items: + type: string + read_metadata_only: + type: boolean + write_metadata_only: + type: boolean + external_config: + type: boolean + internal_config: + type: boolean + AuditLogsConfig: + type: object + properties: + ignore_users: + type: array + items: + type: string + ignore_requests: + type: array + items: + type: string + disabled_rest_categories: + type: array + items: + type: string + disabled_transport_categories: + type: array + items: + type: string + log_request_body: + type: boolean + resolve_indices: + type: boolean + resolve_bulk_requests: + type: boolean + exclude_sensitive_headers: + type: boolean + enable_transport: + type: boolean + enable_rest: + type: boolean + UsersMap: + type: object + additionalProperties: + $ref: '#/components/schemas/User' + UserAttributes: + type: object + additionalProperties: + type: string + DistinguishedNamesMap: + type: object + additionalProperties: + $ref: '#/components/schemas/DistinguishedNames' + DistinguishedNames: + type: object + properties: + nodes_dn: + type: array + items: + type: string + RolesMap: + type: object + additionalProperties: + $ref: '#/components/schemas/Role' + Role: + type: object + properties: + reserved: + type: boolean + hidden: + type: boolean + description: + type: string + cluster_permissions: + type: array + items: + type: string + index_permissions: + type: array + items: + $ref: '#/components/schemas/IndexPermission' + tenant_permissions: + type: array + items: + $ref: '#/components/schemas/TenantPermission' + static: + type: boolean + IndexPermission: + type: object + properties: + index_patterns: + type: array + items: + type: string + dls: + type: string + fls: + type: array + items: + type: string + masked_fields: + type: array + items: + type: string + allowed_actions: + type: array + items: + type: string + TenantPermission: + type: object + properties: + tenant_patterns: + type: array + items: + type: string + allowed_actions: + type: array + items: + type: string + RoleMappings: + type: object + additionalProperties: + $ref: '#/components/schemas/RoleMapping' + DynamicConfig: + type: object + properties: + dynamic: + $ref: '#/components/schemas/DynamicOptions' + DynamicOptions: + type: object + properties: + filteredAliasMode: + type: string + disableRestAuth: + type: boolean + disableIntertransportAuth: + type: boolean + respectRequestIndicesOptions: + type: boolean + kibana: {} + http: {} + authc: {} + authz: {} + authFailureListeners: {} + doNotFailOnForbidden: + type: boolean + multiRolespanEnabled: + type: boolean + hostsResolverMode: + type: string + doNotFailOnForbiddenEmpty: + type: boolean + CertificatesDetail: + type: object + properties: + issuer_dn: + type: string + subject_dn: + type: string + san: + type: string + not_before: + type: string + not_after: + type: string + TenantsMap: + type: object + additionalProperties: + $ref: '#/components/schemas/Tenant' + Tenant: + type: object + properties: + reserved: + type: boolean + hidden: + type: boolean + description: + type: string + static: + type: boolean + CreateTenantParams: + type: object + properties: + description: + type: string diff --git a/spec/schemas/snapshot._common.yaml b/spec/schemas/snapshot._common.yaml new file mode 100644 index 00000000..2c27de05 --- /dev/null +++ b/spec/schemas/snapshot._common.yaml @@ -0,0 +1,284 @@ +openapi: 3.1.0 +info: + title: Schemas of snapshot._common category + description: Schemas of snapshot._common category + version: 1.0.0 +paths: {} +components: + schemas: + SnapshotInfo: + type: object + properties: + data_streams: + type: array + items: + type: string + duration: + $ref: '_common.yaml#/components/schemas/Duration' + duration_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + end_time: + $ref: '_common.yaml#/components/schemas/DateTime' + end_time_in_millis: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + failures: + type: array + items: + $ref: '#/components/schemas/SnapshotShardFailure' + include_global_state: + type: boolean + indices: + type: array + items: + $ref: '_common.yaml#/components/schemas/IndexName' + index_details: + type: object + additionalProperties: + $ref: '#/components/schemas/IndexDetails' + metadata: + $ref: '_common.yaml#/components/schemas/Metadata' + reason: + type: string + repository: + $ref: '_common.yaml#/components/schemas/Name' + snapshot: + $ref: '_common.yaml#/components/schemas/Name' + shards: + $ref: '_common.yaml#/components/schemas/ShardStatistics' + start_time: + $ref: '_common.yaml#/components/schemas/DateTime' + start_time_in_millis: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + state: + type: string + uuid: + $ref: '_common.yaml#/components/schemas/Uuid' + version: + $ref: '_common.yaml#/components/schemas/VersionString' + version_id: + $ref: '_common.yaml#/components/schemas/VersionNumber' + feature_states: + type: array + items: + $ref: '#/components/schemas/InfoFeatureState' + required: + - data_streams + - snapshot + - uuid + SnapshotShardFailure: + type: object + properties: + index: + $ref: '_common.yaml#/components/schemas/IndexName' + node_id: + $ref: '_common.yaml#/components/schemas/Id' + reason: + type: string + shard_id: + $ref: '_common.yaml#/components/schemas/Id' + status: + type: string + required: + - index + - reason + - shard_id + - status + IndexDetails: + type: object + properties: + shard_count: + type: number + size: + $ref: '_common.yaml#/components/schemas/ByteSize' + size_in_bytes: + type: number + max_segments_per_shard: + type: number + required: + - shard_count + - size_in_bytes + - max_segments_per_shard + InfoFeatureState: + type: object + properties: + feature_name: + type: string + indices: + $ref: '_common.yaml#/components/schemas/Indices' + required: + - feature_name + - indices + Repository: + type: object + properties: + type: + type: string + uuid: + $ref: '_common.yaml#/components/schemas/Uuid' + settings: + $ref: '#/components/schemas/RepositorySettings' + required: + - type + - settings + RepositorySettings: + type: object + properties: + chunk_size: + type: string + compress: + oneOf: + - type: string + - type: boolean + concurrent_streams: + oneOf: + - type: string + - type: number + location: + type: string + read_only: + oneOf: + - type: string + - type: boolean + required: + - location + Status: + type: object + properties: + include_global_state: + type: boolean + indices: + type: object + additionalProperties: + $ref: '#/components/schemas/SnapshotIndexStats' + repository: + type: string + shards_stats: + $ref: '#/components/schemas/ShardsStats' + snapshot: + type: string + state: + type: string + stats: + $ref: '#/components/schemas/SnapshotStats' + uuid: + $ref: '_common.yaml#/components/schemas/Uuid' + required: + - include_global_state + - indices + - repository + - shards_stats + - snapshot + - state + - stats + - uuid + SnapshotIndexStats: + type: object + properties: + shards: + type: object + additionalProperties: + $ref: '#/components/schemas/SnapshotShardsStatus' + shards_stats: + $ref: '#/components/schemas/ShardsStats' + stats: + $ref: '#/components/schemas/SnapshotStats' + required: + - shards + - shards_stats + - stats + SnapshotShardsStatus: + type: object + properties: + stage: + $ref: '#/components/schemas/ShardsStatsStage' + stats: + $ref: '#/components/schemas/ShardsStatsSummary' + required: + - stage + - stats + ShardsStatsStage: + type: string + enum: + - DONE + - FAILURE + - FINALIZE + - INIT + - STARTED + ShardsStatsSummary: + type: object + properties: + incremental: + $ref: '#/components/schemas/ShardsStatsSummaryItem' + total: + $ref: '#/components/schemas/ShardsStatsSummaryItem' + start_time_in_millis: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + time: + $ref: '_common.yaml#/components/schemas/Duration' + time_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + required: + - incremental + - total + - start_time_in_millis + - time_in_millis + ShardsStatsSummaryItem: + type: object + properties: + file_count: + type: number + size_in_bytes: + type: number + required: + - file_count + - size_in_bytes + ShardsStats: + type: object + properties: + done: + type: number + failed: + type: number + finalizing: + type: number + initializing: + type: number + started: + type: number + total: + type: number + required: + - done + - failed + - finalizing + - initializing + - started + - total + SnapshotStats: + type: object + properties: + incremental: + $ref: '#/components/schemas/FileCountSnapshotStats' + start_time_in_millis: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + time: + $ref: '_common.yaml#/components/schemas/Duration' + time_in_millis: + $ref: '_common.yaml#/components/schemas/DurationValueUnitMillis' + total: + $ref: '#/components/schemas/FileCountSnapshotStats' + required: + - incremental + - start_time_in_millis + - time_in_millis + - total + FileCountSnapshotStats: + type: object + properties: + file_count: + type: number + size_in_bytes: + type: number + required: + - file_count + - size_in_bytes diff --git a/spec/schemas/snapshot.cleanup_repository.yaml b/spec/schemas/snapshot.cleanup_repository.yaml new file mode 100644 index 00000000..0682a883 --- /dev/null +++ b/spec/schemas/snapshot.cleanup_repository.yaml @@ -0,0 +1,20 @@ +openapi: 3.1.0 +info: + title: Schemas of snapshot.cleanup_repository category + description: Schemas of snapshot.cleanup_repository category + version: 1.0.0 +paths: {} +components: + schemas: + CleanupRepositoryResults: + type: object + properties: + deleted_blobs: + description: Number of binary large objects (blobs) removed during cleanup. + type: number + deleted_bytes: + description: Number of bytes freed by cleanup operations. + type: number + required: + - deleted_blobs + - deleted_bytes diff --git a/spec/schemas/snapshot.get.yaml b/spec/schemas/snapshot.get.yaml new file mode 100644 index 00000000..8834816d --- /dev/null +++ b/spec/schemas/snapshot.get.yaml @@ -0,0 +1,21 @@ +openapi: 3.1.0 +info: + title: Schemas of snapshot.get category + description: Schemas of snapshot.get category + version: 1.0.0 +paths: {} +components: + schemas: + SnapshotResponseItem: + type: object + properties: + repository: + $ref: '_common.yaml#/components/schemas/Name' + snapshots: + type: array + items: + $ref: 'snapshot._common.yaml#/components/schemas/SnapshotInfo' + error: + $ref: '_common.yaml#/components/schemas/ErrorCause' + required: + - repository diff --git a/spec/schemas/snapshot.restore.yaml b/spec/schemas/snapshot.restore.yaml new file mode 100644 index 00000000..4788c0b8 --- /dev/null +++ b/spec/schemas/snapshot.restore.yaml @@ -0,0 +1,23 @@ +openapi: 3.1.0 +info: + title: Schemas of snapshot.restore category + description: Schemas of snapshot.restore category + version: 1.0.0 +paths: {} +components: + schemas: + SnapshotRestore: + type: object + properties: + indices: + type: array + items: + $ref: '_common.yaml#/components/schemas/IndexName' + snapshot: + type: string + shards: + $ref: '_common.yaml#/components/schemas/ShardStatistics' + required: + - indices + - snapshot + - shards diff --git a/spec/schemas/snapshot.verify_repository.yaml b/spec/schemas/snapshot.verify_repository.yaml new file mode 100644 index 00000000..92eb0a2c --- /dev/null +++ b/spec/schemas/snapshot.verify_repository.yaml @@ -0,0 +1,15 @@ +openapi: 3.1.0 +info: + title: Schemas of snapshot.verify_repository category + description: Schemas of snapshot.verify_repository category + version: 1.0.0 +paths: {} +components: + schemas: + CompactNodeInfo: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/Name' + required: + - name diff --git a/spec/schemas/tasks._common.yaml b/spec/schemas/tasks._common.yaml new file mode 100644 index 00000000..1f4787c0 --- /dev/null +++ b/spec/schemas/tasks._common.yaml @@ -0,0 +1,115 @@ +openapi: 3.1.0 +info: + title: Schemas of tasks._common category + description: Schemas of tasks._common category + version: 1.0.0 +paths: {} +components: + schemas: + TaskListResponseBase: + type: object + properties: + node_failures: + type: array + items: + $ref: '_common.yaml#/components/schemas/ErrorCause' + task_failures: + type: array + items: + $ref: '_common.yaml#/components/schemas/TaskFailure' + nodes: + description: Task information grouped by node, if `group_by` was set to `node` (the default). + type: object + additionalProperties: + $ref: '#/components/schemas/NodeTasks' + tasks: + $ref: '#/components/schemas/TaskInfos' + NodeTasks: + type: object + properties: + name: + $ref: '_common.yaml#/components/schemas/NodeId' + transport_address: + $ref: '_common.yaml#/components/schemas/TransportAddress' + host: + $ref: '_common.yaml#/components/schemas/Host' + ip: + $ref: '_common.yaml#/components/schemas/Ip' + roles: + type: array + items: + type: string + attributes: + type: object + additionalProperties: + type: string + tasks: + type: object + additionalProperties: + $ref: '#/components/schemas/TaskInfo' + required: + - tasks + TaskInfo: + type: object + properties: + action: + type: string + cancelled: + type: boolean + cancellable: + type: boolean + description: + type: string + headers: + type: object + additionalProperties: + type: string + id: + type: number + node: + $ref: '_common.yaml#/components/schemas/NodeId' + running_time: + $ref: '_common.yaml#/components/schemas/Duration' + running_time_in_nanos: + $ref: '_common.yaml#/components/schemas/DurationValueUnitNanos' + start_time_in_millis: + $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' + status: + description: Task status information can vary wildly from task to task. + type: object + type: + type: string + parent_task_id: + $ref: '_common.yaml#/components/schemas/TaskId' + required: + - action + - cancellable + - headers + - id + - node + - running_time_in_nanos + - start_time_in_millis + - type + TaskInfos: + oneOf: + - type: array + items: + $ref: '#/components/schemas/TaskInfo' + - type: object + additionalProperties: + $ref: '#/components/schemas/ParentTaskInfo' + ParentTaskInfo: + allOf: + - $ref: '#/components/schemas/TaskInfo' + - type: object + properties: + children: + type: array + items: + $ref: '#/components/schemas/TaskInfo' + GroupBy: + type: string + enum: + - nodes + - parents + - none diff --git a/test/Pipfile b/test/Pipfile deleted file mode 100644 index 91d19880..00000000 --- a/test/Pipfile +++ /dev/null @@ -1,12 +0,0 @@ -[[source]] -url = "https://pypi.org/simple" -verify_ssl = true -name = "pypi" - -[packages] -prettytable = "*" - -[dev-packages] - -[requires] -python_version = "*" \ No newline at end of file diff --git a/test/Pipfile.lock b/test/Pipfile.lock deleted file mode 100644 index 067957b2..00000000 --- a/test/Pipfile.lock +++ /dev/null @@ -1,36 +0,0 @@ -{ - "_meta": { - "hash": { - "sha256": "ef6ec0724fab7ce6a5699d14ac568bfc3a7a1d2b0cdb19a43c90f2c6f1346132" - }, - "pipfile-spec": 6, - "requires": { - "python_version": "*" - }, - "sources": [ - { - "name": "pypi", - "url": "https://pypi.org/simple", - "verify_ssl": true - } - ] - }, - "default": { - "prettytable": { - "hashes": [ - "sha256:118eb54fd2794049b810893653b20952349df6d3bc1764e7facd8a18064fa9b0", - "sha256:d1c34d72ea2c0ffd6ce5958e71c428eb21a3d40bf3133afe319b24aeed5af407" - ], - "index": "pypi", - "version": "==3.3.0" - }, - "wcwidth": { - "hashes": [ - "sha256:beb4802a9cebb9144e99086eff703a642a13d6a0052920003a230f3294bbe784", - "sha256:c4d647b99872929fdb7bdcaa4fbe7f01413ed3d98077df798530e5b04f116c83" - ], - "version": "==0.2.5" - } - }, - "develop": {} -} \ No newline at end of file diff --git a/test/docker-compose.yml b/test/docker-compose.yml deleted file mode 100644 index 588c76de..00000000 --- a/test/docker-compose.yml +++ /dev/null @@ -1,60 +0,0 @@ -version: '3' -services: - opensearch-node1: - build: ./opensearch - container_name: opensearch-node1 - environment: - - cluster.name=opensearch-cluster - - node.name=opensearch-node1 - - discovery.seed_hosts=opensearch-node1,opensearch-node2 - - cluster.initial_master_nodes=opensearch-node1,opensearch-node2 - - bootstrap.memory_lock=true # along with the memlock settings below, disables swapping - - path.repo=/mnt/snapshots - - "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m -Dopensearch.experimental.feature.replication_type.enabled=true -Dopensearch.experimental.feature.remote_store.enabled=true" - ulimits: - memlock: - soft: -1 - hard: -1 - nofile: - soft: 65536 # maximum number of open files for the OpenSearch user, set to at least 65536 on modern systems - hard: 65536 - volumes: - - opensearch-data1:/usr/share/opensearch/data - - opensearch-snapshots:/mnt/snapshots - ports: - - 9200:9200 - - 9600:9600 # required for Performance Analyzer - networks: - - opensearch-net - - opensearch-node2: - build: ./opensearch - container_name: opensearch-node2 - environment: - - cluster.name=opensearch-cluster - - node.name=opensearch-node2 - - discovery.seed_hosts=opensearch-node1,opensearch-node2 - - cluster.initial_master_nodes=opensearch-node1,opensearch-node2 - - bootstrap.memory_lock=true - - path.repo=/mnt/snapshots - - "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m -Dopensearch.experimental.feature.replication_type.enabled=true -Dopensearch.experimental.feature.remote_store.enabled=true" - ulimits: - memlock: - soft: -1 - hard: -1 - nofile: - soft: 65536 - hard: 65536 - volumes: - - opensearch-data2:/usr/share/opensearch/data - - opensearch-snapshots:/mnt/snapshots - networks: - - opensearch-net - -volumes: - opensearch-data1: - opensearch-data2: - opensearch-snapshots: - -networks: - opensearch-net: diff --git a/test/models/_global/get/OpenSearchModel.json b/test/models/_global/get/OpenSearchModel.json deleted file mode 100644 index e3fd555a..00000000 --- a/test/models/_global/get/OpenSearchModel.json +++ /dev/null @@ -1,333 +0,0 @@ -{ - "openapi": "3.0.2", - "info": { - "title": "OpenSearch", - "version": "2021-11-23" - }, - "paths": { - "/{index}/_doc/{id}": { - "get": { - "description": "Returns a document", - "operationId": "GetDocumentDoc", - "parameters": [ - { - "name": "index", - "in": "path", - "schema": { - "type": "string", - "pattern": "^[^+_\\-\\.][^\\\\, /*?\"<>| ,#\\nA-Z]+$" - }, - "required": true, - "examples": { - "GetDocumentDoc_example1": { - "summary": "Examples for Get document doc Operation.", - "description": "", - "value": "books" - } - }, - "example": "books" - }, - { - "name": "id", - "in": "path", - "schema": { - "type": "string" - }, - "required": true, - "examples": { - "GetDocumentDoc_example1": { - "summary": "Examples for Get document doc Operation.", - "description": "", - "value": "1" - } - }, - "example": "1" - }, - { - "name": "preference", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "realtime", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "refresh", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "routing", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "stored_fields", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "_source", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "_source_excludes", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "_source_includes", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "version", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "version_type", - "in": "query", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "GetDocumentDoc 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetDocumentDocResponseContent" - }, - "examples": { - "GetDocumentDoc_example1": { - "summary": "Examples for Get document doc Operation.", - "description": "", - "value": { - "_index": "books", - "_id": "1", - "found": true - } - } - } - } - } - } - } - } - }, - "/{index}/_source/{id}": { - "get": { - "description": "Returns a document.", - "operationId": "GetDocumentSource", - "parameters": [ - { - "name": "index", - "in": "path", - "schema": { - "type": "string", - "pattern": "^[^+_\\-\\.][^\\\\, /*?\"<>| ,#\\nA-Z]+$" - }, - "required": true, - "examples": { - "GetDocumentSource_example1": { - "summary": "Examples for Get document source Operation.", - "description": "", - "value": "books" - } - }, - "example": "books" - }, - { - "name": "id", - "in": "path", - "schema": { - "type": "string" - }, - "required": true, - "examples": { - "GetDocumentSource_example1": { - "summary": "Examples for Get document source Operation.", - "description": "", - "value": "1" - } - }, - "example": "1" - }, - { - "name": "preference", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "realtime", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "refresh", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "routing", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "stored_fields", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "_source", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "_source_excludes", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "_source_includes", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "version", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "version_type", - "in": "query", - "schema": { - "$ref": "#/components/schemas/VersionType" - } - } - ], - "responses": { - "200": { - "description": "GetDocumentSource 200 response" - } - } - } - } - }, - "components": { - "schemas": { - "GetDocumentDocResponseContent": { - "type": "object", - "properties": { - "_index": { - "type": "string", - "pattern": "^[^+_\\-\\.][^\\\\, /*?\"<>| ,#\\nA-Z]+$" - }, - "_type": { - "type": "string" - }, - "_id": { - "type": "string" - }, - "version": { - "type": "number" - }, - "seq_no": { - "type": "number" - }, - "primary_term": { - "type": "number" - }, - "found": { - "type": "boolean" - }, - "_routing": { - "type": "string" - }, - "_source": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "_fields": { - "$ref": "#/components/schemas/UserDefinedValueMap" - } - }, - "required": [ - "_id", - "_index", - "found" - ], - "example": { - "_index": "books", - "_id": "1", - "found": true - } - }, - "UserDefinedValueMap": { - "type": "object", - "additionalProperties": {} - }, - "VersionType": { - "type": "string", - "enum": [ - "internal", - "external", - "external_gte" - ] - } - }, - "securitySchemes": { - "smithy.api.httpBasicAuth": { - "type": "http", - "description": "HTTP Basic authentication", - "scheme": "Basic" - } - } - }, - "security": [ - { - "smithy.api.httpBasicAuth": [] - } - ] - } \ No newline at end of file diff --git a/test/models/_global/get/hooks.js b/test/models/_global/get/hooks.js deleted file mode 100644 index 293edeec..00000000 --- a/test/models/_global/get/hooks.js +++ /dev/null @@ -1,139 +0,0 @@ -const https = require('https'); -const fetch = require('node-fetch') -const hooks = require('hooks'); -const fs = require('fs') - -var host = ""; -var protocol = "https"; -var auth = ""; - -// Reading .txt file to set URL -const data = fs.readFileSync('url.txt', {encoding:'utf8', flag:'r'}); -function address() -{ - text = data.toString(); - text = text.split(" "); - host = text[0].substring(8,text[0].length); - auth = text[1]; - return (protocol + "://" + auth + "@" + host); -} - -// Get Document Type: _doc - -hooks.before("/{index}/_doc/{id} > GET > 200 > application/json",function(transactions,done) { - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - - const request = async () => { - - var url = address(); - - // Create an index with non-default settings. - const cluster = await fetch(url+'/books',{ - method: 'PUT', - body:JSON.stringify({ - settings : { - index: { - number_of_shards:1, - number_of_replicas:0 - } - } - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - // Adding Document in cluster - const document = await fetch(url+'/books/_doc/1',{ - method: 'PUT', - body:JSON.stringify({ - title: "The Outsider", - author: "Stephen King", - year: "2018", - genre: "Crime fiction" - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - done(); - } - request(); -}); - -hooks.after("/{index}/_doc/{id} > GET > 200 > application/json",function(transactions,done){ - - const request = async () => { - - var url = address(); - - // Deleting cluster - const del = await fetch(url+'/books',{ - method: 'DELETE' - }); - - done(); - } - request(); -}); - -// Get Document Type: _source - -hooks.before("/{index}/_source/{id} > GET > 200",function(transactions,done) { - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - - const request = async () => { - - var url = address(); - - // Create an index with non-default settings. - const cluster = await fetch(url+'/books',{ - method: 'PUT', - body:JSON.stringify({ - settings : { - index: { - number_of_shards:1, - number_of_replicas:0 - } - } - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - // Adding Document in cluster - const document = await fetch(url+'/books/_doc/1',{ - method: 'PUT', - body:JSON.stringify({ - title: "The Outsider", - author: "Stephen King", - year: "2018", - genre: "Crime fiction" - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - done(); - } - request(); -}); - -hooks.after("/{index}/_source/{id} > GET > 200",function(transactions,done){ - - const request = async () => { - - var url = address(); - - // Deleting cluster - const del = await fetch(url+'/books',{ - method: 'DELETE' - }); - - done(); - } - request(); -}); diff --git a/test/models/_global/info/OpenSearchModel.json b/test/models/_global/info/OpenSearchModel.json deleted file mode 100644 index 2421bea4..00000000 --- a/test/models/_global/info/OpenSearchModel.json +++ /dev/null @@ -1,95 +0,0 @@ -{ - "openapi": "3.0.2", - "info": { - "title": "OpenSearch", - "version": "2021-11-23" - }, - "paths": { - "/": { - "get": { - "description": "Returns whether the cluster is running.", - "operationId": "GetClusterInfo", - "responses": { - "200": { - "description": "GetClusterInfo 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetClusterInfoResponseContent" - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "GetClusterInfoResponseContent": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "cluster_name": { - "type": "string" - }, - "cluster_uuid": { - "type": "string" - }, - "version": { - "$ref": "#/components/schemas/Version" - }, - "tagline": { - "type": "string" - } - } - }, - "Version": { - "type": "object", - "properties": { - "distribution": { - "type": "string" - }, - "number": { - "type": "string" - }, - "build_type": { - "type": "string" - }, - "build_hash": { - "type": "string" - }, - "build_date": { - "type": "string" - }, - "build_snapshot": { - "type": "boolean" - }, - "lucene_version": { - "type": "string" - }, - "minimum_wire_compatibility_version": { - "type": "string" - }, - "minimum_index_compatibility_version": { - "type": "string" - } - } - } - }, - "securitySchemes": { - "smithy.api.httpBasicAuth": { - "type": "http", - "description": "HTTP Basic authentication", - "scheme": "Basic" - } - } - }, - "security": [ - { - "smithy.api.httpBasicAuth": [] - } - ] - } \ No newline at end of file diff --git a/test/models/_global/info/hooks.js b/test/models/_global/info/hooks.js deleted file mode 100644 index f5bf8922..00000000 --- a/test/models/_global/info/hooks.js +++ /dev/null @@ -1,7 +0,0 @@ -const hooks = require('hooks'); - -hooks.before("/ > GET > 200 > application/json",function(transactions,done){ - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - done(); -}); - diff --git a/test/models/_global/search/OpenSearchModel.json b/test/models/_global/search/OpenSearchModel.json deleted file mode 100644 index eb635d62..00000000 --- a/test/models/_global/search/OpenSearchModel.json +++ /dev/null @@ -1,1179 +0,0 @@ -{ - "openapi": "3.0.2", - "info": { - "title": "OpenSearch", - "version": "2021-11-23" - }, - "paths": { - "/_search": { - "post": { - "description": "Returns results matching a query.", - "operationId": "PostSearch", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PostSearchRequestContent" - }, - "examples": { - "PostSearch_example1": { - "summary": "Examples for Post Search Operation.", - "description": "", - "value": { - "query": { - "match_all": {} - }, - "fields": [ - "*" - ] - } - } - } - } - } - }, - "parameters": [ - { - "name": "allow_no_indices", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "allow_partial_search_results", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "analyzer", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "batched_reduce_size", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "default_operator", - "in": "query", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "docvalue_fields", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "expand_wildcards", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "explain", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "from", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "ignore_throttled", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "lenient", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "max_concurrent_shard_requests", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "pre_filter_shard_size", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "preference", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "q", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "request_cache", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "routing", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "scroll", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - }, - "examples": { - "PostSearch_example1": { - "summary": "Examples for Post Search Operation.", - "description": "", - "value": "1d" - } - }, - "example": "1d" - }, - { - "name": "search_type", - "in": "query", - "schema": { - "$ref": "#/components/schemas/SearchType" - } - }, - { - "name": "seq_no_primary_term", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "size", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "sort", - "in": "query", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "explode": true - }, - { - "name": "source", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "source_excludes", - "in": "query", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "explode": true - }, - { - "name": "source_includes", - "in": "query", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "explode": true - }, - { - "name": "stats", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "stored_fields", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "suggest_field", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "suggest_mode", - "in": "query", - "schema": { - "$ref": "#/components/schemas/SuggestMode" - } - }, - { - "name": "suggest_size", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "suggest_text", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "terminate_after", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "track_scores", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "track_total_hits", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "typed_keys", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "version", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "PostSearch 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PostSearchResponseContent" - }, - "examples": { - "PostSearch_example1": { - "summary": "Examples for Post Search Operation.", - "description": "", - "value": { - "timed_out": false, - "_shards": { - "total": 1, - "successful": 1, - "skipped": 0, - "failed": 0 - }, - "hits": { - "total": { - "value": 0, - "relation": "eq" - }, - "hits": [] - } - } - } - } - } - } - } - } - } - }, - "/{index}/_search": { - "post": { - "description": "Returns results matching a query.", - "operationId": "PostSearchWithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PostSearchWithIndexRequestContent" - }, - "examples": { - "PostSearchWithIndex_example1": { - "summary": "Examples for Post Search With Index Operation.", - "description": "", - "value": { - "query": { - "match_all": {} - }, - "fields": [ - "*" - ] - } - } - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "schema": { - "type": "string", - "pattern": "^[^+_\\-\\.][^\\\\, /*?\"<>| ,#\\nA-Z]+$" - }, - "required": true, - "examples": { - "PostSearchWithIndex_example1": { - "summary": "Examples for Post Search With Index Operation.", - "description": "", - "value": "books" - } - }, - "example": "books" - }, - { - "name": "allow_no_indices", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "allow_partial_search_results", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "analyzer", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "analyze_wildcard", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "batched_reduce_size", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "ccs_minimize_roundtrips", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "default_operator", - "in": "query", - "schema": { - "$ref": "#/components/schemas/DefaultOperator" - } - }, - { - "name": "df", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "docvalue_fields", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "expand_wildcards", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "explain", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "from", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "ignore_throttled", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "lenient", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "max_concurrent_shard_requests", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "pre_filter_shard_size", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "preference", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "q", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "request_cache", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "rest_total_hits_as_int", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "routing", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "scroll", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - }, - "examples": { - "PostSearchWithIndex_example1": { - "summary": "Examples for Post Search With Index Operation.", - "description": "", - "value": "1d" - } - }, - "example": "1d" - }, - { - "name": "search_type", - "in": "query", - "schema": { - "$ref": "#/components/schemas/SearchType" - } - }, - { - "name": "seq_no_primary_term", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "size", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "sort", - "in": "query", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "explode": true - }, - { - "name": "source", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "source_excludes", - "in": "query", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "explode": true - }, - { - "name": "source_includes", - "in": "query", - "style": "form", - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "explode": true - }, - { - "name": "stats", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "stored_fields", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "suggest_field", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "suggest_mode", - "in": "query", - "schema": { - "$ref": "#/components/schemas/SuggestMode" - } - }, - { - "name": "suggest_size", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "suggest_text", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "terminate_after", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "track_scores", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "track_total_hits", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "typed_keys", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "version", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "PostSearchWithIndex 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PostSearchWithIndexResponseContent" - }, - "examples": { - "PostSearchWithIndex_example1": { - "summary": "Examples for Post Search With Index Operation.", - "description": "", - "value": { - "timed_out": false, - "_shards": { - "total": 1, - "successful": 1, - "skipped": 0, - "failed": 0 - }, - "hits": { - "total": { - "value": 0, - "relation": "eq" - }, - "hits": [] - } - } - } - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "DefaultOperator": { - "type": "string", - "enum": [ - "AND", - "OR" - ] - }, - "ExpandWildcards": { - "type": "string", - "enum": [ - "all", - "open", - "closed", - "hidden", - "none" - ] - }, - "Hits": { - "type": "object", - "properties": { - "_index": { - "type": "string" - }, - "_type": { - "type": "string" - }, - "_id": { - "type": "string" - }, - "_score": { - "type": "number", - "format": "float" - }, - "_source": {}, - "fields": {} - } - }, - "HitsMetadata": { - "type": "object", - "properties": { - "total": { - "$ref": "#/components/schemas/Total" - }, - "max_score": { - "type": "number", - "format": "double" - }, - "hits": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Hits" - } - } - } - }, - "PostSearchRequestContent": { - "type": "object", - "properties": { - "docvalue_fields": { - "type": "string" - }, - "explain": { - "type": "boolean" - }, - "from": { - "type": "number" - }, - "seq_no_primary_term": { - "type": "boolean" - }, - "size": { - "type": "number" - }, - "source": { - "type": "string" - }, - "stats": { - "type": "string" - }, - "terminate_after": { - "type": "number" - }, - "timeout": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - }, - "version": { - "type": "boolean" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "min_score": { - "type": "number" - }, - "indices_boost": { - "type": "array", - "items": {} - }, - "query": { - "$ref": "#/components/schemas/UserDefinedObjectStructure" - } - } - }, - "PostSearchResponseContent": { - "type": "object", - "properties": { - "_scroll_id": { - "type": "string" - }, - "took": { - "type": "number" - }, - "timed_out": { - "type": "boolean" - }, - "_shards": { - "$ref": "#/components/schemas/ShardStatistics" - }, - "hits": { - "$ref": "#/components/schemas/HitsMetadata" - } - }, - "example": { - "timed_out": false, - "_shards": { - "total": 1, - "successful": 1, - "skipped": 0, - "failed": 0 - }, - "hits": { - "total": { - "value": 0, - "relation": "eq" - }, - "hits": [] - } - } - }, - "PostSearchWithIndexRequestContent": { - "type": "object", - "properties": { - "docvalue_fields": { - "type": "string" - }, - "explain": { - "type": "boolean" - }, - "from": { - "type": "number" - }, - "seq_no_primary_term": { - "type": "boolean" - }, - "size": { - "type": "number" - }, - "source": { - "type": "string" - }, - "stats": { - "type": "string" - }, - "terminate_after": { - "type": "number" - }, - "timeout": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - }, - "version": { - "type": "boolean" - }, - "fields": { - "type": "array", - "items": { - "type": "string" - } - }, - "min_score": { - "type": "number" - }, - "indices_boost": { - "type": "array", - "items": {} - }, - "query": { - "$ref": "#/components/schemas/UserDefinedObjectStructure" - } - } - }, - "PostSearchWithIndexResponseContent": { - "type": "object", - "properties": { - "_scroll_id": { - "type": "string" - }, - "took": { - "type": "number" - }, - "timed_out": { - "type": "boolean" - }, - "_shards": { - "$ref": "#/components/schemas/ShardStatistics" - }, - "hits": { - "$ref": "#/components/schemas/HitsMetadata" - } - }, - "example": { - "timed_out": false, - "_shards": { - "total": 1, - "successful": 1, - "skipped": 0, - "failed": 0 - }, - "hits": { - "total": { - "value": 0, - "relation": "eq" - }, - "hits": [] - } - } - }, - "Relation": { - "type": "string", - "enum": [ - "eq", - "gte" - ] - }, - "SearchType": { - "type": "string", - "enum": [ - "0", - "1" - ] - }, - "ShardStatistics": { - "type": "object", - "properties": { - "total": { - "type": "number" - }, - "successful": { - "type": "number" - }, - "skipped": { - "type": "number" - }, - "failed": { - "type": "number" - } - } - }, - "SuggestMode": { - "type": "string", - "enum": [ - "0", - "1", - "2" - ] - }, - "Total": { - "type": "object", - "properties": { - "value": { - "type": "number" - }, - "relation": { - "$ref": "#/components/schemas/Relation" - } - } - }, - "UserDefinedObjectStructure": { - "type": "object", - "properties": { - "bool": {}, - "boosting": {}, - "combined_fields": {}, - "constant_score": {}, - "dis_max": {}, - "distance_feature": {}, - "exists": {}, - "function_score": {}, - "fuzzy": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "geo_bounding_box": {}, - "geo_distance": {}, - "geo_polygon": {}, - "geo_shape": {}, - "has_child": {}, - "has_parent": {}, - "ids": {}, - "intervals": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "knn": {}, - "match": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "match_all": {}, - "match_bool_prefix": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "match_none": {}, - "match_phrase": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "match_phrase_prefix": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "more_like_this": {}, - "multi_match": {}, - "nested": {}, - "parent_id": {}, - "percolate": {}, - "pinned": {}, - "prefix": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "query_string": {}, - "range": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "rank_feature": {}, - "regexp": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "script": {}, - "script_score": {}, - "shape": {}, - "simple_query_string": {}, - "span_containing": {}, - "field_masking_span": {}, - "span_first": {}, - "span_multi": {}, - "span_near": {}, - "span_not": {}, - "span_or": {}, - "span_term": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "span_within": {}, - "term": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "terms": {}, - "terms_set": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "wildcard": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "wrapper": {} - } - }, - "UserDefinedValueMap": { - "type": "object", - "additionalProperties": {} - } - }, - "securitySchemes": { - "smithy.api.httpBasicAuth": { - "type": "http", - "description": "HTTP Basic authentication", - "scheme": "Basic" - } - } - }, - "security": [ - { - "smithy.api.httpBasicAuth": [] - } - ] - } \ No newline at end of file diff --git a/test/models/_global/search/hooks.js b/test/models/_global/search/hooks.js deleted file mode 100644 index c0354122..00000000 --- a/test/models/_global/search/hooks.js +++ /dev/null @@ -1,111 +0,0 @@ -const https = require('https'); -const fetch = require('node-fetch') -const hooks = require('hooks'); -const fs = require('fs') - -var host = ""; -var protocol = "https"; -var auth = ""; - -// Reading .txt file to set URL -const data = fs.readFileSync('url.txt', {encoding:'utf8', flag:'r'}); -function address() -{ - text = data.toString(); - text = text.split(" "); - host = text[0].substring(8,text[0].length); - auth = text[1]; - return (protocol + "://" + auth + "@" + host); -} - -// POST SEARCH - -hooks.before("/_search > POST > 200 > application/json",function(transactions,done) { - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - - const request = async () => { - - var url = address(); - - // Create an index with non-default settings. - const cluster = await fetch(url+'/books',{ - method: 'PUT', - body:JSON.stringify({ - settings : { - index: { - number_of_shards:1, - number_of_replicas:0 - } - } - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - done(); - } - request(); -}); - -hooks.after("/_search > POST > 200 > application/json",function(transactions,done){ - - const request = async () => { - - var url = address(); - // Deleting cluster - const del = await fetch(url+'/books',{ - method: 'DELETE' - }); - - done(); - } - request(); -}); - -// POST SEARCH INDEX API. - -hooks.before("/{index}/_search > POST > 200 > application/json",function(transactions,done) { - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - - const request = async () => { - - var url = address(); - - // Create an index with non-default settings. - const cluster = await fetch(url+'/books',{ - method: 'PUT', - body:JSON.stringify({ - settings : { - index: { - number_of_shards:1, - number_of_replicas:0 - } - } - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - done(); - } - request(); -}); - -hooks.after("/{index}/_search > POST > 200 > application/json",function(transactions,done){ - - const request = async () => { - - var url = address(); - // Deleting cluster - const del = await fetch(url+'/books',{ - method: 'DELETE' - }); - - done(); - } - request(); - -}); - diff --git a/test/models/cat/indices/OpenSearchModel.json b/test/models/cat/indices/OpenSearchModel.json deleted file mode 100644 index b2bde956..00000000 --- a/test/models/cat/indices/OpenSearchModel.json +++ /dev/null @@ -1,236 +0,0 @@ -{ - "openapi": "3.0.2", - "info": { - "title": "OpenSearch", - "version": "2021-11-23" - }, - "paths": { - "/_cat/indices": { - "get": { - "description": "Returns information about indices: number of primaries and replicas, document counts, disk size, etc.", - "operationId": "GetCatIndices", - "parameters": [ - { - "name": "master_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "bytes", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "expand_wildcards", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "health", - "in": "query", - "schema": { - "$ref": "#/components/schemas/HealthStatus" - } - }, - { - "name": "include_unloaded_segments", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "pri", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "time", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "format", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "GetCatIndices 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetCatIndicesOutputPayload" - } - } - } - } - } - } - }, - "/_cat/indices/{index}": { - "get": { - "description": "Returns information about indices: number of primaries and replicas, document counts, disk size, etc.", - "operationId": "GetCatIndicesWithIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "schema": { - "type": "string", - "pattern": "^[^+_\\-\\.][^\\\\, /*?\"<>| ,#\\nA-Z]+$" - }, - "required": true, - "examples": { - "GetCatIndicesWithIndex_example1": { - "summary": "Examples for Cat indices with Index Operation.", - "description": "", - "value": "books" - } - }, - "example": "books" - }, - { - "name": "master_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "bytes", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "expand_wildcards", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "health", - "in": "query", - "schema": { - "$ref": "#/components/schemas/HealthStatus" - } - }, - { - "name": "include_unloaded_segments", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "pri", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "time", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "format", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "GetCatIndicesWithIndex 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetCatIndicesWithIndexOutputPayload" - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "ExpandWildcards": { - "type": "string", - "enum": [ - "all", - "open", - "closed", - "hidden", - "none" - ] - }, - "GetCatIndicesOutputPayload": {}, - "GetCatIndicesWithIndexOutputPayload": {}, - "HealthStatus": { - "type": "string", - "enum": [ - "green", - "yellow", - "red" - ] - } - }, - "securitySchemes": { - "smithy.api.httpBasicAuth": { - "type": "http", - "description": "HTTP Basic authentication", - "scheme": "Basic" - } - } - }, - "security": [ - { - "smithy.api.httpBasicAuth": [] - } - ] - } \ No newline at end of file diff --git a/test/models/cat/indices/hooks.js b/test/models/cat/indices/hooks.js deleted file mode 100644 index a12f1106..00000000 --- a/test/models/cat/indices/hooks.js +++ /dev/null @@ -1,85 +0,0 @@ -const https = require('https'); -const fetch = require('node-fetch') -const hooks = require('hooks'); -const fs = require('fs') - -var host = ""; -var protocol = "https"; -var auth = ""; - -// Reading .txt file to set URL -const data = fs.readFileSync('url.txt', {encoding:'utf8', flag:'r'}); -function address() -{ - text = data.toString(); - text = text.split(" "); - host = text[0].substring(8,text[0].length); - auth = text[1]; - return (protocol + "://" + auth + "@" + host); -} - -// Cat Indices API - -hooks.before("/_cat/indices > GET > 200 > application/json",function(transactions,done){ - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - done(); -}); - -// Cat Indices with Index - -hooks.before("/_cat/indices/{index} > GET > 200 > application/json",function(transactions,done) { - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - - const request = async () => { - - var url = address(); - - // Create an index with non-default settings. - const cluster = await fetch(url+'/books',{ - method: 'PUT', - body:JSON.stringify({ - settings : { - index: { - number_of_shards:1, - number_of_replicas:0 - } - } - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - // Adding Document in cluster - const document = await fetch(url+'/books/_doc/1',{ - method: 'PUT', - body:JSON.stringify({ - title: "The Outsider", - author: "Stephen King", - year: "2018", - genre: "Crime fiction" - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - done(); - } - request(); -}); - -hooks.after("/_cat/indices/{index} > GET > 200 > application/json",function(transactions, done){ - - const request = async () => { - - var url = address(); - // Deleting cluster - const del = await fetch(url+'/books',{ - method: 'DELETE' - }); - - done(); - } - request(); -}); diff --git a/test/models/cat/nodes/OpenSearchModel.json b/test/models/cat/nodes/OpenSearchModel.json deleted file mode 100644 index 258940a8..00000000 --- a/test/models/cat/nodes/OpenSearchModel.json +++ /dev/null @@ -1,106 +0,0 @@ -{ - "openapi": "3.0.2", - "info": { - "title": "OpenSearch", - "version": "2021-11-23" - }, - "paths": { - "/_cat/nodes": { - "get": { - "description": "Returns basic statistics about performance of cluster nodes.", - "operationId": "GetCatNodes", - "parameters": [ - { - "name": "master_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "bytes", - "in": "query", - "schema": { - "type": "number" - } - }, - { - "name": "full_id", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "local", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "time", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "include_unloaded_segments", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "format", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "GetCatNodes 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetCatNodesOutputPayload" - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "GetCatNodesOutputPayload": {} - }, - "securitySchemes": { - "smithy.api.httpBasicAuth": { - "type": "http", - "description": "HTTP Basic authentication", - "scheme": "Basic" - } - } - }, - "security": [ - { - "smithy.api.httpBasicAuth": [] - } - ] - } \ No newline at end of file diff --git a/test/models/cat/nodes/hooks.js b/test/models/cat/nodes/hooks.js deleted file mode 100644 index 12571ab7..00000000 --- a/test/models/cat/nodes/hooks.js +++ /dev/null @@ -1,6 +0,0 @@ -const hooks = require('hooks'); - -hooks.before("/_cat/nodes > GET > 200 > application/json",function(transactions,done){ - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - done(); -}); diff --git a/test/models/cluster/get_settings/OpenSearchModel.json b/test/models/cluster/get_settings/OpenSearchModel.json deleted file mode 100644 index ebb6b8fd..00000000 --- a/test/models/cluster/get_settings/OpenSearchModel.json +++ /dev/null @@ -1,109 +0,0 @@ -{ - "openapi": "3.0.2", - "info": { - "title": "OpenSearch", - "version": "2021-11-23" - }, - "paths": { - "/_cluster/settings": { - "get": { - "description": "Returns cluster settings.", - "operationId": "GetClusterSettings", - "parameters": [ - { - "name": "master_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "flat_settings", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "include_defaults", - "in": "query", - "schema": { - "type": "boolean" - }, - "examples": { - "GetClusterSettings_example1": { - "summary": "Examples for Get cluster settings Operation.", - "description": "", - "value": true - } - }, - "example": true - } - ], - "responses": { - "200": { - "description": "GetClusterSettings 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetClusterSettingsResponseContent" - }, - "examples": { - "GetClusterSettings_example1": { - "summary": "Examples for Get cluster settings Operation.", - "description": "", - "value": {} - } - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "GetClusterSettingsResponseContent": { - "type": "object", - "properties": { - "persistent": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "transient": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "defaults": { - "$ref": "#/components/schemas/UserDefinedValueMap" - } - } - }, - "UserDefinedValueMap": { - "type": "object", - "additionalProperties": {} - } - }, - "securitySchemes": { - "smithy.api.httpBasicAuth": { - "type": "http", - "description": "HTTP Basic authentication", - "scheme": "Basic" - } - } - }, - "security": [ - { - "smithy.api.httpBasicAuth": [] - } - ] - } \ No newline at end of file diff --git a/test/models/cluster/get_settings/hooks.js b/test/models/cluster/get_settings/hooks.js deleted file mode 100644 index 1993e3f4..00000000 --- a/test/models/cluster/get_settings/hooks.js +++ /dev/null @@ -1,64 +0,0 @@ -const https = require('https'); -const fetch = require('node-fetch') -const hooks = require('hooks'); -const fs = require('fs') - -var host = ""; -var protocol = "https"; -var auth = ""; - -// Reading .txt file to set URL -const data = fs.readFileSync('url.txt', {encoding:'utf8', flag:'r'}); -function address() -{ - text = data.toString(); - text = text.split(" "); - host = text[0].substring(8,text[0].length); - auth = text[1]; - return (protocol + "://" + auth + "@" + host); -} - -hooks.before("/_cluster/settings > GET > 200 > application/json",function(transactions,done) { - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - - const request = async () => { - - var url = address(); - - // Create an index with non-default settings. - const cluster = await fetch(url+'/books',{ - method: 'PUT', - body:JSON.stringify({ - settings : { - index: { - number_of_shards:1, - number_of_replicas:0 - } - } - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - done(); - } - request(); -}); - -hooks.after("/_cluster/settings > GET > 200 > application/json",function(transactions, done){ - - const request = async () => { - - var url = address(); - - // Deleting cluster - const del = await fetch(url+'/books',{ - method: 'DELETE' - }); - - done(); - } - request(); -}); - diff --git a/test/models/cluster/put_settings/OpenSearchModel.json b/test/models/cluster/put_settings/OpenSearchModel.json deleted file mode 100644 index e099a40a..00000000 --- a/test/models/cluster/put_settings/OpenSearchModel.json +++ /dev/null @@ -1,115 +0,0 @@ -{ - "openapi": "3.0.2", - "info": { - "title": "OpenSearch", - "version": "2021-11-23" - }, - "paths": { - "/_cluster/settings": { - "put": { - "description": "Updates the cluster settings.", - "operationId": "PutUpdateClusterSettings", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PutUpdateClusterSettingsRequestContent" - } - } - } - }, - "parameters": [ - { - "name": "master_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "flat_settings", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - } - ], - "responses": { - "200": { - "description": "PutUpdateClusterSettings 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PutUpdateClusterSettingsResponseContent" - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "PutUpdateClusterSettingsRequestContent": { - "type": "object", - "properties": { - "persistent": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "transient": { - "$ref": "#/components/schemas/UserDefinedValueMap" - } - } - }, - "PutUpdateClusterSettingsResponseContent": { - "type": "object", - "properties": { - "acknowledged": { - "type": "boolean" - }, - "persistent": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "transient": { - "$ref": "#/components/schemas/UserDefinedValueMap" - } - } - }, - "UserDefinedValueMap": { - "type": "object", - "additionalProperties": {} - } - }, - "securitySchemes": { - "smithy.api.httpBasicAuth": { - "type": "http", - "description": "HTTP Basic authentication", - "scheme": "Basic" - } - } - }, - "security": [ - { - "smithy.api.httpBasicAuth": [] - } - ] - } \ No newline at end of file diff --git a/test/models/cluster/put_settings/hooks.js b/test/models/cluster/put_settings/hooks.js deleted file mode 100644 index 2285eb15..00000000 --- a/test/models/cluster/put_settings/hooks.js +++ /dev/null @@ -1,74 +0,0 @@ -const https = require('https'); -const fetch = require('node-fetch') -const hooks = require('hooks'); -const fs = require('fs') - -var host = ""; -var protocol = "https"; -var auth = ""; - -// Reading .txt file to set URL -const data = fs.readFileSync('url.txt', {encoding:'utf8', flag:'r'}); -function address() -{ - text = data.toString(); - text = text.split(" "); - host = text[0].substring(8,text[0].length); - auth = text[1]; - return (protocol + "://" + auth + "@" + host); -} - -hooks.before("/_cluster/settings > PUT > 200 > application/json",function(transactions,done) { - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - - const request = async () => { - - var url = address(); - - // Create an index with non-default settings. - const cluster = await fetch(url+'/books',{ - method: 'PUT', - body:JSON.stringify({ - settings : { - index: { - number_of_shards:1, - number_of_replicas:0 - } - } - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - const persistent = { - persistent : { - cluster : { - max_shards_per_node : 500 - } - } - } - - transactions.request.headers['Content-Type'] = "application/json; charset=UTF-8"; - transactions.request.body = JSON.stringify(persistent); - done(); - } - request(); -}); - -hooks.after("/_cluster/settings > PUT > 200 > application/json",function(transactions, done){ - - const request = async () => { - - var url = address(); - - // Deleting cluster - const del = await fetch(url+'/books',{ - method: 'DELETE' - }); - - done(); - } - request(); -}); - diff --git a/test/models/indices/create/OpenSearchModel.json b/test/models/indices/create/OpenSearchModel.json deleted file mode 100644 index a2f976bf..00000000 --- a/test/models/indices/create/OpenSearchModel.json +++ /dev/null @@ -1,171 +0,0 @@ -{ - "openapi": "3.0.2", - "info": { - "title": "OpenSearch", - "version": "2021-11-23" - }, - "paths": { - "/{index}": { - "put": { - "description": "Creates index mappings.", - "operationId": "PutCreateIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PutCreateIndexRequestContent" - }, - "examples": { - "PutCreateIndex_example1": { - "summary": "Examples for Create Index Operation.", - "description": "", - "value": {} - } - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "schema": { - "type": "string", - "pattern": "^[^+_\\-\\.][^\\\\, /*?\"<>| ,#\\nA-Z]+$" - }, - "required": true, - "examples": { - "PutCreateIndex_example1": { - "summary": "Examples for Create Index Operation.", - "description": "", - "value": "books" - } - }, - "example": "books" - }, - { - "name": "master_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "include_type_name", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "wait_for_active_shards", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - } - ], - "responses": { - "200": { - "description": "PutCreateIndex 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PutCreateIndexResponseContent" - }, - "examples": { - "PutCreateIndex_example1": { - "summary": "Examples for Create Index Operation.", - "description": "", - "value": { - "index": "books", - "shards_acknowledged": true, - "acknowledged": true - } - } - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "PutCreateIndexRequestContent": { - "type": "object", - "properties": { - "aliases": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "mapping": { - "$ref": "#/components/schemas/UserDefinedValueMap" - }, - "settings": { - "$ref": "#/components/schemas/UserDefinedValueMap" - } - } - }, - "PutCreateIndexResponseContent": { - "type": "object", - "properties": { - "index": { - "type": "string", - "pattern": "^[^+_\\-\\.][^\\\\, /*?\"<>| ,#\\nA-Z]+$" - }, - "shards_acknowledged": { - "type": "boolean" - }, - "acknowledged": { - "type": "boolean" - } - }, - "required": [ - "acknowledged", - "index", - "shards_acknowledged" - ], - "example": { - "index": "books", - "shards_acknowledged": true, - "acknowledged": true - } - }, - "UserDefinedValueMap": { - "type": "object", - "additionalProperties": {} - } - }, - "securitySchemes": { - "smithy.api.httpBasicAuth": { - "type": "http", - "description": "HTTP Basic authentication", - "scheme": "Basic" - } - } - }, - "security": [ - { - "smithy.api.httpBasicAuth": [] - } - ] - } \ No newline at end of file diff --git a/test/models/indices/create/hooks.js b/test/models/indices/create/hooks.js deleted file mode 100644 index a0d38a78..00000000 --- a/test/models/indices/create/hooks.js +++ /dev/null @@ -1,52 +0,0 @@ -const https = require('https'); -const fetch = require('node-fetch') -const hooks = require('hooks'); -const fs = require('fs') - -var host = ""; -var protocol = "https"; -var auth = ""; - -// Reading .txt file to set URL -const data = fs.readFileSync('url.txt', {encoding:'utf8', flag:'r'}); -function address() -{ - text = data.toString(); - text = text.split(" "); - host = text[0].substring(8,text[0].length); - auth = text[1]; - return (protocol + "://" + auth + "@" + host); -} - -hooks.before("/{index} > PUT > 200 > application/json",function(transactions,done) { - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - - var settings = { - settings : { - index: { - number_of_shards:1, - number_of_replicas:0 - } - } - } - - transactions.request.body = JSON.stringify(settings); - done(); -}); - -hooks.after("/{index} > PUT > 200 > application/json",function(transactions, done){ - - const request = async () => { - - var url = address(); - - // Deleting cluster - const del = await fetch(url+'/books',{ - method: 'DELETE' - }); - - done(); - } - request(); -}); - diff --git a/test/models/indices/delete/OpenSearchModel.json b/test/models/indices/delete/OpenSearchModel.json deleted file mode 100644 index d82c98d1..00000000 --- a/test/models/indices/delete/OpenSearchModel.json +++ /dev/null @@ -1,138 +0,0 @@ -{ - "openapi": "3.0.2", - "info": { - "title": "OpenSearch", - "version": "2021-11-23" - }, - "paths": { - "/{index}": { - "delete": { - "description": "Removes a document from the index.", - "operationId": "DeleteIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "schema": { - "type": "string", - "pattern": "^[^+_\\-\\.][^\\\\, /*?\"<>| ,#\\nA-Z]+$" - }, - "required": true, - "examples": { - "DeleteIndex_example1": { - "summary": "Examples for Delete Index Operation.", - "description": "", - "value": "books" - } - }, - "example": "books" - }, - { - "name": "master_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "allow_no_indices", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "expand_wildcards", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - } - ], - "responses": { - "200": { - "description": "DeleteIndex 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeleteIndexResponseContent" - }, - "examples": { - "DeleteIndex_example1": { - "summary": "Examples for Delete Index Operation.", - "description": "", - "value": { - "acknowledged": true - } - } - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "DeleteIndexResponseContent": { - "type": "object", - "properties": { - "acknowledged": { - "type": "boolean" - } - }, - "example": { - "acknowledged": true - } - }, - "ExpandWildcards": { - "type": "string", - "enum": [ - "all", - "open", - "closed", - "hidden", - "none" - ] - } - }, - "securitySchemes": { - "smithy.api.httpBasicAuth": { - "type": "http", - "description": "HTTP Basic authentication", - "scheme": "Basic" - } - } - }, - "security": [ - { - "smithy.api.httpBasicAuth": [] - } - ] - } \ No newline at end of file diff --git a/test/models/indices/delete/hooks.js b/test/models/indices/delete/hooks.js deleted file mode 100644 index 6e8116f5..00000000 --- a/test/models/indices/delete/hooks.js +++ /dev/null @@ -1,48 +0,0 @@ -const https = require('https'); -const fetch = require('node-fetch') -const hooks = require('hooks'); -const fs = require('fs') - -var host = ""; -var protocol = "https"; -var auth = ""; - -// Reading .txt file to set URL -const data = fs.readFileSync('url.txt', {encoding:'utf8', flag:'r'}); -function address() -{ - text = data.toString(); - text = text.split(" "); - host = text[0].substring(8,text[0].length); - auth = text[1]; - return (protocol + "://" + auth + "@" + host); -} - -hooks.before("/{index} > DELETE > 200 > application/json",function(transactions,done){ - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - - const request = async () => { - - var url = address(); - - // Create an index with non-default settings. - const cluster = await fetch(url+'/books',{ - method: 'PUT', - body:JSON.stringify({ - settings : { - index: { - number_of_shards:1, - number_of_replicas:0 - } - } - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - done(); - } - request(); -}); - diff --git a/test/models/indices/get_settings/OpenSearchModel.json b/test/models/indices/get_settings/OpenSearchModel.json deleted file mode 100644 index 2ec0d1b5..00000000 --- a/test/models/indices/get_settings/OpenSearchModel.json +++ /dev/null @@ -1,245 +0,0 @@ -{ - "openapi": "3.0.2", - "info": { - "title": "OpenSearch", - "version": "2021-11-23" - }, - "paths": { - "/{index}/_settings": { - "get": { - "description": "The get settings API operation returns all the settings in your index.", - "operationId": "GetSettingsIndex", - "parameters": [ - { - "name": "index", - "in": "path", - "schema": { - "type": "string", - "pattern": "^[^+_\\-\\.][^\\\\, /*?\"<>| ,#\\nA-Z]+$" - }, - "required": true, - "examples": { - "GetSettingsIndex_example1": { - "summary": "Examples for Get settings Index Operation.", - "description": "", - "value": "books" - } - }, - "example": "books" - }, - { - "name": "master_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "allow_no_indices", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "expand_wildcards", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "flat_settings", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "include_defaults", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "local", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "GetSettingsIndex 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetSettingsIndexOutputPayload" - } - } - } - } - } - } - }, - "/{index}/_settings/{setting}": { - "get": { - "description": "The get settings API operation returns all the settings in your index.", - "operationId": "GetSettingsIndexSetting", - "parameters": [ - { - "name": "index", - "in": "path", - "schema": { - "type": "string", - "pattern": "^[^+_\\-\\.][^\\\\, /*?\"<>| ,#\\nA-Z]+$" - }, - "required": true, - "examples": { - "GetSettingsIndexSetting_example1": { - "summary": "Examples for Get settings Index-setting Operation.", - "description": "", - "value": "books" - } - }, - "example": "books" - }, - { - "name": "setting", - "in": "path", - "schema": { - "type": "string" - }, - "required": true, - "examples": { - "GetSettingsIndexSetting_example1": { - "summary": "Examples for Get settings Index-setting Operation.", - "description": "", - "value": "index" - } - }, - "example": "index" - }, - { - "name": "master_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "allow_no_indices", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "expand_wildcards", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "flat_settings", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "include_defaults", - "in": "query", - "schema": { - "type": "string" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "local", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "GetSettingsIndexSetting 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetSettingsIndexSettingOutputPayload" - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "ExpandWildcards": { - "type": "string", - "enum": [ - "all", - "open", - "closed", - "hidden", - "none" - ] - }, - "GetSettingsIndexOutputPayload": {}, - "GetSettingsIndexSettingOutputPayload": {} - }, - "securitySchemes": { - "smithy.api.httpBasicAuth": { - "type": "http", - "description": "HTTP Basic authentication", - "scheme": "Basic" - } - } - }, - "security": [ - { - "smithy.api.httpBasicAuth": [] - } - ] - } \ No newline at end of file diff --git a/test/models/indices/get_settings/hooks.js b/test/models/indices/get_settings/hooks.js deleted file mode 100644 index 60064af7..00000000 --- a/test/models/indices/get_settings/hooks.js +++ /dev/null @@ -1,140 +0,0 @@ -const https = require('https'); -const fetch = require('node-fetch') -const hooks = require('hooks'); -const fs = require('fs') - -var host = ""; -var protocol = "https"; -var auth = ""; - -// Reading .txt file to set URL -const data = fs.readFileSync('url.txt', {encoding:'utf8', flag:'r'}); -function address() -{ - text = data.toString(); - text = text.split(" "); - host = text[0].substring(8,text[0].length); - auth = text[1]; - return (protocol + "://" + auth + "@" + host); -} - -// Get Settings API - -hooks.before("/{index}/_settings > GET > 200 > application/json",function(transactions,done) { - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - - const request = async () => { - - var url = address(); - - // Create an index with non-default settings. - const cluster = await fetch(url+'/books',{ - method: 'PUT', - body:JSON.stringify({ - settings : { - index: { - number_of_shards:1, - number_of_replicas:0 - } - } - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - // Adding Document in cluster - const document = await fetch(url+'/books/_doc/1',{ - method: 'PUT', - body:JSON.stringify({ - title: "The Outsider", - author: "Stephen King", - year: "2018", - genre: "Crime fiction" - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - done(); - } - request(); -}); - -hooks.after("/{index}/_settings > GET > 200 > application/json",function(transactions,done){ - - const request = async () => { - - var url = address(); - - // Deleting cluster - const del = await fetch(url+'/books',{ - method: 'DELETE' - }); - - done(); - } - request(); -}); - -// Get Settings API - -hooks.before("/{index}/_settings/{setting} > GET > 200 > application/json",function(transactions,done) { - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - - const request = async () => { - - var url = address(); - - // Create an index with non-default settings. - const cluster = await fetch(url+'/books',{ - method: 'PUT', - body:JSON.stringify({ - settings : { - index: { - number_of_shards:1, - number_of_replicas:0 - } - } - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - // Adding Document in cluster - const document = await fetch(url+'/books/_doc/1',{ - method: 'PUT', - body:JSON.stringify({ - title: "The Outsider", - author: "Stephen King", - year: "2018", - genre: "Crime fiction" - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - done(); - } - request(); -}); - -hooks.after("/{index}/_settings/{setting} > GET > 200 > application/json",function(transactions,done){ - - const request = async () => { - - var url = address(); - - // Deleting cluster - const del = await fetch(url+'/books',{ - method: 'DELETE' - }); - - done(); - } - request(); -}); - diff --git a/test/models/indices/put_mapping/OpenSearchModel.json b/test/models/indices/put_mapping/OpenSearchModel.json deleted file mode 100644 index 6d9a775f..00000000 --- a/test/models/indices/put_mapping/OpenSearchModel.json +++ /dev/null @@ -1,174 +0,0 @@ -{ - "openapi": "3.0.2", - "info": { - "title": "OpenSearch", - "version": "2021-11-23" - }, - "paths": { - "/{index}/_mapping": { - "put": { - "description": "The put mapping API operation lets you add new mappings and fields to an index.", - "operationId": "PutIndexMappingWithIndex", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PutIndexMappingWithIndexRequestContent" - }, - "examples": { - "PutIndexMappingWithIndex_example1": { - "summary": "Examples for Put Index Mapping with index Operation.", - "description": "", - "value": {} - } - } - } - } - }, - "parameters": [ - { - "name": "index", - "in": "path", - "schema": { - "type": "string", - "pattern": "^[^+_\\-\\.][^\\\\, /*?\"<>| ,#\\nA-Z]+$" - }, - "required": true, - "examples": { - "PutIndexMappingWithIndex_example1": { - "summary": "Examples for Put Index Mapping with index Operation.", - "description": "", - "value": "books" - } - }, - "example": "books" - }, - { - "name": "master_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "allow_no_indices", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "expand_wildcards", - "in": "query", - "schema": { - "$ref": "#/components/schemas/ExpandWildcards" - } - }, - { - "name": "ignore_unavailable", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "include_type_name", - "in": "query", - "schema": { - "type": "boolean" - } - }, - { - "name": "timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "write_index_only", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "PutIndexMappingWithIndex 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PutIndexMappingWithIndexResponseContent" - }, - "examples": { - "PutIndexMappingWithIndex_example1": { - "summary": "Examples for Put Index Mapping with index Operation.", - "description": "", - "value": { - "acknowledged": true - } - } - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "ExpandWildcards": { - "type": "string", - "enum": [ - "all", - "open", - "closed", - "hidden", - "none" - ] - }, - "PutIndexMappingWithIndexRequestContent": { - "type": "object", - "properties": { - "properties": {} - } - }, - "PutIndexMappingWithIndexResponseContent": { - "type": "object", - "properties": { - "acknowledged": { - "type": "boolean" - } - }, - "example": { - "acknowledged": true - } - } - }, - "securitySchemes": { - "smithy.api.httpBasicAuth": { - "type": "http", - "description": "HTTP Basic authentication", - "scheme": "Basic" - } - } - }, - "security": [ - { - "smithy.api.httpBasicAuth": [] - } - ] - } \ No newline at end of file diff --git a/test/models/indices/put_mapping/hooks.js b/test/models/indices/put_mapping/hooks.js deleted file mode 100644 index 3ac096b0..00000000 --- a/test/models/indices/put_mapping/hooks.js +++ /dev/null @@ -1,77 +0,0 @@ -const https = require('https'); -const fetch = require('node-fetch') -const hooks = require('hooks'); -const fs = require('fs') - -var host = ""; -var protocol = "https"; -var auth = ""; - -// Reading .txt file to set URL -const data = fs.readFileSync('url.txt', {encoding:'utf8', flag:'r'}); -function address() -{ - text = data.toString(); - text = text.split(" "); - host = text[0].substring(8,text[0].length); - auth = text[1]; - return (protocol + "://" + auth + "@" + host); -} - -// Put Mapping with Index. - -hooks.before("/{index}/_mapping > PUT > 200 > application/json",function(transactions,done) { - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - - const request = async () => { - - var url = address(); - - // Create an index with non-default settings. - const cluster = await fetch(url+'/books',{ - method: 'PUT', - body:JSON.stringify({ - settings : { - index: { - number_of_shards:1, - number_of_replicas:0 - } - } - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - var mappings = { - properties:{ - year:{ - type: "text" - } - } - } - - transactions.request.body = JSON.stringify(mappings); - done(); - } - request(); -}); - -hooks.after("/{index}/_mapping > PUT > 200 > application/json",function(transactions,done){ - - const request = async () => { - - var url = address(); - - // Deleting cluster - const del = await fetch(url+'/books',{ - method: 'DELETE' - }); - - done(); - } - request(); -}); - diff --git a/test/models/indices/update_aliases/OpenSearchModel.json b/test/models/indices/update_aliases/OpenSearchModel.json deleted file mode 100644 index 9af03594..00000000 --- a/test/models/indices/update_aliases/OpenSearchModel.json +++ /dev/null @@ -1,173 +0,0 @@ -{ - "openapi": "3.0.2", - "info": { - "title": "OpenSearch", - "version": "2021-11-23" - }, - "paths": { - "/_aliases": { - "post": { - "description": "Adds or removes index aliases.", - "operationId": "PostAliases", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PostAliasesRequestContent" - }, - "examples": { - "PostAliases_example1": { - "summary": "Examples for Post Aliases Operation.", - "description": "", - "value": {} - } - } - } - } - }, - "parameters": [ - { - "name": "master_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$", - "deprecated": true - } - }, - { - "name": "cluster_manager_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - } - ], - "responses": { - "200": { - "description": "PostAliases 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PostAliasesResponseContent" - }, - "examples": { - "PostAliases_example1": { - "summary": "Examples for Post Aliases Operation.", - "description": "", - "value": { - "acknowledged": true - } - } - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "ActionObjectStructure": { - "type": "object", - "properties": { - "add": { - "$ref": "#/components/schemas/UserDefinedStructure" - }, - "remove": { - "$ref": "#/components/schemas/UserDefinedStructure" - }, - "remove_index": { - "$ref": "#/components/schemas/UserDefinedStructure" - } - } - }, - "PostAliasesRequestContent": { - "type": "object", - "properties": { - "actions": { - "$ref": "#/components/schemas/ActionObjectStructure" - } - } - }, - "PostAliasesResponseContent": { - "type": "object", - "properties": { - "acknowledged": { - "type": "boolean" - } - }, - "required": [ - "acknowledged" - ], - "example": { - "acknowledged": true - } - }, - "UserDefinedStructure": { - "type": "object", - "properties": { - "alias": { - "type": "string" - }, - "aliases": { - "type": "array", - "items": { - "type": "string" - } - }, - "filter": {}, - "index": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "string" - } - }, - "index_routing": { - "type": "string" - }, - "is_hidden": { - "type": "boolean" - }, - "is_write_index": { - "type": "boolean" - }, - "must_exist": { - "type": "string" - }, - "routing": { - "type": "string" - }, - "search_routing": { - "type": "string" - } - } - } - }, - "securitySchemes": { - "smithy.api.httpBasicAuth": { - "type": "http", - "description": "HTTP Basic authentication", - "scheme": "Basic" - } - } - }, - "security": [ - { - "smithy.api.httpBasicAuth": [] - } - ] - } \ No newline at end of file diff --git a/test/models/indices/update_aliases/hooks.js b/test/models/indices/update_aliases/hooks.js deleted file mode 100644 index 8c35fb30..00000000 --- a/test/models/indices/update_aliases/hooks.js +++ /dev/null @@ -1,77 +0,0 @@ -const https = require('https'); -const fetch = require('node-fetch') -const hooks = require('hooks'); -const fs = require('fs') - -var host = ""; -var protocol = "https"; -var auth = ""; - -// Reading .txt file to set URL -const data = fs.readFileSync('url.txt', {encoding:'utf8', flag:'r'}); -function address() -{ - text = data.toString(); - text = text.split(" "); - host = text[0].substring(8,text[0].length); - auth = text[1]; - return (protocol + "://" + auth + "@" + host); -} - -hooks.before("/_aliases > POST > 200 > application/json",function(transactions,done) { - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - - const request = async () => { - - var url = address(); - - // Create an index with non-default settings. - const cluster = await fetch(url+'/books',{ - method: 'PUT', - body:JSON.stringify({ - settings : { - index: { - number_of_shards:1, - number_of_replicas:0 - } - } - }), - headers:{ - "content-type": "application/json; charset=UTF-8" - } - }); - - var actions = { - actions : [ - { - add: { - index: "books", - alias: "sample-aliases" - } - } - ] - } - - transactions.request.body = JSON.stringify(actions); - done(); - } - request(); - -}); - -hooks.after("/_aliases > POST > 200 > application/json",function(transactions, done){ - - const request = async () => { - - var url = address(); - - // Deleting cluster - const del = await fetch(url+'/books',{ - method: 'DELETE' - }); - - done(); - } - request(); -}); - diff --git a/test/models/remote_store/restore/OpenSearchModel.json b/test/models/remote_store/restore/OpenSearchModel.json deleted file mode 100644 index 170fb39e..00000000 --- a/test/models/remote_store/restore/OpenSearchModel.json +++ /dev/null @@ -1,169 +0,0 @@ -{ - "openapi": "3.0.2", - "info": { - "title": "OpenSearch", - "version": "2021-11-23" - }, - "paths": { - "/_remotestore/_restore": { - "post": { - "description": "Restore one or more indices from a remote backup.", - "operationId": "PostRemoteStoreRestore", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PostRemoteStoreRestoreRequestContent" - }, - "examples": { - "PostRemoteStoreRestore_example1": { - "summary": "Examples for Post Remote Storage Restore Operation.", - "description": "", - "value": { - "indices": [ - "books" - ] - } - } - } - } - }, - "required": true - }, - "parameters": [ - { - "name": "cluster_manager_timeout", - "in": "query", - "schema": { - "type": "string", - "pattern": "^([0-9]+)(?:d|h|m|s|ms|micros|nanos)$" - } - }, - { - "name": "wait_for_completion", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "PostRemoteStoreRestore 200 response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PostRemoteStoreRestoreResponseContent" - }, - "examples": { - "PostRemoteStoreRestore_example1": { - "summary": "Examples for Post Remote Storage Restore Operation.", - "description": "", - "value": { - "remote_store": { - "indices": [ - "books" - ], - "shards": { - "total": 1, - "failed": 0, - "successful": 1 - } - } - } - } - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "PostRemoteStoreRestoreRequestContent": { - "type": "object", - "properties": { - "indices": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[^+_\\-\\.][^\\\\, /*?\"<>| ,#\\nA-Z]+$" - } - } - }, - "required": [ - "indices" - ] - }, - "PostRemoteStoreRestoreResponseContent": { - "type": "object", - "properties": { - "accepted": { - "type": "boolean" - }, - "remote_store": { - "$ref": "#/components/schemas/RemoteStoreRestoreInfo" - } - }, - "example": { - "remote_store": { - "indices": [ - "books" - ], - "shards": { - "total": 1, - "failed": 0, - "successful": 1 - } - } - } - }, - "RemoteStoreRestoreInfo": { - "type": "object", - "properties": { - "snapshot": { - "type": "string" - }, - "indices": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[^+_\\-\\.][^\\\\, /*?\"<>| ,#\\nA-Z]+$" - } - }, - "shards": { - "$ref": "#/components/schemas/RemoteStoreRestoreShardsInfo" - } - } - }, - "RemoteStoreRestoreShardsInfo": { - "type": "object", - "properties": { - "total": { - "type": "number" - }, - "failed": { - "type": "number" - }, - "successful": { - "type": "number" - } - } - } - }, - "securitySchemes": { - "smithy.api.httpBasicAuth": { - "type": "http", - "description": "HTTP Basic authentication", - "scheme": "Basic" - } - } - }, - "security": [ - { - "smithy.api.httpBasicAuth": [] - } - ] - } \ No newline at end of file diff --git a/test/models/remote_store/restore/hooks.js b/test/models/remote_store/restore/hooks.js deleted file mode 100644 index 8a5ecade..00000000 --- a/test/models/remote_store/restore/hooks.js +++ /dev/null @@ -1,98 +0,0 @@ -const https = require('https'); -const fetch = require('node-fetch') -const hooks = require('hooks'); -const fs = require('fs'); - -var host = ""; -var protocol = "https"; -var auth = ""; - -// Reading .txt file to set URL -const data = fs.readFileSync('url.txt', {encoding:'utf8', flag:'r'}); -function address() -{ - text = data.toString(); - text = text.split(" "); - host = text[0].substring(8,text[0].length); - auth = text[1]; - return (protocol + "://" + auth + "@" + host); -} - -// Remote Storage Restore - -hooks.before("/_remotestore/_restore > POST > 200 > application/json", function(transactions, done) { - transactions.expected.headers['Content-Type'] = "application/json; charset=UTF-8"; - - const request = async () => { - - var url = address(); - - // Register repository for remote store - await fetch(url + '/_snapshot/books-repo', { - method: 'PUT', - body: JSON.stringify({ - type: 'fs', - settings: { - location: '/mnt/snapshots' - } - }), - headers: { - "content-type": "application/json; charset=UTF-8" - } - }); - - // Create an index configured for remote store - await fetch(url + '/books', { - method: 'PUT', - body: JSON.stringify({ - settings : { - index: { - number_of_shards: 1, - number_of_replicas: 0, - replication: { - type: 'SEGMENT' - }, - remote_store: { - enabled: true, - repository: 'books-repo' - } - } - } - }), - headers: { - "content-type": "application/json; charset=UTF-8" - } - }); - - // Close the index - await fetch(url + '/books/_close', { - method: 'POST' - }); - - done(); - } - - request(); -}); - -hooks.after("/_remotestore/_restore > POST > 200 > application/json", function(transactions, done) { - - const request = async () => { - - var url = address(); - - // Delete index - await fetch(url + '/books', { - method: 'DELETE' - }); - - // Delete repository - await fetch(url + '/_snapshot/books-repo', { - method: 'DELETE' - }); - - done(); - } - request(); -}); - diff --git a/test/opensearch/Dockerfile b/test/opensearch/Dockerfile deleted file mode 100644 index 01c07374..00000000 --- a/test/opensearch/Dockerfile +++ /dev/null @@ -1,7 +0,0 @@ -FROM opensearchproject/opensearch:2.11.1 - -USER root -RUN mkdir -p /mnt/snapshots && chown -R opensearch:opensearch /mnt/snapshots - -USER opensearch -VOLUME /mnt/snapshots diff --git a/test/package-lock.json b/test/package-lock.json deleted file mode 100644 index 9bedd90a..00000000 --- a/test/package-lock.json +++ /dev/null @@ -1,115 +0,0 @@ -{ - "name": "test", - "lockfileVersion": 2, - "requires": true, - "packages": { - "": { - "dependencies": { - "fs": "^0.0.1-security", - "hooks": "^0.3.2", - "https": "^1.0.0", - "node-fetch": "^2.6.7" - } - }, - "node_modules/fs": { - "version": "0.0.1-security", - "resolved": "https://registry.npmjs.org/fs/-/fs-0.0.1-security.tgz", - "integrity": "sha512-3XY9e1pP0CVEUCdj5BmfIZxRBTSDycnbqhIOGec9QYtmVH2fbLpj86CFWkrNOkt/Fvty4KZG5lTglL9j/gJ87w==" - }, - "node_modules/hooks": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/hooks/-/hooks-0.3.2.tgz", - "integrity": "sha512-TqeFzUf12rSzcbm5lUls81jimUC8TmXZ4ANPxxeeMou09hrjBcHYhAQ0WgyN5YqNCXOzz7L6xVNl/+ctFuSeOw==", - "engines": { - "node": ">=0.4.0" - } - }, - "node_modules/https": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/https/-/https-1.0.0.tgz", - "integrity": "sha512-4EC57ddXrkaF0x83Oj8sM6SLQHAWXw90Skqu2M4AEWENZ3F02dFJE/GARA8igO79tcgYqGrD7ae4f5L3um2lgg==" - }, - "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/tr46": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", - "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==" - }, - "node_modules/webidl-conversions": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", - "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==" - }, - "node_modules/whatwg-url": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", - "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==", - "dependencies": { - "tr46": "~0.0.3", - "webidl-conversions": "^3.0.0" - } - } - }, - "dependencies": { - "fs": { - "version": "0.0.1-security", - "resolved": "https://registry.npmjs.org/fs/-/fs-0.0.1-security.tgz", - "integrity": "sha512-3XY9e1pP0CVEUCdj5BmfIZxRBTSDycnbqhIOGec9QYtmVH2fbLpj86CFWkrNOkt/Fvty4KZG5lTglL9j/gJ87w==" - }, - "hooks": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/hooks/-/hooks-0.3.2.tgz", - "integrity": "sha512-TqeFzUf12rSzcbm5lUls81jimUC8TmXZ4ANPxxeeMou09hrjBcHYhAQ0WgyN5YqNCXOzz7L6xVNl/+ctFuSeOw==" - }, - "https": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/https/-/https-1.0.0.tgz", - "integrity": "sha512-4EC57ddXrkaF0x83Oj8sM6SLQHAWXw90Skqu2M4AEWENZ3F02dFJE/GARA8igO79tcgYqGrD7ae4f5L3um2lgg==" - }, - "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" - } - }, - "tr46": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", - "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==" - }, - "webidl-conversions": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", - "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==" - }, - "whatwg-url": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", - "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==", - "requires": { - "tr46": "~0.0.3", - "webidl-conversions": "^3.0.0" - } - } - } -} diff --git a/test/package.json b/test/package.json deleted file mode 100644 index c0fe6df7..00000000 --- a/test/package.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "dependencies": { - "fs": "^0.0.1-security", - "hooks": "^0.3.2", - "https": "^1.0.0", - "node-fetch": "^2.6.7" - } -} diff --git a/test/scripts/driver-code.py b/test/scripts/driver-code.py deleted file mode 100644 index 8eba5215..00000000 --- a/test/scripts/driver-code.py +++ /dev/null @@ -1,106 +0,0 @@ -import argparse -import os -from xmlrpc.client import boolean -from prettytable import PrettyTable - -class Dredd: - def __init__(self, endpoint, user, path, test_name, test_pass): - if endpoint is not None: - self.endpoint = endpoint - else: - self.endpoint = "https://127.0.0.1:9200" - - if user is not None: - self.user = user - else: - self.user = "admin:admin" - - if path is not None: - self.path = path - else: - self.path = "" - - if test_name is not None: - self.test_name = test_name - else: - self.test_name = "" - - if test_pass is not None: - self.test_pass = test_pass - else: - self.test_pass = False - - def write_file(self): - file_obj = open("url.txt", mode='w', encoding='utf-8') - text = self.endpoint + " " + self.user - file_obj.write(text) - file_obj.seek(0,0) - file_obj.close() - - def dredd_work(self): - # Walking in test directory tree and runing dredd framework. - test_failed_count = 0 - test_passed_count = 0 - test_failed = [] - test_passed = [] - test_passes = PrettyTable() - test_fails = PrettyTable() - for dirpath, dirnames, files in os.walk("../models"+self.path): - curr_path = dirpath.split('/') - curr_dir = curr_path[len(curr_path)-1] - if files: - command = "dredd " + dirpath +"/"+ files[1]+ " " + self.endpoint+ " --user=" + self.user + " --hookfiles=" + dirpath + "/" + files[0] - if self.test_name != "": - if self.test_name == curr_dir: - if(os.system(command)): - test_failed_count = test_failed_count + 1 - test_failed.append([curr_dir,dirpath]) - else: - test_passed_count = test_passed_count + 1 - test_passed.append([curr_dir,dirpath]) - else: - if(os.system(command)): - test_failed_count = test_failed_count + 1 - test_failed.append([curr_dir,dirpath]) - else: - test_passed_count = test_passed_count + 1 - test_passed.append([curr_dir,dirpath]) - print("Total number of test cases: ", test_failed_count + test_passed_count ) - print("Test Passed: ",test_passed_count) - print("Test failed: ",test_failed_count) - if self.test_pass == True: - test_passes.field_names = ["Model Name", "Directory Path"] - test_passes.add_rows(test_passed) - test_passes.align='l' - print("Results: Test cases passed.",test_passes,sep="\n") - - if test_failed_count != 0: - test_fails.field_names = ["Model Name", "Directory Path"] - test_fails.add_rows(test_failed) - test_fails.align='l' - print("Results: Test cases failed.",test_fails,sep="\n") - - # Removing temporary-credentials file. - os.remove('url.txt') - - return len(test_failed) - - -# Parsing command line arguments: -parser = argparse.ArgumentParser() - -parser.add_argument('--endpoint', type=str, required=False) -parser.add_argument('--user', type=str, required=False) -parser.add_argument('--path', type=str, required=False) -parser.add_argument('--testname', type=str, required=False) -parser.add_argument('--testpass', type=bool, required=False) -args = parser.parse_args() - -# Check whether default arguments provided by user: -obj = Dredd(args.endpoint, args.user, args.path, args.testname, args.testpass ) - -# Creating a intermediate file for storing URL. -obj.write_file() - -# Running dredd -exit(obj.dredd_work()) \ No newline at end of file diff --git a/test/scripts/operation-filter.py b/test/scripts/operation-filter.py deleted file mode 100644 index 5339847e..00000000 --- a/test/scripts/operation-filter.py +++ /dev/null @@ -1,123 +0,0 @@ -# NOTE: -# The OpenAPI smithy dependency currently does not support parsing -# examples from smithy models into an OpenAPI specs file. We can remove -# the script for manually parsing examples from json to openapi file once -# this dependency is supported. - -import argparse -import shutil -import json -import os - - -class OperationFilter: - def __init__(self, operations, output): - self.operations = operations - self.output = output - - def filter_operation(self): - # Creating a copy of opensearch.smithy file for altering operations. - original = r'../../model/opensearch.smithy' - target = r'opensearch_temp.smithy' - - shutil.copyfile(original, target) - - command = 'sed -e \'1h;2,$H;$!d;g\' -e "s/operations: \[[^]]*\]/operations: [' + self.operations + \ - ']/" opensearch_temp.smithy > ../../model/opensearch.smithy' - os.system(command) - - # Changing current directory for building model. - os.chdir('../../') - os.system('gradle build') - - # Back to current folder. - os.chdir('test/scripts/') - - # Replacing opensearch.smithy file with original content. - shutil.copyfile(target, original) - - # Removing temporary file. - os.remove("opensearch_temp.smithy") - - def parse_example(self,openapi_data, model_data): - dict = {} - # Parsing examples corresponding to operation-ids from Model json file. - for operation in model_data['shapes'].keys(): - # Checking operation-ids in Model json file. - if model_data['shapes'][operation]['type'] == 'operation': - if 'traits' in model_data['shapes'][operation].keys(): - # Checking examples for operation-id - if 'smithy.api#examples' in model_data['shapes'][operation]['traits'].keys(): - # Storing operation-id and examples in a dictionary. - dict[operation] = model_data['shapes'][operation]['traits']['smithy.api#examples'] - - # Checking URL endpoint in OpenAPI json file. - for endpoint in openapi_data['paths'].keys(): - # Checking URL method in OpenAPI json file. - for method in openapi_data['paths'][endpoint].keys(): - # Checking OperationId and title in OpenAPI json file and forming - # operation name. - title = openapi_data['info']['title'] - op_id = openapi_data['paths'][endpoint][method]['operationId'] - op_name = title + "#" + op_id - if op_name in dict.keys(): - for example in dict[op_name]: - # Adding examples for Input params - if 'input' in example: - for key in example['input']: - for param in openapi_data['paths'][endpoint][method]['parameters']: - if key == param['name']: - param['example'] = example['input'][key] - # Adding examples for Output params - if 'output' in example: - op_out_name = op_id + 'ResponseContent' - if op_out_name in openapi_data['components']['schemas'].keys(): - openapi_data['components']['schemas'][op_out_name]['example'] = example['output'] - - -# Parsing command line arguments: -parser = argparse.ArgumentParser() - -# Operation Agrument is required to specify operation-id's to be filtered out. -parser.add_argument('--operation', type=str, required=True) -parser.add_argument('--output', type=str, required=True) -args = parser.parse_args() - -# Checking values for Arguments. -obj = OperationFilter(args.operation, args.output) - -# Building smithy models as per user mentioned operation. -obj.filter_operation() - -# Opening OpenAPI JSON file for checking operation ID. -openapi_file_obj = open( - "../../build/smithyprojections/opensearch-api-specification/source/openapi/OpenSearch.openapi.json", - mode='r', - encoding='utf-8') -openapi_data = json.load(openapi_file_obj) - -# Opening Model JSON file for checking examples. -model_file_obj = open( - "../../build/smithyprojections/opensearch-api-specification/source/model/model.json", - mode='r', - encoding='utf-8') -model_data = json.load(model_file_obj) - -# calling parse function. -obj.parse_example(openapi_data, model_data) - -# Creating new JSON file for copying existing OpenAPI data and adding examples. -model_openapi_file_obj = open( - args.output + "/model.openapi.json", - mode='w', - encoding='utf-8') - -# Coverting python dictionary to JSON object. -json_data = json.dumps(openapi_data, indent=1) -model_openapi_file_obj.write(json_data) - -# Closing all files -openapi_file_obj.close() -model_file_obj.close() -model_openapi_file_obj.close() - diff --git a/tools/helpers.ts b/tools/helpers.ts new file mode 100644 index 00000000..3e1fa7ab --- /dev/null +++ b/tools/helpers.ts @@ -0,0 +1,8 @@ +export function resolve(ref: string, root: Record) { + const paths = ref.replace('#/', '').split('/'); + for(const p of paths) { + root = root[p]; + if(root === undefined) break; + } + return root; +} \ No newline at end of file diff --git a/tools/merger/OpenApiMerger.ts b/tools/merger/OpenApiMerger.ts new file mode 100644 index 00000000..1ecda892 --- /dev/null +++ b/tools/merger/OpenApiMerger.ts @@ -0,0 +1,112 @@ +import { OpenAPIV3 } from "openapi-types"; +import fs from 'fs'; +import _ from 'lodash'; +import yaml from 'yaml'; + +// Create a single-file OpenAPI spec from multiple files for OpenAPI validation and programmatic consumption +export default class OpenApiMerger { + root_path: string; + root_folder: string; + spec: Record; + + paths: Record> = {}; // namespace -> path -> path_item_object + schemas: Record> = {}; // category -> schema -> schema_object + + constructor(root_path: string) { + this.root_path = fs.realpathSync(root_path); + this.root_folder = this.root_path.split('/').slice(0, -1).join('/'); + this.spec = yaml.parse(fs.readFileSync(this.root_path, 'utf8')); + this.spec.components = { + parameters: {}, + requestBodies: {}, + responses: {}, + schemas: {}, + }; + } + + merge(output_path: string | null): OpenAPIV3.Document { + this.#merge_namespaces(); + this.#merge_schemas(); + this.#sort_spec_keys(); + + if(output_path) fs.writeFileSync(output_path, yaml.stringify(this.spec, {lineWidth: 0, singleQuote: true})) + return this.spec as OpenAPIV3.Document; + } + + // Merge files from /namespaces folder. + #merge_namespaces(): void { + const folder = `${this.root_folder}/namespaces`; + fs.readdirSync(folder).forEach(file => { + const spec = yaml.parse(fs.readFileSync(`${folder}/${file}`, 'utf8')); + const namespace = file.split('.yaml')[0]; + this.redirect_refs_in_namespace(spec); + this.paths[namespace] = spec['paths']; + this.spec.components.parameters = {...this.spec.components.parameters, ...spec['components']['parameters']}; + this.spec.components.responses = {...this.spec.components.responses, ...spec['components']['responses']}; + this.spec.components.requestBodies = {...this.spec.components.requestBodies, ...spec['components']['requestBodies']}; + }); + + Object.entries(this.spec.paths).forEach(([path, refObj]) => { + const ref = (refObj as Record).$ref!; + const namespace = ref.match(/namespaces\/(.*)\.yaml/)![1]; + this.spec.paths[path] = this.paths[namespace][path]; + }); + } + + // Redirect schema references in namespace files to local references in single-file spec. + redirect_refs_in_namespace(obj: Record): void { + const ref = obj.$ref; + if(ref?.startsWith('../schemas/')) + obj.$ref = ref.replace('../schemas/', '#/components/schemas/').replace('.yaml#/components/schemas/', ':'); + + for(const key in obj) + if(typeof obj[key] === 'object') + this.redirect_refs_in_namespace(obj[key]); + } + + // Merge files from /schemas folder. + #merge_schemas(): void { + const folder = `${this.root_folder}/schemas`; + fs.readdirSync(folder).forEach(file => { + const spec = yaml.parse(fs.readFileSync(`${folder}/${file}`, 'utf8')); + const category = file.split('.yaml')[0]; + this.redirect_refs_in_schema(category, spec); + this.schemas[category] = spec['components']['schemas'] as Record; + }); + + Object.entries(this.schemas).forEach(([category, schemas]) => { + Object.entries(schemas).forEach(([name, schemaObj]) => { + this.spec.components.schemas[`${category}:${name}`] = schemaObj; + }); + }); + } + + // Redirect schema references in schema files to local references in single-file spec. + redirect_refs_in_schema(category: string, obj: Record): void { + const ref = obj.$ref; + if(ref) + if(ref.startsWith('#/components/schemas')) + obj.$ref = `#/components/schemas/${category}:${ref.split('/').pop()}`; + else { + const other_category = ref.match(/(.*)\.yaml/)![1]; + obj.$ref = `#/components/schemas/${other_category}:${ref.split('/').pop()}`; + } + + for(const key in obj) + if(typeof obj[key] === 'object') + this.redirect_refs_in_schema(category, obj[key]); + } + + // Sort keys in the spec to make it easier to read and compare. + #sort_spec_keys(): void { + this.spec.components.schemas = _.fromPairs(Object.entries(this.spec.components.schemas).sort()); + this.spec.components.parameters = _.fromPairs(Object.entries(this.spec.components.parameters).sort()); + this.spec.components.responses = _.fromPairs(Object.entries(this.spec.components.responses).sort()); + this.spec.components.requestBodies = _.fromPairs(Object.entries(this.spec.components.requestBodies).sort()); + + this.spec.paths = _.fromPairs(Object.entries(this.spec.paths).sort()); + Object.entries(this.spec.paths).forEach(([path, pathItem]) => { + this.spec.paths[path] = _.fromPairs(Object.entries(pathItem!).sort()); + }); + } +} \ No newline at end of file diff --git a/tools/merger/merge.ts b/tools/merger/merge.ts new file mode 100644 index 00000000..a5e76d1e --- /dev/null +++ b/tools/merger/merge.ts @@ -0,0 +1,11 @@ +import OpenApiMerger from "./OpenApiMerger"; + + +async function main() { + const root_path: string = process.argv[2]; // '../spec/OpenSearch.openapi.yaml' + const output_path: string = process.argv[3]; // '../builds/OpenSearch.latest.yaml' + const merger = new OpenApiMerger(root_path); + merger.merge(output_path); +} + +main(); \ No newline at end of file diff --git a/tools/package-lock.json b/tools/package-lock.json new file mode 100644 index 00000000..e40a3b4a --- /dev/null +++ b/tools/package-lock.json @@ -0,0 +1,373 @@ +{ + "name": "opensearch_api_tools", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "opensearch_api_tools", + "version": "1.0.0", + "license": "Apache-2.0", + "dependencies": { + "@apidevtools/swagger-parser": "^10.1.0", + "@types/lodash": "^4.14.202", + "@types/node": "^20.10.3", + "lodash": "^4.17.21", + "ts-node": "^10.9.1", + "typescript": "^5.3.2", + "yaml": "^2.3.4" + } + }, + "node_modules/@apidevtools/json-schema-ref-parser": { + "version": "9.0.6", + "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-9.0.6.tgz", + "integrity": "sha512-M3YgsLjI0lZxvrpeGVk9Ap032W6TPQkH6pRAZz81Ac3WUNF79VQooAFnp8umjvVzUmD93NkogxEwbSce7qMsUg==", + "dependencies": { + "@jsdevtools/ono": "^7.1.3", + "call-me-maybe": "^1.0.1", + "js-yaml": "^3.13.1" + } + }, + "node_modules/@apidevtools/openapi-schemas": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@apidevtools/openapi-schemas/-/openapi-schemas-2.1.0.tgz", + "integrity": "sha512-Zc1AlqrJlX3SlpupFGpiLi2EbteyP7fXmUOGup6/DnkRgjP9bgMM/ag+n91rsv0U1Gpz0H3VILA/o3bW7Ua6BQ==", + "engines": { + "node": ">=10" + } + }, + "node_modules/@apidevtools/swagger-methods": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/@apidevtools/swagger-methods/-/swagger-methods-3.0.2.tgz", + "integrity": "sha512-QAkD5kK2b1WfjDS/UQn/qQkbwF31uqRjPTrsCs5ZG9BQGAkjwvqGFjjPqAuzac/IYzpPtRzjCP1WrTuAIjMrXg==" + }, + "node_modules/@apidevtools/swagger-parser": { + "version": "10.1.0", + "resolved": "https://registry.npmjs.org/@apidevtools/swagger-parser/-/swagger-parser-10.1.0.tgz", + "integrity": "sha512-9Kt7EuS/7WbMAUv2gSziqjvxwDbFSg3Xeyfuj5laUODX8o/k/CpsAKiQ8W7/R88eXFTMbJYg6+7uAmOWNKmwnw==", + "dependencies": { + "@apidevtools/json-schema-ref-parser": "9.0.6", + "@apidevtools/openapi-schemas": "^2.1.0", + "@apidevtools/swagger-methods": "^3.0.2", + "@jsdevtools/ono": "^7.1.3", + "ajv": "^8.6.3", + "ajv-draft-04": "^1.0.0", + "call-me-maybe": "^1.0.1" + }, + "peerDependencies": { + "openapi-types": ">=7" + } + }, + "node_modules/@cspotcode/source-map-support": { + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz", + "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==", + "dependencies": { + "@jridgewell/trace-mapping": "0.3.9" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.4.15", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.15.tgz", + "integrity": "sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg==" + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz", + "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==", + "dependencies": { + "@jridgewell/resolve-uri": "^3.0.3", + "@jridgewell/sourcemap-codec": "^1.4.10" + } + }, + "node_modules/@jsdevtools/ono": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz", + "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==" + }, + "node_modules/@tsconfig/node10": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.10.tgz", + "integrity": "sha512-PiaIWIoPvO6qm6t114ropMCagj6YAF24j9OkCA2mJDXFnlionEwhsBCJ8yek4aib575BI3OkART/90WsgHgLWw==" + }, + "node_modules/@tsconfig/node12": { + "version": "1.0.11", + "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz", + "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==" + }, + "node_modules/@tsconfig/node14": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz", + "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==" + }, + "node_modules/@tsconfig/node16": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.4.tgz", + "integrity": "sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==" + }, + "node_modules/@types/lodash": { + "version": "4.17.0", + "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.0.tgz", + "integrity": "sha512-t7dhREVv6dbNj0q17X12j7yDG4bD/DHYX7o5/DbDxobP0HnGPgpRz2Ej77aL7TZT3DSw13fqUTj8J4mMnqa7WA==" + }, + "node_modules/@types/node": { + "version": "20.11.30", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.11.30.tgz", + "integrity": "sha512-dHM6ZxwlmuZaRmUPfv1p+KrdD1Dci04FbdEm/9wEMouFqxYoFl5aMkt0VMAUtYRQDyYvD41WJLukhq/ha3YuTw==", + "dependencies": { + "undici-types": "~5.26.4" + } + }, + "node_modules/acorn": { + "version": "8.11.3", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.11.3.tgz", + "integrity": "sha512-Y9rRfJG5jcKOE0CLisYbojUjIrIEE7AGMzA/Sm4BslANhbS+cDMpgBdcPT91oJ7OuJ9hYJBx59RjbhxVnrF8Xg==", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-walk": { + "version": "8.3.2", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.2.tgz", + "integrity": "sha512-cjkyv4OtNCIeqhHrfS81QWXoCBPExR/J62oyEqepVw8WaQeSqpW2uhuLPh1m9eWhDuOo/jUXVTlifvesOWp/4A==", + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/ajv": { + "version": "8.12.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.12.0.tgz", + "integrity": "sha512-sRu1kpcO9yLtYxBKvqfTeh9KzZEwO3STyX1HT+4CaDzC6HpTGYhIhPIzj9XuKU7KYDwnaeh5hcOwjy1QuJzBPA==", + "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/ajv-draft-04": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/ajv-draft-04/-/ajv-draft-04-1.0.0.tgz", + "integrity": "sha512-mv00Te6nmYbRp5DCwclxtt7yV/joXJPGS7nM+97GdxvuttCOfgI3K4U25zboyeX0O+myI8ERluxQe5wljMmVIw==", + "peerDependencies": { + "ajv": "^8.5.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } + } + }, + "node_modules/arg": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", + "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==" + }, + "node_modules/argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/call-me-maybe": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.2.tgz", + "integrity": "sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ==" + }, + "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==" + }, + "node_modules/diff": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", + "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", + "engines": { + "node": ">=0.3.1" + } + }, + "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==", + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, + "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==" + }, + "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==", + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "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==" + }, + "node_modules/lodash": { + "version": "4.17.21", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==" + }, + "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==" + }, + "node_modules/openapi-types": { + "version": "12.1.3", + "resolved": "https://registry.npmjs.org/openapi-types/-/openapi-types-12.1.3.tgz", + "integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw==", + "peer": true + }, + "node_modules/punycode": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", + "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", + "engines": { + "node": ">=6" + } + }, + "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==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==" + }, + "node_modules/ts-node": { + "version": "10.9.2", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz", + "integrity": "sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==", + "dependencies": { + "@cspotcode/source-map-support": "^0.8.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", + "v8-compile-cache-lib": "^3.0.1", + "yn": "3.1.1" + }, + "bin": { + "ts-node": "dist/bin.js", + "ts-node-cwd": "dist/bin-cwd.js", + "ts-node-esm": "dist/bin-esm.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/typescript": { + "version": "5.4.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.3.tgz", + "integrity": "sha512-KrPd3PKaCLr78MalgiwJnA25Nm8HAmdwN3mYUYZgG/wizIo9EainNVQI9/yDavtVFRN2h3k8uf3GLHuhDMgEHg==", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/undici-types": { + "version": "5.26.5", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz", + "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==" + }, + "node_modules/uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dependencies": { + "punycode": "^2.1.0" + } + }, + "node_modules/v8-compile-cache-lib": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", + "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==" + }, + "node_modules/yaml": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.4.1.tgz", + "integrity": "sha512-pIXzoImaqmfOrL7teGUBt/T7ZDnyeGBWyXQBvOVhLkWLN37GXv8NMLK406UY6dS51JfcQHsmcW5cJ441bHg6Lg==", + "bin": { + "yaml": "bin.mjs" + }, + "engines": { + "node": ">= 14" + } + }, + "node_modules/yn": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz", + "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==", + "engines": { + "node": ">=6" + } + } + } +} diff --git a/tools/package.json b/tools/package.json new file mode 100644 index 00000000..656f9c17 --- /dev/null +++ b/tools/package.json @@ -0,0 +1,19 @@ +{ + "name": "opensearch_api_tools", + "version": "1.0.0", + "description": "Tools for OpenSearch API Repo", + "author": "opensearch-project", + "license": "Apache-2.0", + "scripts": { + "merge": "ts-node merger/merge.ts" + }, + "dependencies": { + "@apidevtools/swagger-parser": "^10.1.0", + "@types/lodash": "^4.14.202", + "@types/node": "^20.10.3", + "lodash": "^4.17.21", + "ts-node": "^10.9.1", + "typescript": "^5.3.2", + "yaml": "^2.3.4" + } +} diff --git a/tools/tsconfig.json b/tools/tsconfig.json new file mode 100644 index 00000000..bc659277 --- /dev/null +++ b/tools/tsconfig.json @@ -0,0 +1,109 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2022", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "commonjs", /* Specify what module code is generated. */ + // "rootDir": "./", /* Specify the root folder within your source files. */ + // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + // "outDir": "./", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +}