Update the schema for the REST API specification (#42346)
* Update the REST API specification This patch updates the REST API spefication in JSON files to better encode deprecated entities, to improve specification of URL paths, and to open up the schema for future extensions. Notably, it changes the `paths` from a list of strings to a list of objects, where each particular object encodes all the information for this particular path: the `parts` and the `methods`. Among the benefits of this approach is eg. encoding the difference between using the `PUT` and `POST` methods in the Index API, to either use a specific document ID, or let Elasticsearch generate one. Also `documentation` becomes an object that supports an `url` and also a `description` which is a new field. * Adapt YAML runner to new REST API specification format The logic for choosing the path to use when running tests has been simplified, as a consequence of the path parts being listed under each path in the spec. The special case for create and index has been removed. Also the parsing code has been hardened so that errors are thrown earlier when the structure of the spec differs from what expected, and their error messages should be more helpful.
This commit is contained in:
Karel Minarik
Luca Cavanna
parent
ec49a32d5a
commit
9166311622
|
|
@ -1,10 +1,14 @@
|
|||
{
|
||||
"scripts_painless_context": {
|
||||
"stability": "experimental",
|
||||
"methods": ["GET"],
|
||||
"url": {
|
||||
"paths": ["/_scripts/painless/_context"],
|
||||
"parts": {
|
||||
"paths": [
|
||||
{
|
||||
"path": "/_scripts/painless/_context",
|
||||
"methods": ["GET"],
|
||||
"parts": {}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params": {
|
||||
"context" : {
|
||||
|
|
@ -14,4 +18,3 @@
|
|||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,11 +1,18 @@
|
|||
{
|
||||
"cat.example": {
|
||||
"documentation": "",
|
||||
"documentation": {
|
||||
"url": "https://www.elastic.co/guide/en/elasticsearch/plugins/current/plugin-authors.html",
|
||||
"description": "Example"
|
||||
},
|
||||
"stability" : "stable",
|
||||
"methods": ["GET"],
|
||||
"url": {
|
||||
"paths": ["/_cat/example"],
|
||||
"parts": {},
|
||||
"paths": [
|
||||
{
|
||||
"path" : "/_cat/example",
|
||||
"methods" : ["GET"]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params": {
|
||||
"help": {
|
||||
"type": "boolean",
|
||||
|
|
@ -22,7 +29,6 @@
|
|||
"description": "A simple message that will be printed out in the response",
|
||||
"default": "Hello from Cat Example action"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
|
|
|
|||
|
|
@ -9,24 +9,29 @@ Example for the ["Create Index"](http://www.elastic.co/guide/en/elasticsearch/re
|
|||
```json
|
||||
{
|
||||
"indices.create": {
|
||||
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html",
|
||||
"documentation":{
|
||||
"url":"http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html"
|
||||
},
|
||||
"stability": "stable",
|
||||
"methods": ["PUT", "POST"],
|
||||
"url":{
|
||||
"paths": ["/{index}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/{index}",
|
||||
"method":"PUT",
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the index"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params": {
|
||||
"timeout": {
|
||||
"type" : "time",
|
||||
"description" : "Explicit operation timeout"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": {
|
||||
"description" : "The configuration for the index (`settings` and `mappings`)"
|
||||
|
|
@ -38,15 +43,15 @@ Example for the ["Create Index"](http://www.elastic.co/guide/en/elasticsearch/re
|
|||
The specification contains:
|
||||
|
||||
* The _name_ of the API (`indices.create`), which usually corresponds to the client calls
|
||||
* Link to the documentation at <http://elastic.co>
|
||||
* Link to the documentation at the <http://elastic.co> website
|
||||
* `stability` indicating the state of the API, has to be declared explicitly or YAML tests will fail
|
||||
* `experimental` highly likely to break in the near future (minor/path), no bwc guarantees.
|
||||
Possibly removed in the future.
|
||||
* `beta` less likely to break or be removed but still reserve the right to do so
|
||||
* `stable` No backwards breaking changes in a minor
|
||||
* List of HTTP methods for the endpoint
|
||||
* URL specification: path, parts, parameters
|
||||
* Whether body is allowed for the endpoint or not and its description
|
||||
* Request URL: HTTP method, path and parts
|
||||
* Request parameters
|
||||
* Request body specification
|
||||
|
||||
**NOTE**
|
||||
If an API is stable but it response should be treated as an arbitrary map of key values please notate this as followed
|
||||
|
|
@ -62,10 +67,6 @@ If an API is stable but it response should be treated as an arbitrary map of key
|
|||
}
|
||||
```
|
||||
|
||||
|
||||
The `methods` and `url.paths` elements list all possible HTTP methods and URLs for the endpoint;
|
||||
it is the responsibility of the developer to use this information for a sensible API on the target platform.
|
||||
|
||||
## Backwards compatibility
|
||||
|
||||
The specification follows the same backward compatibility guarantees as Elasticsearch.
|
||||
|
|
@ -76,14 +77,13 @@ The specification follows the same backward compatibility guarantees as Elastics
|
|||
|
||||
## Deprecations
|
||||
|
||||
The spec allows for deprecations of:
|
||||
The specification schema allows to codify API deprecations, either for an entire API, or for specific parts of the API, such as paths or parameters.
|
||||
|
||||
#### Entire API:
|
||||
|
||||
```json
|
||||
{
|
||||
"api" : {
|
||||
"documentation": "...",
|
||||
"deprecated" : {
|
||||
"version" : "7.0.0",
|
||||
"description" : "Reason API is being deprecated"
|
||||
|
|
@ -92,36 +92,47 @@ The spec allows for deprecations of:
|
|||
}
|
||||
```
|
||||
|
||||
#### Specific paths:
|
||||
#### Specific paths and their parts:
|
||||
|
||||
```json
|
||||
{
|
||||
"api": {
|
||||
"documentation": "",
|
||||
"url": {
|
||||
"paths": ["/_monitoring/bulk"],
|
||||
"deprecated_paths" : [
|
||||
"paths": [
|
||||
{
|
||||
"path":"/{index}/{type}/{id}/_create",
|
||||
"method":"PUT",
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"description":"Document ID"
|
||||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"description":"The name of the index"
|
||||
},
|
||||
"type":{
|
||||
"type":"string",
|
||||
"description":"The type of the document",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"path" : "/_monitoring/{type}/bulk",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Here `paths` describes the preferred paths and `deprecated_paths` indicates `paths` that will still work but are now
|
||||
deprecated.
|
||||
|
||||
#### Parameters
|
||||
|
||||
```json
|
||||
{
|
||||
"api": {
|
||||
"documentation": "",
|
||||
"methods": ["GET"],
|
||||
"url": {
|
||||
"params": {
|
||||
"stored_fields": {
|
||||
|
|
|
|||
|
|
@ -1,10 +1,38 @@
|
|||
{
|
||||
"bulk":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html",
|
||||
"description":"Allows to perform multiple index/update/delete operations in a single request."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["POST", "PUT"],
|
||||
"url":{
|
||||
"paths": ["/_bulk", "/{index}/_bulk", "/{index}/{type}/_bulk"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_bulk",
|
||||
"methods":[
|
||||
"POST",
|
||||
"PUT"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_bulk",
|
||||
"methods":[
|
||||
"POST",
|
||||
"PUT"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"string",
|
||||
"description":"Default index for items which don't provide one"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/{type}/_bulk",
|
||||
"methods":[
|
||||
"POST",
|
||||
"PUT"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"string",
|
||||
|
|
@ -14,6 +42,9 @@
|
|||
"type":"string",
|
||||
"description":"Default document type for items which don't provide one"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"wait_for_active_shards":{
|
||||
|
|
@ -22,7 +53,11 @@
|
|||
},
|
||||
"refresh":{
|
||||
"type":"enum",
|
||||
"options": ["true", "false", "wait_for"],
|
||||
"options":[
|
||||
"true",
|
||||
"false",
|
||||
"wait_for"
|
||||
],
|
||||
"description":"If `true` then refresh the effected 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."
|
||||
},
|
||||
"routing":{
|
||||
|
|
@ -53,7 +88,6 @@
|
|||
"type":"string",
|
||||
"description":"The pipeline id to preprocess incoming documents with"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The operation definition and data (action-data pairs), separated by newlines",
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"cat.aliases":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-alias.html",
|
||||
"description":"Shows information about currently configured aliases to indices including filter and routing infos."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/aliases", "/_cat/aliases/{name}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/aliases",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_cat/aliases/{name}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"name":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of alias names to return"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -43,7 +59,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"cat.allocation":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html",
|
||||
"description":"Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/allocation", "/_cat/allocation/{node_id}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/allocation",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_cat/allocation/{node_id}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"node_id":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of node IDs or names to limit the returned information"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -19,7 +35,19 @@
|
|||
"bytes":{
|
||||
"type":"enum",
|
||||
"description":"The unit in which to display byte values",
|
||||
"options": [ "b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb" ]
|
||||
"options":[
|
||||
"b",
|
||||
"k",
|
||||
"kb",
|
||||
"m",
|
||||
"mb",
|
||||
"g",
|
||||
"gb",
|
||||
"t",
|
||||
"tb",
|
||||
"p",
|
||||
"pb"
|
||||
]
|
||||
},
|
||||
"local":{
|
||||
"type":"boolean",
|
||||
|
|
@ -48,7 +76,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"cat.count":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html",
|
||||
"description":"Provides quick access to the document count of the entire cluster, or individual indices."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/count", "/_cat/count/{index}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/count",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_cat/count/{index}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names to limit the returned information"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -43,7 +59,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"cat.fielddata":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html",
|
||||
"description":"Shows how much heap memory is currently being used by fielddata on every data node in the cluster."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/fielddata", "/_cat/fielddata/{fields}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/fielddata",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_cat/fielddata/{fields}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"fields":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of fields to return the fielddata size"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -19,7 +35,19 @@
|
|||
"bytes":{
|
||||
"type":"enum",
|
||||
"description":"The unit in which to display byte values",
|
||||
"options": [ "b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb" ]
|
||||
"options":[
|
||||
"b",
|
||||
"k",
|
||||
"kb",
|
||||
"m",
|
||||
"mb",
|
||||
"g",
|
||||
"gb",
|
||||
"t",
|
||||
"tb",
|
||||
"p",
|
||||
"pb"
|
||||
]
|
||||
},
|
||||
"local":{
|
||||
"type":"boolean",
|
||||
|
|
@ -52,7 +80,5 @@
|
|||
"description":"A comma-separated list of fields to return in the output"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,11 +1,19 @@
|
|||
{
|
||||
"cat.health":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.html",
|
||||
"description":"Returns a concise representation of the cluster health."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/health"],
|
||||
"parts": {
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/health",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -44,7 +52,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,11 +1,19 @@
|
|||
{
|
||||
"cat.help":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html",
|
||||
"description":"Returns help for the Cat APIs."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat"],
|
||||
"parts": {
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"help":{
|
||||
|
|
@ -18,7 +26,5 @@
|
|||
"description":"Comma-separated list of column names or column aliases to sort by"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"cat.indices":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html",
|
||||
"description":"Returns information about indices: number of primaries and replicas, document counts, disk size, ..."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/indices", "/_cat/indices/{index}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/indices",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_cat/indices/{index}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names to limit the returned information"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -19,7 +35,12 @@
|
|||
"bytes":{
|
||||
"type":"enum",
|
||||
"description":"The unit in which to display byte values",
|
||||
"options": [ "b", "k", "m", "g" ]
|
||||
"options":[
|
||||
"b",
|
||||
"k",
|
||||
"m",
|
||||
"g"
|
||||
]
|
||||
},
|
||||
"local":{
|
||||
"type":"boolean",
|
||||
|
|
@ -35,7 +56,11 @@
|
|||
},
|
||||
"health":{
|
||||
"type":"enum",
|
||||
"options" : ["green","yellow","red"],
|
||||
"options":[
|
||||
"green",
|
||||
"yellow",
|
||||
"red"
|
||||
],
|
||||
"default":null,
|
||||
"description":"A health status (\"green\", \"yellow\", or \"red\" to filter only indices matching the specified health status"
|
||||
},
|
||||
|
|
@ -64,7 +89,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,11 +1,19 @@
|
|||
{
|
||||
"cat.master":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.html",
|
||||
"description":"Returns information about the master node."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/master"],
|
||||
"parts": {
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/master",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -39,7 +47,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,11 +1,19 @@
|
|||
{
|
||||
"cat.nodeattrs":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html",
|
||||
"description":"Returns information about custom node attributes."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/nodeattrs"],
|
||||
"parts": {
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/nodeattrs",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -39,7 +47,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,11 +1,19 @@
|
|||
{
|
||||
"cat.nodes":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.html",
|
||||
"description":"Returns basic statistics about performance of cluster nodes."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/nodes"],
|
||||
"parts": {
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/nodes",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -43,7 +51,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,11 +1,19 @@
|
|||
{
|
||||
"cat.pending_tasks":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.html",
|
||||
"description":"Returns a concise representation of the cluster pending tasks."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/pending_tasks"],
|
||||
"parts": {
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/pending_tasks",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -39,7 +47,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,10 +1,20 @@
|
|||
{
|
||||
"cat.plugins":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.html",
|
||||
"description":"Returns information about installed plugins across nodes node."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/plugins"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/plugins",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
"type":"string",
|
||||
|
|
@ -37,7 +47,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"cat.recovery":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html",
|
||||
"description":"Returns information about index shard recoveries, both on-going completed."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/recovery", "/_cat/recovery/{index}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/recovery",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_cat/recovery/{index}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names to limit the returned information"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -19,7 +35,19 @@
|
|||
"bytes":{
|
||||
"type":"enum",
|
||||
"description":"The unit in which to display byte values",
|
||||
"options": [ "b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb" ]
|
||||
"options":[
|
||||
"b",
|
||||
"k",
|
||||
"kb",
|
||||
"m",
|
||||
"mb",
|
||||
"g",
|
||||
"gb",
|
||||
"t",
|
||||
"tb",
|
||||
"p",
|
||||
"pb"
|
||||
]
|
||||
},
|
||||
"master_timeout":{
|
||||
"type":"time",
|
||||
|
|
@ -44,7 +72,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,11 +1,19 @@
|
|||
{
|
||||
"cat.repositories":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-repositories.html",
|
||||
"description":"Returns information about snapshot repositories registered in the cluster."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/repositories"],
|
||||
"parts": {
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/repositories",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -40,7 +48,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"cat.segments":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-segments.html",
|
||||
"description":"Provides low-level information about the segments in the shards of an index."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/segments", "/_cat/segments/{index}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/segments",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_cat/segments/{index}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names to limit the returned information"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -19,7 +35,19 @@
|
|||
"bytes":{
|
||||
"type":"enum",
|
||||
"description":"The unit in which to display byte values",
|
||||
"options": [ "b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb" ]
|
||||
"options":[
|
||||
"b",
|
||||
"k",
|
||||
"kb",
|
||||
"m",
|
||||
"mb",
|
||||
"g",
|
||||
"gb",
|
||||
"t",
|
||||
"tb",
|
||||
"p",
|
||||
"pb"
|
||||
]
|
||||
},
|
||||
"h":{
|
||||
"type":"list",
|
||||
|
|
@ -40,7 +68,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"cat.shards":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.html",
|
||||
"description":"Provides a detailed view of shard allocation on nodes."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/shards", "/_cat/shards/{index}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/shards",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_cat/shards/{index}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names to limit the returned information"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -19,7 +35,19 @@
|
|||
"bytes":{
|
||||
"type":"enum",
|
||||
"description":"The unit in which to display byte values",
|
||||
"options": [ "b", "k", "kb", "m", "mb", "g", "gb", "t", "tb", "p", "pb" ]
|
||||
"options":[
|
||||
"b",
|
||||
"k",
|
||||
"kb",
|
||||
"m",
|
||||
"mb",
|
||||
"g",
|
||||
"gb",
|
||||
"t",
|
||||
"tb",
|
||||
"p",
|
||||
"pb"
|
||||
]
|
||||
},
|
||||
"local":{
|
||||
"type":"boolean",
|
||||
|
|
@ -48,7 +76,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,17 +1,31 @@
|
|||
{
|
||||
"cat.snapshots":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-snapshots.html",
|
||||
"description":"Returns all snapshots in a specific repository."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths":[
|
||||
"/_cat/snapshots",
|
||||
"/_cat/snapshots/{repository}"],
|
||||
{
|
||||
"path":"/_cat/snapshots",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_cat/snapshots/{repository}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"repository":{
|
||||
"type":"list",
|
||||
"description":"Name of repository from which to fetch the snapshot information"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -46,7 +60,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,11 +1,19 @@
|
|||
{
|
||||
"cat.tasks":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html",
|
||||
"description":"Returns information about the tasks currently executing on one or more nodes in the cluster."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/tasks"],
|
||||
"parts": {
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/tasks",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -47,7 +55,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"cat.templates":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-templates.html",
|
||||
"description":"Returns information about existing templates."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/templates", "/_cat/templates/{name}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/templates",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_cat/templates/{name}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"name":{
|
||||
"type":"string",
|
||||
"description":"A pattern that returned template names must match"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -43,7 +59,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"cat.thread_pool":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.html",
|
||||
"description":"Returns cluster-wide thread pool statistics per node.\nBy default the active, queue and rejected statistics are returned for all thread pools."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cat/thread_pool","/_cat/thread_pool/{thread_pool_patterns}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cat/thread_pool",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_cat/thread_pool/{thread_pool_patterns}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"thread_pool_patterns":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of regular-expressions to filter the thread pools in the output"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"format":{
|
||||
|
|
@ -19,7 +35,14 @@
|
|||
"size":{
|
||||
"type":"enum",
|
||||
"description":"The multiplier in which to display values",
|
||||
"options": [ "", "k", "m", "g", "t", "p" ]
|
||||
"options":[
|
||||
"",
|
||||
"k",
|
||||
"m",
|
||||
"g",
|
||||
"t",
|
||||
"p"
|
||||
]
|
||||
},
|
||||
"local":{
|
||||
"type":"boolean",
|
||||
|
|
@ -48,7 +71,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,25 +1,38 @@
|
|||
{
|
||||
"clear_scroll":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#_clear_scroll_api",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll",
|
||||
"description":"Explicitly clears the search context for a scroll."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["DELETE"],
|
||||
"url":{
|
||||
"paths": [ "/_search/scroll"],
|
||||
"deprecated_paths" : [
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_search/scroll",
|
||||
"methods":[
|
||||
"DELETE"
|
||||
]
|
||||
},
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path":"/_search/scroll/{scroll_id}",
|
||||
"description" : "A scroll id can be quite large and should be specified as part of the body"
|
||||
}
|
||||
"methods":[
|
||||
"DELETE"
|
||||
],
|
||||
"parts":{
|
||||
"scroll_id":{
|
||||
"type":"list",
|
||||
"description" : "A comma-separated list of scroll IDs to clear"
|
||||
"description":"A comma-separated list of scroll IDs to clear",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"params": {}
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"A scroll id can be quite large and should be specified as part of the body"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{},
|
||||
"body":{
|
||||
"description":"A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,11 +1,21 @@
|
|||
{
|
||||
"cluster.allocation_explain":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-allocation-explain.html",
|
||||
"description":"Provides explanations for shard allocations in the cluster."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET", "POST"],
|
||||
"url":{
|
||||
"paths": ["/_cluster/allocation/explain"],
|
||||
"parts": {},
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cluster/allocation/explain",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"include_yes_decisions":{
|
||||
"type":"boolean",
|
||||
|
|
@ -15,7 +25,6 @@
|
|||
"type":"boolean",
|
||||
"description":"Return information about disk usage and shard sizes (default: false)"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'"
|
||||
|
|
|
|||
|
|
@ -1,11 +1,20 @@
|
|||
{
|
||||
"cluster.get_settings":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html",
|
||||
"description":"Returns cluster settings."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cluster/settings"],
|
||||
"parts": {},
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cluster/settings",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"flat_settings":{
|
||||
"type":"boolean",
|
||||
|
|
@ -25,7 +34,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,26 +1,51 @@
|
|||
{
|
||||
"cluster.health":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html",
|
||||
"description":"Returns basic information about the health of the cluster."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cluster/health", "/_cluster/health/{index}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cluster/health",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_cluster/health/{index}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"Limit the information returned to a specific index"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"all",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
"level":{
|
||||
"type":"enum",
|
||||
"options" : ["cluster","indices","shards"],
|
||||
"options":[
|
||||
"cluster",
|
||||
"indices",
|
||||
"shards"
|
||||
],
|
||||
"default":"cluster",
|
||||
"description":"Specify the level of detail for returned information"
|
||||
},
|
||||
|
|
@ -46,7 +71,14 @@
|
|||
},
|
||||
"wait_for_events":{
|
||||
"type":"enum",
|
||||
"options" : ["immediate", "urgent", "high", "normal", "low", "languid"],
|
||||
"options":[
|
||||
"immediate",
|
||||
"urgent",
|
||||
"high",
|
||||
"normal",
|
||||
"low",
|
||||
"languid"
|
||||
],
|
||||
"description":"Wait until all currently queued events with the given priority are processed"
|
||||
},
|
||||
"wait_for_no_relocating_shards":{
|
||||
|
|
@ -59,12 +91,14 @@
|
|||
},
|
||||
"wait_for_status":{
|
||||
"type":"enum",
|
||||
"options" : ["green","yellow","red"],
|
||||
"options":[
|
||||
"green",
|
||||
"yellow",
|
||||
"red"
|
||||
],
|
||||
"default":null,
|
||||
"description":"Wait until cluster is in a specific state"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,11 +1,19 @@
|
|||
{
|
||||
"cluster.pending_tasks":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html",
|
||||
"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."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cluster/pending_tasks"],
|
||||
"parts": {
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cluster/pending_tasks",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"local":{
|
||||
|
|
@ -17,7 +25,5 @@
|
|||
"description":"Specify timeout for connection to master"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,11 +1,20 @@
|
|||
{
|
||||
"cluster.put_settings":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html",
|
||||
"description":"Updates the cluster settings."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["PUT"],
|
||||
"url":{
|
||||
"paths": ["/_cluster/settings"],
|
||||
"parts": {},
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cluster/settings",
|
||||
"methods":[
|
||||
"PUT"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"flat_settings":{
|
||||
"type":"boolean",
|
||||
|
|
@ -19,7 +28,6 @@
|
|||
"type":"time",
|
||||
"description":"Explicit operation timeout"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart).",
|
||||
|
|
|
|||
|
|
@ -1,12 +1,20 @@
|
|||
{
|
||||
"cluster.remote_info":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html",
|
||||
"stability": "stable",
|
||||
"methods": ["GET"],
|
||||
"url": {
|
||||
"paths": ["/_remote/info"],
|
||||
"params": {}
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-remote-info.html",
|
||||
"description":"Returns the information about configured remote clusters."
|
||||
},
|
||||
"body": null
|
||||
"stability":"stable",
|
||||
"url":{
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_remote/info",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,11 +1,19 @@
|
|||
{
|
||||
"cluster.reroute":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html",
|
||||
"description":"Allows to manually change the allocation of individual shards in the cluster."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["POST"],
|
||||
"url":{
|
||||
"paths": ["/_cluster/reroute"],
|
||||
"parts": {
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cluster/reroute",
|
||||
"methods":[
|
||||
"POST"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"dry_run":{
|
||||
|
|
@ -22,7 +30,15 @@
|
|||
},
|
||||
"metric":{
|
||||
"type":"list",
|
||||
"options": ["_all", "blocks", "metadata", "nodes", "routing_table", "master_node", "version"],
|
||||
"options":[
|
||||
"_all",
|
||||
"blocks",
|
||||
"metadata",
|
||||
"nodes",
|
||||
"routing_table",
|
||||
"master_node",
|
||||
"version"
|
||||
],
|
||||
"description":"Limit the information returned to the specified metrics. Defaults to all but metadata"
|
||||
},
|
||||
"master_timeout":{
|
||||
|
|
@ -33,7 +49,6 @@
|
|||
"type":"time",
|
||||
"description":"Explicit operation timeout"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The definition of `commands` to perform (`move`, `cancel`, `allocate`)"
|
||||
|
|
|
|||
|
|
@ -1,13 +1,44 @@
|
|||
{
|
||||
"cluster.state":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html",
|
||||
"description":"Returns a comprehensive information about the state of the cluster."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths":[
|
||||
"/_cluster/state",
|
||||
"/_cluster/state/{metric}",
|
||||
"/_cluster/state/{metric}/{index}"
|
||||
{
|
||||
"path":"/_cluster/state",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_cluster/state/{metric}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"metric":{
|
||||
"type":"list",
|
||||
"options":[
|
||||
"_all",
|
||||
"blocks",
|
||||
"metadata",
|
||||
"nodes",
|
||||
"routing_table",
|
||||
"routing_nodes",
|
||||
"master_node",
|
||||
"version"
|
||||
],
|
||||
"description":"Limit the information returned to the specified metrics"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_cluster/state/{metric}/{index}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
|
|
@ -16,9 +47,21 @@
|
|||
},
|
||||
"metric":{
|
||||
"type":"list",
|
||||
"options" : ["_all", "blocks", "metadata", "nodes", "routing_table", "routing_nodes", "master_node", "version"],
|
||||
"options":[
|
||||
"_all",
|
||||
"blocks",
|
||||
"metadata",
|
||||
"nodes",
|
||||
"routing_table",
|
||||
"routing_nodes",
|
||||
"master_node",
|
||||
"version"
|
||||
],
|
||||
"description":"Limit the information returned to the specified metrics"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"local":{
|
||||
|
|
@ -51,15 +94,15 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null,
|
||||
"response": {
|
||||
"treat_json_as_key_value" : true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"cluster.stats":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html",
|
||||
"description":"Returns high-level overview of cluster statistics."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_cluster/stats", "/_cluster/stats/nodes/{node_id}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cluster/stats",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_cluster/stats/nodes/{node_id}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"node_id":{
|
||||
"type":"list",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"flat_settings":{
|
||||
|
|
@ -21,7 +37,5 @@
|
|||
"description":"Explicit operation timeout"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,19 +1,33 @@
|
|||
{
|
||||
"count":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html",
|
||||
"description":"Returns number of documents matching a query."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["POST", "GET"],
|
||||
"url":{
|
||||
"paths": ["/_count", "/{index}/_count"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_count",
|
||||
"methods":[
|
||||
"POST",
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_count",
|
||||
"methods":[
|
||||
"POST",
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of indices to restrict the results"
|
||||
},
|
||||
"type": {
|
||||
"type" : "list",
|
||||
"description" : "A comma-separated list of types to restrict the results"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"ignore_unavailable":{
|
||||
|
|
@ -30,7 +44,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -60,7 +79,10 @@
|
|||
},
|
||||
"default_operator":{
|
||||
"type":"enum",
|
||||
"options" : ["AND","OR"],
|
||||
"options":[
|
||||
"AND",
|
||||
"OR"
|
||||
],
|
||||
"default":"OR",
|
||||
"description":"The default operator for query string query (AND or OR)"
|
||||
},
|
||||
|
|
@ -76,7 +98,6 @@
|
|||
"type":"number",
|
||||
"description":"The maximum count for each shard, upon reaching which the query execution will terminate early"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"A query to restrict the results specified with the Query DSL (optional)"
|
||||
|
|
|
|||
|
|
@ -1,33 +1,57 @@
|
|||
{
|
||||
"create":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html",
|
||||
"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."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["PUT","POST"],
|
||||
"url":{
|
||||
"paths": ["/{index}/_create/{id}"],
|
||||
"deprecated_paths" : [
|
||||
"paths":[
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/{index}/{type}/{id}/_create",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
}
|
||||
"path":"/{index}/_create/{id}",
|
||||
"methods":[
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"description":"Document ID"
|
||||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"description":"The name of the index"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/{type}/{id}/_create",
|
||||
"methods":[
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"Document ID"
|
||||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the index"
|
||||
},
|
||||
"type":{
|
||||
"type":"string",
|
||||
"description" : "The type of the document"
|
||||
"description":"The type of the document",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"wait_for_active_shards":{
|
||||
"type":"string",
|
||||
|
|
@ -35,7 +59,11 @@
|
|||
},
|
||||
"refresh":{
|
||||
"type":"enum",
|
||||
"options": ["true", "false", "wait_for"],
|
||||
"options":[
|
||||
"true",
|
||||
"false",
|
||||
"wait_for"
|
||||
],
|
||||
"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."
|
||||
},
|
||||
"routing":{
|
||||
|
|
@ -52,14 +80,18 @@
|
|||
},
|
||||
"version_type":{
|
||||
"type":"enum",
|
||||
"options" : ["internal", "external", "external_gte", "force"],
|
||||
"options":[
|
||||
"internal",
|
||||
"external",
|
||||
"external_gte",
|
||||
"force"
|
||||
],
|
||||
"description":"Specific version type"
|
||||
},
|
||||
"pipeline":{
|
||||
"type":"string",
|
||||
"description":"The pipeline id to preprocess incoming documents with"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The document",
|
||||
|
|
|
|||
|
|
@ -1,33 +1,55 @@
|
|||
{
|
||||
"delete":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html",
|
||||
"description":"Removes a document from the index."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["DELETE"],
|
||||
"url":{
|
||||
"paths": ["/{index}/_doc/{id}"],
|
||||
"deprecated_paths" : [
|
||||
"paths":[
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/{index}/{type}/{id}",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
}
|
||||
"path":"/{index}/_doc/{id}",
|
||||
"methods":[
|
||||
"DELETE"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"description":"The document ID"
|
||||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"description":"The name of the index"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/{type}/{id}",
|
||||
"methods":[
|
||||
"DELETE"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The document ID"
|
||||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the index"
|
||||
},
|
||||
"type":{
|
||||
"type":"string",
|
||||
"description" : "The type of the document"
|
||||
"description":"The type of the document",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"wait_for_active_shards":{
|
||||
"type":"string",
|
||||
|
|
@ -35,7 +57,11 @@
|
|||
},
|
||||
"refresh":{
|
||||
"type":"enum",
|
||||
"options": ["true", "false", "wait_for"],
|
||||
"options":[
|
||||
"true",
|
||||
"false",
|
||||
"wait_for"
|
||||
],
|
||||
"description":"If `true` then refresh the effected 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."
|
||||
},
|
||||
"routing":{
|
||||
|
|
@ -60,11 +86,14 @@
|
|||
},
|
||||
"version_type":{
|
||||
"type":"enum",
|
||||
"options" : ["internal", "external", "external_gte", "force"],
|
||||
"options":[
|
||||
"internal",
|
||||
"external",
|
||||
"external_gte",
|
||||
"force"
|
||||
],
|
||||
"description":"Specific version type"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,17 +1,25 @@
|
|||
{
|
||||
"delete_by_query":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html",
|
||||
"description":"Deletes documents matching the provided query."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["POST"],
|
||||
"url":{
|
||||
"paths": ["/{index}/_delete_by_query"],
|
||||
"comment": "most things below this are just copied from search.json",
|
||||
"paths":[
|
||||
{
|
||||
"path":"/{index}/_delete_by_query",
|
||||
"methods":[
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"required" : true,
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"analyzer":{
|
||||
|
|
@ -24,7 +32,10 @@
|
|||
},
|
||||
"default_operator":{
|
||||
"type":"enum",
|
||||
"options" : ["AND","OR"],
|
||||
"options":[
|
||||
"AND",
|
||||
"OR"
|
||||
],
|
||||
"default":"OR",
|
||||
"description":"The default operator for query string query (AND or OR)"
|
||||
},
|
||||
|
|
@ -47,13 +58,21 @@
|
|||
"conflicts":{
|
||||
"note":"This is not copied from search",
|
||||
"type":"enum",
|
||||
"options": ["abort", "proceed"],
|
||||
"options":[
|
||||
"abort",
|
||||
"proceed"
|
||||
],
|
||||
"default":"abort",
|
||||
"description":"What to do when the delete by query hits version conflicts?"
|
||||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -79,7 +98,10 @@
|
|||
},
|
||||
"search_type":{
|
||||
"type":"enum",
|
||||
"options" : ["query_then_fetch", "dfs_query_then_fetch"],
|
||||
"options":[
|
||||
"query_then_fetch",
|
||||
"dfs_query_then_fetch"
|
||||
],
|
||||
"description":"Search operation type"
|
||||
},
|
||||
"search_timeout":{
|
||||
|
|
@ -155,7 +177,6 @@
|
|||
"default":1,
|
||||
"description":"The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks."
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The search definition using the Query DSL",
|
||||
|
|
|
|||
|
|
@ -1,16 +1,25 @@
|
|||
{
|
||||
"delete_by_query_rethrottle":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html",
|
||||
"description":"Changes the number of requests per second for a particular Delete By Query operation."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["POST"],
|
||||
"url":{
|
||||
"paths": ["/_delete_by_query/{task_id}/_rethrottle"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_delete_by_query/{task_id}/_rethrottle",
|
||||
"methods":[
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"task_id":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The task id to rethrottle"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"requests_per_second":{
|
||||
|
|
@ -19,7 +28,5 @@
|
|||
"description":"The throttle to set on this request in floating sub-requests per second. -1 means set no throttle."
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,16 +1,25 @@
|
|||
{
|
||||
"delete_script":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html",
|
||||
"description":"Deletes a script."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["DELETE"],
|
||||
"url":{
|
||||
"paths": [ "/_scripts/{id}" ],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_scripts/{id}",
|
||||
"methods":[
|
||||
"DELETE"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"description" : "Script ID",
|
||||
"required" : true
|
||||
"description":"Script ID"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"timeout":{
|
||||
|
|
@ -22,7 +31,5 @@
|
|||
"description":"Specify timeout for connection to master"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,33 +1,55 @@
|
|||
{
|
||||
"exists":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html",
|
||||
"description":"Returns information about whether a document exists in an index."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["HEAD"],
|
||||
"url":{
|
||||
"paths": ["/{index}/_doc/{id}"],
|
||||
"deprecated_paths" : [
|
||||
"paths":[
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/{index}/{type}/{id}",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
}
|
||||
"path":"/{index}/_doc/{id}",
|
||||
"methods":[
|
||||
"HEAD"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"description":"The document ID"
|
||||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"description":"The name of the index"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/{type}/{id}",
|
||||
"methods":[
|
||||
"HEAD"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The document ID"
|
||||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the index"
|
||||
},
|
||||
"type":{
|
||||
"type":"string",
|
||||
"description" : "The type of the document (use `_all` to fetch the first document matching the ID across all types)"
|
||||
"description":"The type of the document (use `_all` to fetch the first document matching the ID across all types)",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"stored_fields":{
|
||||
"type":"list",
|
||||
|
|
@ -67,11 +89,14 @@
|
|||
},
|
||||
"version_type":{
|
||||
"type":"enum",
|
||||
"options" : ["internal", "external", "external_gte", "force"],
|
||||
"options":[
|
||||
"internal",
|
||||
"external",
|
||||
"external_gte",
|
||||
"force"
|
||||
],
|
||||
"description":"Specific version type"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,34 +1,56 @@
|
|||
{
|
||||
"exists_source":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html",
|
||||
"description":"Returns information about whether a document source exists in an index."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["HEAD"],
|
||||
"url":{
|
||||
"paths": ["/{index}/_source/{id}"],
|
||||
"deprecated_paths" : [
|
||||
"paths":[
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/{index}/{type}/{id}/_source",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
}
|
||||
"path":"/{index}/_source/{id}",
|
||||
"methods":[
|
||||
"HEAD"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"description":"The document ID"
|
||||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"description":"The name of the index"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/{type}/{id}/_source",
|
||||
"methods":[
|
||||
"HEAD"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The document ID"
|
||||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the index"
|
||||
},
|
||||
"type":{
|
||||
"type":"string",
|
||||
"required":false,
|
||||
"description" : "The type of the document; deprecated and optional starting with 7.0"
|
||||
"description":"The type of the document; deprecated and optional starting with 7.0",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"preference":{
|
||||
"type":"string",
|
||||
|
|
@ -64,11 +86,14 @@
|
|||
},
|
||||
"version_type":{
|
||||
"type":"enum",
|
||||
"options" : ["internal", "external", "external_gte", "force"],
|
||||
"options":[
|
||||
"internal",
|
||||
"external",
|
||||
"external_gte",
|
||||
"force"
|
||||
],
|
||||
"description":"Specific version type"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,33 +1,57 @@
|
|||
{
|
||||
"explain":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html",
|
||||
"description":"Returns information about why a specific matches (or doesn't match) a query."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET", "POST"],
|
||||
"url":{
|
||||
"paths": ["/{index}/_explain/{id}"],
|
||||
"deprecated_paths" : [
|
||||
"paths":[
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/{index}/{type}/{id}/_explain",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
}
|
||||
"path":"/{index}/_explain/{id}",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"description":"The document ID"
|
||||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"description":"The name of the index"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/{type}/{id}/_explain",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The document ID"
|
||||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the index"
|
||||
},
|
||||
"type":{
|
||||
"type":"string",
|
||||
"description" : "The type of the document"
|
||||
"description":"The type of the document",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"analyze_wildcard":{
|
||||
"type":"boolean",
|
||||
|
|
@ -39,7 +63,10 @@
|
|||
},
|
||||
"default_operator":{
|
||||
"type":"enum",
|
||||
"options" : ["AND","OR"],
|
||||
"options":[
|
||||
"AND",
|
||||
"OR"
|
||||
],
|
||||
"default":"OR",
|
||||
"description":"The default operator for query string query (AND or OR)"
|
||||
},
|
||||
|
|
@ -79,7 +106,6 @@
|
|||
"type":"list",
|
||||
"description":"A list of fields to extract and return from the _source field"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The query definition using the Query DSL"
|
||||
|
|
|
|||
|
|
@ -1,18 +1,33 @@
|
|||
{
|
||||
"field_caps":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html",
|
||||
"description":"Returns the information about the capabilities of fields among multiple indices."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET", "POST"],
|
||||
"url":{
|
||||
"paths":[
|
||||
"/_field_caps",
|
||||
"/{index}/_field_caps"
|
||||
{
|
||||
"path":"/_field_caps",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_field_caps",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"fields":{
|
||||
|
|
@ -29,7 +44,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -39,7 +59,5 @@
|
|||
"description":"Indicates whether unmapped fields should be included in the response."
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
@ -1,33 +1,55 @@
|
|||
{
|
||||
"get":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html",
|
||||
"description":"Returns a document."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/{index}/_doc/{id}"],
|
||||
"deprecated_paths" : [
|
||||
"paths":[
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/{index}/{type}/{id}",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
}
|
||||
"path":"/{index}/_doc/{id}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"description":"The document ID"
|
||||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"description":"The name of the index"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/{type}/{id}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The document ID"
|
||||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the index"
|
||||
},
|
||||
"type":{
|
||||
"type":"string",
|
||||
"description" : "The type of the document (use `_all` to fetch the first document matching the ID across all types)"
|
||||
"description":"The type of the document (use `_all` to fetch the first document matching the ID across all types)",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"stored_fields":{
|
||||
"type":"list",
|
||||
|
|
@ -67,11 +89,14 @@
|
|||
},
|
||||
"version_type":{
|
||||
"type":"enum",
|
||||
"options" : ["internal", "external", "external_gte", "force"],
|
||||
"options":[
|
||||
"internal",
|
||||
"external",
|
||||
"external_gte",
|
||||
"force"
|
||||
],
|
||||
"description":"Specific version type"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,16 +1,25 @@
|
|||
{
|
||||
"get_script":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html",
|
||||
"description":"Returns a script."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": [ "/_scripts/{id}" ],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_scripts/{id}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"description" : "Script ID",
|
||||
"required" : true
|
||||
"description":"Script ID"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"master_timeout":{
|
||||
|
|
@ -18,7 +27,5 @@
|
|||
"description":"Specify timeout for connection to master"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
@ -1,34 +1,56 @@
|
|||
{
|
||||
"get_source":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html",
|
||||
"description":"Returns the source of a document."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/{index}/_source/{id}"],
|
||||
"deprecated_paths" : [
|
||||
"paths":[
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/{index}/{type}/{id}/_source",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
}
|
||||
"path":"/{index}/_source/{id}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"description":"The document ID"
|
||||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"description":"The name of the index"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/{type}/{id}/_source",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The document ID"
|
||||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the index"
|
||||
},
|
||||
"type":{
|
||||
"type":"string",
|
||||
"required":false,
|
||||
"description" : "The type of the document; deprecated and optional starting with 7.0"
|
||||
"description":"The type of the document; deprecated and optional starting with 7.0",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"preference":{
|
||||
"type":"string",
|
||||
|
|
@ -64,11 +86,14 @@
|
|||
},
|
||||
"version_type":{
|
||||
"type":"enum",
|
||||
"options" : ["internal", "external", "external_gte", "force"],
|
||||
"options":[
|
||||
"internal",
|
||||
"external",
|
||||
"external_gte",
|
||||
"force"
|
||||
],
|
||||
"description":"Specific version type"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,21 +1,17 @@
|
|||
{
|
||||
"index":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html",
|
||||
"stability": "stable",
|
||||
"methods": ["POST", "PUT"],
|
||||
"url": {
|
||||
"paths": ["/{index}/_doc/{id}", "/{index}/_doc"],
|
||||
"deprecated_paths" : [
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/{index}/{type}",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html",
|
||||
"description":"Creates or updates a document in an index."
|
||||
},
|
||||
"stability":"stable",
|
||||
"url":{
|
||||
"paths":[
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/{index}/{type}/{id}",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
}
|
||||
"path":"/{index}/_doc/{id}",
|
||||
"methods":[
|
||||
"POST",
|
||||
"PUT"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
|
|
@ -24,14 +20,71 @@
|
|||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the index"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_doc",
|
||||
"methods":[
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"string",
|
||||
"description":"The name of the index"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/{type}",
|
||||
"methods":[
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"string",
|
||||
"description":"The name of the index"
|
||||
},
|
||||
"type":{
|
||||
"type":"string",
|
||||
"description" : "The type of the document"
|
||||
"description":"The type of the document",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/{type}/{id}",
|
||||
"methods":[
|
||||
"POST",
|
||||
"PUT"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"description":"Document ID"
|
||||
},
|
||||
"index":{
|
||||
"type":"string",
|
||||
"description":"The name of the index"
|
||||
},
|
||||
"type":{
|
||||
"type":"string",
|
||||
"description":"The type of the document",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"wait_for_active_shards":{
|
||||
"type":"string",
|
||||
|
|
@ -39,13 +92,20 @@
|
|||
},
|
||||
"op_type":{
|
||||
"type":"enum",
|
||||
"options" : ["index", "create"],
|
||||
"options":[
|
||||
"index",
|
||||
"create"
|
||||
],
|
||||
"default":"index",
|
||||
"description":"Explicit operation type"
|
||||
},
|
||||
"refresh":{
|
||||
"type":"enum",
|
||||
"options": ["true", "false", "wait_for"],
|
||||
"options":[
|
||||
"true",
|
||||
"false",
|
||||
"wait_for"
|
||||
],
|
||||
"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."
|
||||
},
|
||||
"routing":{
|
||||
|
|
@ -62,7 +122,12 @@
|
|||
},
|
||||
"version_type":{
|
||||
"type":"enum",
|
||||
"options" : ["internal", "external", "external_gte", "force"],
|
||||
"options":[
|
||||
"internal",
|
||||
"external",
|
||||
"external_gte",
|
||||
"force"
|
||||
],
|
||||
"description":"Specific version type"
|
||||
},
|
||||
"if_seq_no":{
|
||||
|
|
@ -77,7 +142,6 @@
|
|||
"type":"string",
|
||||
"description":"The pipeline id to preprocess incoming documents with"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The document",
|
||||
|
|
|
|||
|
|
@ -1,22 +1,39 @@
|
|||
{
|
||||
"indices.analyze":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html",
|
||||
"description":"Performs the analysis process on a text and return the tokens breakdown of the text."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET", "POST"],
|
||||
"url":{
|
||||
"paths": ["/_analyze", "/{index}/_analyze"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_analyze",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_analyze",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"string",
|
||||
"description":"The name of the index to scope the operation"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"index":{
|
||||
"type":"string",
|
||||
"description":"The name of the index to scope the operation"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"Define analyzer/tokenizer parameters and the text on which the analysis should be performed"
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"indices.clear_cache":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html",
|
||||
"description":"Clears all or specific caches for one or more indices."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["POST"],
|
||||
"url":{
|
||||
"paths": ["/_cache/clear", "/{index}/_cache/clear"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_cache/clear",
|
||||
"methods":[
|
||||
"POST"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_cache/clear",
|
||||
"methods":[
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index name to limit the operation"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"fielddata":{
|
||||
|
|
@ -34,7 +50,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -47,7 +68,5 @@
|
|||
"description":"Clear request cache"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,10 +1,18 @@
|
|||
{
|
||||
"indices.clone": {
|
||||
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html",
|
||||
"documentation": {
|
||||
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clone-index.html",
|
||||
"description": "Clones an index"
|
||||
},
|
||||
"stability": "stable",
|
||||
"methods": ["PUT", "POST"],
|
||||
"url": {
|
||||
"paths": ["/{index}/_clone/{target}"],
|
||||
"paths": [
|
||||
{
|
||||
"path": "/{index}/_clone/{target}",
|
||||
"methods": [
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"parts": {
|
||||
"index": {
|
||||
"type": "string",
|
||||
|
|
@ -16,6 +24,9 @@
|
|||
"required": true,
|
||||
"description": "The name of the target index to clone into"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params": {
|
||||
"timeout": {
|
||||
|
|
@ -30,7 +41,6 @@
|
|||
"type" : "string",
|
||||
"description" : "Set the number of active shards to wait for on the cloned index before the operation returns."
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": {
|
||||
"description" : "The configuration for the target index (`settings` and `aliases`)"
|
||||
|
|
|
|||
|
|
@ -1,16 +1,25 @@
|
|||
{
|
||||
"indices.close":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html",
|
||||
"description":"Closes an index."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["POST"],
|
||||
"url":{
|
||||
"paths": ["/{index}/_close"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/{index}/_close",
|
||||
"methods":[
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"required" : true,
|
||||
"description":"A comma separated list of indices to close"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"timeout":{
|
||||
|
|
@ -31,7 +40,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -40,7 +54,5 @@
|
|||
"description":"Sets the number of active shards to wait for before the operation returns."
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,16 +1,25 @@
|
|||
{
|
||||
"indices.create":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html",
|
||||
"description":"Creates an index with optional settings and mappings."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["PUT"],
|
||||
"url":{
|
||||
"paths": ["/{index}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/{index}",
|
||||
"methods":[
|
||||
"PUT"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the index"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"include_type_name":{
|
||||
|
|
@ -29,7 +38,6 @@
|
|||
"type":"time",
|
||||
"description":"Specify timeout for connection to master"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The configuration for the index (`settings` and `mappings`)"
|
||||
|
|
|
|||
|
|
@ -1,16 +1,25 @@
|
|||
{
|
||||
"indices.delete":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html",
|
||||
"description":"Deletes an index."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["DELETE"],
|
||||
"url":{
|
||||
"paths": ["/{index}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/{index}",
|
||||
"methods":[
|
||||
"DELETE"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"required" : true,
|
||||
"description":"A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"timeout":{
|
||||
|
|
@ -31,12 +40,15 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options": [ "open", "closed", "none", "all" ],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether wildcard expressions should get expanded to open or closed indices (default: open)"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,21 +1,45 @@
|
|||
{
|
||||
"indices.delete_alias":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html",
|
||||
"description":"Deletes an alias."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["DELETE"],
|
||||
"url":{
|
||||
"paths": ["/{index}/_alias/{name}", "/{index}/_aliases/{name}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/{index}/_alias/{name}",
|
||||
"methods":[
|
||||
"DELETE"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"required" : true,
|
||||
"description":"A comma-separated list of index names (supports wildcards); use `_all` for all indices"
|
||||
},
|
||||
"name":{
|
||||
"type":"list",
|
||||
"required" : true,
|
||||
"description":"A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices."
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_aliases/{name}",
|
||||
"methods":[
|
||||
"DELETE"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names (supports wildcards); use `_all` for all indices"
|
||||
},
|
||||
"name":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices."
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"timeout":{
|
||||
|
|
@ -27,7 +51,5 @@
|
|||
"description":"Specify timeout for connection to master"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,16 +1,25 @@
|
|||
{
|
||||
"indices.delete_template":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html",
|
||||
"description":"Deletes an index template."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["DELETE"],
|
||||
"url":{
|
||||
"paths": ["/_template/{name}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_template/{name}",
|
||||
"methods":[
|
||||
"DELETE"
|
||||
],
|
||||
"parts":{
|
||||
"name":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the template"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"timeout":{
|
||||
|
|
@ -22,7 +31,5 @@
|
|||
"description":"Specify timeout for connection to master"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,16 +1,25 @@
|
|||
{
|
||||
"indices.exists":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html",
|
||||
"description":"Returns information about whether a particular index exists."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": [ "HEAD" ],
|
||||
"url":{
|
||||
"paths": [ "/{index}" ],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/{index}",
|
||||
"methods":[
|
||||
"HEAD"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"required": true,
|
||||
"description":"A comma-separated list of index names"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"local":{
|
||||
|
|
@ -27,7 +36,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options": [ "open", "closed", "none", "all" ],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether wildcard expressions should get expanded to open or closed indices (default: open)"
|
||||
},
|
||||
|
|
@ -41,7 +55,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,10 +1,29 @@
|
|||
{
|
||||
"indices.exists_alias":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html",
|
||||
"description":"Returns information about whether a particular alias exists."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["HEAD"],
|
||||
"url":{
|
||||
"paths": ["/_alias/{name}", "/{index}/_alias/{name}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_alias/{name}",
|
||||
"methods":[
|
||||
"HEAD"
|
||||
],
|
||||
"parts":{
|
||||
"name":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of alias names to return"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_alias/{name}",
|
||||
"methods":[
|
||||
"HEAD"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
|
|
@ -12,9 +31,11 @@
|
|||
},
|
||||
"name":{
|
||||
"type":"list",
|
||||
"required" : true,
|
||||
"description":"A comma-separated list of alias names to return"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"ignore_unavailable":{
|
||||
|
|
@ -27,7 +48,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"all",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -36,7 +62,5 @@
|
|||
"description":"Return local information, do not retrieve the state from master node (default: false)"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,16 +1,25 @@
|
|||
{
|
||||
"indices.exists_template":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html",
|
||||
"description":"Returns information about whether a particular index template exists."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["HEAD"],
|
||||
"url":{
|
||||
"paths": [ "/_template/{name}" ],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_template/{name}",
|
||||
"methods":[
|
||||
"HEAD"
|
||||
],
|
||||
"parts":{
|
||||
"name":{
|
||||
"type":"list",
|
||||
"required": true,
|
||||
"description":"The comma separated names of the index templates"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"flat_settings":{
|
||||
|
|
@ -26,7 +35,5 @@
|
|||
"description":"Return local information, do not retrieve the state from master node (default: false)"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,25 +1,29 @@
|
|||
{
|
||||
"indices.exists_type":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html",
|
||||
"stability": "stable",
|
||||
"methods": ["HEAD"],
|
||||
"deprecated" : {
|
||||
"version" : "7.0.0",
|
||||
"description" : "Types are being removed from elasticsearch and therefor this API is on the way out. Read more here: https://www.elastic.co/guide/en/elasticsearch/reference/master/removal-of-types.html"
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html",
|
||||
"description":"Returns information about whether a particular document type exists. (DEPRECATED)"
|
||||
},
|
||||
"stability":"stable",
|
||||
"url":{
|
||||
"paths": ["/{index}/_mapping/{type}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/{index}/_mapping/{type}",
|
||||
"methods":[
|
||||
"HEAD"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"required" : true,
|
||||
"description":"A comma-separated list of index names; use `_all` to check the types across all indices"
|
||||
},
|
||||
"type":{
|
||||
"type":"list",
|
||||
"required" : true,
|
||||
"description":"A comma-separated list of document types to check"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"ignore_unavailable":{
|
||||
|
|
@ -32,7 +36,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -41,7 +50,5 @@
|
|||
"description":"Return local information, do not retrieve the state from master node (default: false)"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,33 @@
|
|||
{
|
||||
"indices.flush":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html",
|
||||
"description":"Performs the flush operation on one or more indices."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["POST", "GET"],
|
||||
"url":{
|
||||
"paths": ["/_flush", "/{index}/_flush"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_flush",
|
||||
"methods":[
|
||||
"POST",
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_flush",
|
||||
"methods":[
|
||||
"POST",
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names; use `_all` or empty string for all indices"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"force":{
|
||||
|
|
@ -30,12 +48,15 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,18 +1,33 @@
|
|||
{
|
||||
"indices.flush_synced":{
|
||||
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html#synced-flush-api",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html#synced-flush-api",
|
||||
"description":"Performs a synced flush operation on one or more indices."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["POST", "GET"],
|
||||
"url":{
|
||||
"paths":[
|
||||
"/_flush/synced",
|
||||
"/{index}/_flush/synced"
|
||||
{
|
||||
"path":"/_flush/synced",
|
||||
"methods":[
|
||||
"POST",
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_flush/synced",
|
||||
"methods":[
|
||||
"POST",
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names; use `_all` or empty string for all indices"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"ignore_unavailable":{
|
||||
|
|
@ -35,7 +50,5 @@
|
|||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"indices.forcemerge":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html",
|
||||
"description":"Performs the force merge operation on one or more indices."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["POST"],
|
||||
"url":{
|
||||
"paths": ["/_forcemerge", "/{index}/_forcemerge"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_forcemerge",
|
||||
"methods":[
|
||||
"POST"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_forcemerge",
|
||||
"methods":[
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"flush":{
|
||||
|
|
@ -26,7 +42,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -39,7 +60,5 @@
|
|||
"description":"Specify whether the operation should only expunge deleted documents"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,16 +1,25 @@
|
|||
{
|
||||
"indices.get":{
|
||||
"documentation":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html",
|
||||
"description":"Returns information about one or more indices."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods":[ "GET" ],
|
||||
"url":{
|
||||
"paths":[ "/{index}" ],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/{index}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"required" : true,
|
||||
"description":"A comma-separated list of index names"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"include_type_name":{
|
||||
|
|
@ -31,7 +40,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether wildcard expressions should get expanded to open or closed indices (default: open)"
|
||||
},
|
||||
|
|
@ -49,7 +63,5 @@
|
|||
"description":"Specify timeout for connection to master"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,10 +1,35 @@
|
|||
{
|
||||
"indices.get_alias":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html",
|
||||
"description":"Returns an alias."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": [ "/_alias", "/_alias/{name}", "/{index}/_alias/{name}", "/{index}/_alias"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_alias",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_alias/{name}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"name":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of alias names to return"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_alias/{name}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
|
|
@ -14,6 +39,21 @@
|
|||
"type":"list",
|
||||
"description":"A comma-separated list of alias names to return"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_alias",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names to filter aliases"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"ignore_unavailable":{
|
||||
|
|
@ -26,7 +66,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"all",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -35,7 +80,5 @@
|
|||
"description":"Return local information, do not retrieve the state from master node (default: false)"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,21 +1,65 @@
|
|||
{
|
||||
"indices.get_field_mapping":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html",
|
||||
"description":"Returns mapping for one or more fields."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_mapping/field/{fields}", "/{index}/_mapping/field/{fields}"],
|
||||
"deprecated_paths" : [
|
||||
"paths":[
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/_mapping/{type}/field/{fields}",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
"path":"/_mapping/field/{fields}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"fields":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of fields"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_mapping/field/{fields}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names"
|
||||
},
|
||||
"fields":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of fields"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_mapping/{type}/field/{fields}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"type":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of document types",
|
||||
"deprecated":true
|
||||
},
|
||||
"fields":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of fields"
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"path" : "/{index}/_mapping/{type}/field/{fields}",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_mapping/{type}/field/{fields}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
|
|
@ -24,14 +68,21 @@
|
|||
},
|
||||
"type":{
|
||||
"type":"list",
|
||||
"description" : "A comma-separated list of document types"
|
||||
"description":"A comma-separated list of document types",
|
||||
"deprecated":true
|
||||
},
|
||||
"fields":{
|
||||
"type":"list",
|
||||
"description" : "A comma-separated list of fields",
|
||||
"required" : true
|
||||
"description":"A comma-separated list of fields"
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"include_type_name":{
|
||||
"type":"boolean",
|
||||
|
|
@ -51,7 +102,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -60,7 +116,5 @@
|
|||
"description":"Return local information, do not retrieve the state from master node (default: false)"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,21 +1,51 @@
|
|||
{
|
||||
"indices.get_mapping":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html",
|
||||
"description":"Returns mappings for one or more indices."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_mapping", "/{index}/_mapping"],
|
||||
"deprecated_paths" : [
|
||||
"paths":[
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/_mapping/{type}",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
"path":"/_mapping",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_mapping",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_mapping/{type}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"type":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of document types",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"path" : "/{index}/_mapping/{type}",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_mapping/{type}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
|
|
@ -24,9 +54,17 @@
|
|||
},
|
||||
"type":{
|
||||
"type":"list",
|
||||
"description" : "A comma-separated list of document types"
|
||||
"description":"A comma-separated list of document types",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"include_type_name":{
|
||||
"type":"boolean",
|
||||
|
|
@ -42,7 +80,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -55,7 +98,5 @@
|
|||
"description":"Return local information, do not retrieve the state from master node (default: false)"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,10 +1,35 @@
|
|||
{
|
||||
"indices.get_settings":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html",
|
||||
"description":"Returns settings for one or more indices."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_settings", "/{index}/_settings", "/{index}/_settings/{name}", "/_settings/{name}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_settings",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_settings",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_settings/{name}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
|
|
@ -14,6 +39,21 @@
|
|||
"type":"list",
|
||||
"description":"The name of the settings that should be included"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_settings/{name}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"name":{
|
||||
"type":"list",
|
||||
"description":"The name of the settings that should be included"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"master_timeout":{
|
||||
|
|
@ -30,8 +70,16 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"default" : ["open","closed"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":[
|
||||
"open",
|
||||
"closed"
|
||||
],
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
"flat_settings":{
|
||||
|
|
@ -48,7 +96,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,19 +1,31 @@
|
|||
{
|
||||
"indices.get_template":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html",
|
||||
"description":"Returns an index template."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths":[
|
||||
"/_template",
|
||||
"/_template/{name}"
|
||||
{
|
||||
"path":"/_template",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_template/{name}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"name":{
|
||||
"type":"list",
|
||||
"required": false,
|
||||
"description":"The comma separated names of the index templates"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"include_type_name":{
|
||||
|
|
@ -33,7 +45,5 @@
|
|||
"description":"Return local information, do not retrieve the state from master node (default: false)"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"indices.get_upgrade":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html",
|
||||
"description":"The _upgrade API is no longer useful and will be removed."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_upgrade", "/{index}/_upgrade"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_upgrade",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_upgrade",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"ignore_unavailable":{
|
||||
|
|
@ -22,12 +38,15 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,16 +1,25 @@
|
|||
{
|
||||
"indices.open":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html",
|
||||
"description":"Opens an index."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["POST"],
|
||||
"url":{
|
||||
"paths": ["/{index}/_open"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/{index}/_open",
|
||||
"methods":[
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"required" : true,
|
||||
"description":"A comma separated list of indices to open"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"timeout":{
|
||||
|
|
@ -31,7 +40,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"closed",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -40,7 +54,5 @@
|
|||
"description":"Sets the number of active shards to wait for before the operation returns."
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,21 +1,47 @@
|
|||
{
|
||||
"indices.put_alias":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html",
|
||||
"description":"Creates or updates an alias."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["PUT", "POST"],
|
||||
"url":{
|
||||
"paths": ["/{index}/_alias/{name}", "/{index}/_aliases/{name}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/{index}/_alias/{name}",
|
||||
"methods":[
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"required" : true,
|
||||
"description":"A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices."
|
||||
},
|
||||
"name":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the alias to be created or updated"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_aliases/{name}",
|
||||
"methods":[
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices."
|
||||
},
|
||||
"name":{
|
||||
"type":"string",
|
||||
"description":"The name of the alias to be created or updated"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"timeout":{
|
||||
|
|
@ -26,7 +52,6 @@
|
|||
"type":"time",
|
||||
"description":"Specify timeout for connection to master"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The settings for the alias, such as `routing` or `filter`",
|
||||
|
|
|
|||
|
|
@ -1,46 +1,30 @@
|
|||
{
|
||||
"indices.put_mapping":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html",
|
||||
"description":"Updates the index mappings."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["PUT", "POST"],
|
||||
"url":{
|
||||
"paths": ["{index}/_mapping"],
|
||||
"deprecated_paths" : [
|
||||
"paths":[
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/{index}/{type}/_mapping",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
},
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/{index}/_mapping/{type}",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
},
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/{index}/{type}/_mappings",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
},
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/{index}/_mappings/{type}",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
},
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/_mappings/{type}",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
},
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "{index}/_mappings",
|
||||
"description" : "The plural mappings is accepted but only /_mapping is documented"
|
||||
},
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/_mapping/{type}",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
"path":"{index}/_mapping",
|
||||
"methods":[
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"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."
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/{type}/_mapping",
|
||||
"methods":[
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
|
|
@ -49,9 +33,136 @@
|
|||
},
|
||||
"type":{
|
||||
"type":"string",
|
||||
"description" : "The name of the document type"
|
||||
"description":"The name of the document type",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_mapping/{type}",
|
||||
"methods":[
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"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."
|
||||
},
|
||||
"type":{
|
||||
"type":"string",
|
||||
"description":"The name of the document type",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/{type}/_mappings",
|
||||
"methods":[
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"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."
|
||||
},
|
||||
"type":{
|
||||
"type":"string",
|
||||
"description":"The name of the document type",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_mappings/{type}",
|
||||
"methods":[
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"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."
|
||||
},
|
||||
"type":{
|
||||
"type":"string",
|
||||
"description":"The name of the document type",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_mappings/{type}",
|
||||
"methods":[
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"type":{
|
||||
"type":"string",
|
||||
"description":"The name of the document type",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"{index}/_mappings",
|
||||
"methods":[
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"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."
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"The plural mappings is accepted but only /_mapping is documented"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_mapping/{type}",
|
||||
"methods":[
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"type":{
|
||||
"type":"string",
|
||||
"description":"The name of the document type",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"include_type_name":{
|
||||
"type":"boolean",
|
||||
|
|
@ -75,11 +186,15 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The mapping definition",
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"indices.put_settings":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html",
|
||||
"description":"Updates the index settings."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["PUT"],
|
||||
"url":{
|
||||
"paths": ["/_settings", "/{index}/_settings"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_settings",
|
||||
"methods":[
|
||||
"PUT"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_settings",
|
||||
"methods":[
|
||||
"PUT"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"master_timeout":{
|
||||
|
|
@ -34,7 +50,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options": ["open", "closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -42,7 +63,6 @@
|
|||
"type":"boolean",
|
||||
"description":"Return settings in flat format (default: false)"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The index settings to be updated",
|
||||
|
|
|
|||
|
|
@ -1,16 +1,26 @@
|
|||
{
|
||||
"indices.put_template":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html",
|
||||
"description":"Creates or updates an index template."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["PUT", "POST"],
|
||||
"url":{
|
||||
"paths": ["/_template/{name}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_template/{name}",
|
||||
"methods":[
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"name":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the template"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"include_type_name":{
|
||||
|
|
@ -38,7 +48,6 @@
|
|||
"type":"boolean",
|
||||
"description":"Return settings in flat format (default: false)"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The template definition",
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"indices.recovery":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html",
|
||||
"description":"Returns information about ongoing index shard recoveries."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_recovery", "/{index}/_recovery"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_recovery",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_recovery",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"detailed":{
|
||||
|
|
@ -23,7 +39,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
@ -1,15 +1,33 @@
|
|||
{
|
||||
"indices.refresh":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.html",
|
||||
"description":"Performs the refresh operation in one or more indices."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["POST", "GET"],
|
||||
"url":{
|
||||
"paths": ["/_refresh", "/{index}/_refresh"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_refresh",
|
||||
"methods":[
|
||||
"POST",
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_refresh",
|
||||
"methods":[
|
||||
"POST",
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"ignore_unavailable":{
|
||||
|
|
@ -22,12 +40,15 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,21 +1,41 @@
|
|||
{
|
||||
"indices.rollover":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-rollover-index.html",
|
||||
"description":"Updates an alias to point to a new index when the existing index\nis considered to be too large or too old."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["POST"],
|
||||
"url":{
|
||||
"paths": ["/{alias}/_rollover", "/{alias}/_rollover/{new_index}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/{alias}/_rollover",
|
||||
"methods":[
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"alias":{
|
||||
"type":"string",
|
||||
"description":"The name of the alias to rollover"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{alias}/_rollover/{new_index}",
|
||||
"methods":[
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"alias":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the alias to rollover"
|
||||
},
|
||||
"new_index":{
|
||||
"type":"string",
|
||||
"required" : false,
|
||||
"description":"The name of the rollover index"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"include_type_name":{
|
||||
|
|
@ -38,7 +58,6 @@
|
|||
"type":"string",
|
||||
"description":"Set the number of active shards to wait for on the newly created rollover index before the operation returns."
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The conditions that needs to be met for executing rollover"
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"indices.segments":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html",
|
||||
"description":"Provides low-level information about segments in a Lucene index."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_segments", "/{index}/_segments"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_segments",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_segments",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"ignore_unavailable":{
|
||||
|
|
@ -22,7 +38,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -32,7 +53,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,20 +1,41 @@
|
|||
{
|
||||
"indices.shard_stores":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shards-stores.html",
|
||||
"description":"Provides store information for shard copies of indices."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_shard_stores", "/{index}/_shard_stores"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_shard_stores",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_shard_stores",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"status":{
|
||||
"type":"list",
|
||||
"options" : ["green", "yellow", "red", "all"],
|
||||
"options":[
|
||||
"green",
|
||||
"yellow",
|
||||
"red",
|
||||
"all"
|
||||
],
|
||||
"description":"A comma-separated list of statuses used to filter on shards to get store information for"
|
||||
},
|
||||
"ignore_unavailable":{
|
||||
|
|
@ -27,12 +48,15 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,21 +1,30 @@
|
|||
{
|
||||
"indices.shrink":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-shrink-index.html",
|
||||
"description":"Allow to shrink an existing index into a new index with fewer primary shards."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["PUT", "POST"],
|
||||
"url":{
|
||||
"paths": ["/{index}/_shrink/{target}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/{index}/_shrink/{target}",
|
||||
"methods":[
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the source index to shrink"
|
||||
},
|
||||
"target":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the target index to shrink into"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"timeout":{
|
||||
|
|
@ -30,7 +39,6 @@
|
|||
"type":"string",
|
||||
"description":"Set the number of active shards to wait for on the shrunken index before the operation returns."
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The configuration for the target index (`settings` and `aliases`)"
|
||||
|
|
|
|||
|
|
@ -1,21 +1,30 @@
|
|||
{
|
||||
"indices.split":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-split-index.html",
|
||||
"description":"Allows you to split an existing index into a new index with more primary shards."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["PUT", "POST"],
|
||||
"url":{
|
||||
"paths": ["/{index}/_split/{target}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/{index}/_split/{target}",
|
||||
"methods":[
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the source index to split"
|
||||
},
|
||||
"target":{
|
||||
"type":"string",
|
||||
"required" : true,
|
||||
"description":"The name of the target index to split into"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"timeout":{
|
||||
|
|
@ -30,7 +39,6 @@
|
|||
"type":"string",
|
||||
"description":"Set the number of active shards to wait for on the shrunken index before the operation returns."
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The configuration for the target index (`settings` and `aliases`)"
|
||||
|
|
|
|||
|
|
@ -1,14 +1,64 @@
|
|||
{
|
||||
"indices.stats":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html",
|
||||
"description":"Provides statistics on operations happening in an index."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths":[
|
||||
"/_stats",
|
||||
"/_stats/{metric}",
|
||||
"/{index}/_stats",
|
||||
"/{index}/_stats/{metric}"
|
||||
{
|
||||
"path":"/_stats",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_stats/{metric}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"metric":{
|
||||
"type":"list",
|
||||
"options":[
|
||||
"_all",
|
||||
"completion",
|
||||
"docs",
|
||||
"fielddata",
|
||||
"query_cache",
|
||||
"flush",
|
||||
"get",
|
||||
"indexing",
|
||||
"merge",
|
||||
"request_cache",
|
||||
"refresh",
|
||||
"search",
|
||||
"segments",
|
||||
"store",
|
||||
"warmer",
|
||||
"suggest"
|
||||
],
|
||||
"description":"Limit the information returned the specific metrics."
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_stats",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_stats/{metric}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
|
|
@ -17,9 +67,29 @@
|
|||
},
|
||||
"metric":{
|
||||
"type":"list",
|
||||
"options" : ["_all", "completion", "docs", "fielddata", "query_cache", "flush", "get", "indexing", "merge", "request_cache", "refresh", "search", "segments", "store", "warmer", "suggest"],
|
||||
"options":[
|
||||
"_all",
|
||||
"completion",
|
||||
"docs",
|
||||
"fielddata",
|
||||
"query_cache",
|
||||
"flush",
|
||||
"get",
|
||||
"indexing",
|
||||
"merge",
|
||||
"request_cache",
|
||||
"refresh",
|
||||
"search",
|
||||
"segments",
|
||||
"store",
|
||||
"warmer",
|
||||
"suggest"
|
||||
],
|
||||
"description":"Limit the information returned the specific metrics."
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"completion_fields":{
|
||||
|
|
@ -41,7 +111,11 @@
|
|||
"level":{
|
||||
"type":"enum",
|
||||
"description":"Return stats aggregated at cluster, index or shard level",
|
||||
"options" : ["cluster", "indices", "shards"],
|
||||
"options":[
|
||||
"cluster",
|
||||
"indices",
|
||||
"shards"
|
||||
],
|
||||
"default":"indices"
|
||||
},
|
||||
"types":{
|
||||
|
|
@ -60,7 +134,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -70,7 +149,5 @@
|
|||
"default":true
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,11 +1,19 @@
|
|||
{
|
||||
"indices.update_aliases":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html",
|
||||
"description":"Updates index aliases."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["POST"],
|
||||
"url":{
|
||||
"paths": ["/_aliases"],
|
||||
"parts": {
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_aliases",
|
||||
"methods":[
|
||||
"POST"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"timeout":{
|
||||
|
|
@ -16,7 +24,6 @@
|
|||
"type":"time",
|
||||
"description":"Specify timeout for connection to master"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The definition of `actions` to perform",
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"indices.upgrade":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html",
|
||||
"description":"The _upgrade API is no longer useful and will be removed."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["POST"],
|
||||
"url":{
|
||||
"paths": ["/_upgrade", "/{index}/_upgrade"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_upgrade",
|
||||
"methods":[
|
||||
"POST"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_upgrade",
|
||||
"methods":[
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"allow_no_indices":{
|
||||
|
|
@ -18,7 +34,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -35,7 +56,5 @@
|
|||
"description":"If true, only ancient (an older Lucene major release) segments will be upgraded"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,16 +1,37 @@
|
|||
{
|
||||
"indices.validate_query":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html",
|
||||
"description":"Allows a user to validate a potentially expensive query without executing it."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET", "POST"],
|
||||
"url":{
|
||||
"paths": ["/_validate/query", "/{index}/_validate/query"],
|
||||
"deprecated_paths" : [
|
||||
"paths":[
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/{index}/{type}/_validate/query",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
"path":"/_validate/query",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_validate/query",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/{type}/_validate/query",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
|
|
@ -19,9 +40,17 @@
|
|||
},
|
||||
"type":{
|
||||
"type":"list",
|
||||
"description" : "A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types"
|
||||
"description":"A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"explain":{
|
||||
"type":"boolean",
|
||||
|
|
@ -37,7 +66,12 @@
|
|||
},
|
||||
"expand_wildcards":{
|
||||
"type":"enum",
|
||||
"options" : ["open","closed","none","all"],
|
||||
"options":[
|
||||
"open",
|
||||
"closed",
|
||||
"none",
|
||||
"all"
|
||||
],
|
||||
"default":"open",
|
||||
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
||||
},
|
||||
|
|
@ -55,7 +89,10 @@
|
|||
},
|
||||
"default_operator":{
|
||||
"type":"enum",
|
||||
"options" : ["AND","OR"],
|
||||
"options":[
|
||||
"AND",
|
||||
"OR"
|
||||
],
|
||||
"default":"OR",
|
||||
"description":"The default operator for query string query (AND or OR)"
|
||||
},
|
||||
|
|
@ -75,7 +112,6 @@
|
|||
"type":"boolean",
|
||||
"description":"Execute validation on all shards instead of one random shard per index"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The query definition specified with the Query DSL"
|
||||
|
|
|
|||
|
|
@ -1,15 +1,20 @@
|
|||
{
|
||||
"info":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/",
|
||||
"description":"Returns basic information about the cluster."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/"],
|
||||
"parts": {
|
||||
"paths":[
|
||||
{
|
||||
"path":"/",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params": {
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
"params":{}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,16 +1,25 @@
|
|||
{
|
||||
"ingest.delete_pipeline":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html",
|
||||
"description":"Deletes a pipeline."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": [ "DELETE" ],
|
||||
"url":{
|
||||
"paths": [ "/_ingest/pipeline/{id}" ],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_ingest/pipeline/{id}",
|
||||
"methods":[
|
||||
"DELETE"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"description" : "Pipeline ID",
|
||||
"required" : true
|
||||
"description":"Pipeline ID"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"master_timeout":{
|
||||
|
|
@ -22,7 +31,5 @@
|
|||
"description":"Explicit operation timeout"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"ingest.get_pipeline":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html",
|
||||
"description":"Returns a pipeline."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": [ "GET" ],
|
||||
"url":{
|
||||
"paths": [ "/_ingest/pipeline", "/_ingest/pipeline/{id}" ],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_ingest/pipeline",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_ingest/pipeline/{id}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"description":"Comma separated list of pipeline ids. Wildcards supported"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"master_timeout":{
|
||||
|
|
@ -17,7 +33,5 @@
|
|||
"description":"Explicit operation timeout for connection to master node"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,20 @@
|
|||
{
|
||||
"ingest.processor_grok":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/grok-processor.html#grok-processor-rest-get",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/grok-processor.html#grok-processor-rest-get",
|
||||
"description":"Returns a list of the built-in patterns."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": [ "GET" ],
|
||||
"url":{
|
||||
"paths": ["/_ingest/processor/grok"],
|
||||
"parts": {
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_ingest/processor/grok",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"params": {
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
"params":{}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,16 +1,25 @@
|
|||
{
|
||||
"ingest.put_pipeline":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html",
|
||||
"description":"Creates or updates a pipeline."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": [ "PUT" ],
|
||||
"url":{
|
||||
"paths": [ "/_ingest/pipeline/{id}" ],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_ingest/pipeline/{id}",
|
||||
"methods":[
|
||||
"PUT"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"description" : "Pipeline ID",
|
||||
"required" : true
|
||||
"description":"Pipeline ID"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"master_timeout":{
|
||||
|
|
@ -21,7 +30,6 @@
|
|||
"type":"time",
|
||||
"description":"Explicit operation timeout"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The ingest definition",
|
||||
|
|
|
|||
|
|
@ -1,16 +1,33 @@
|
|||
{
|
||||
"ingest.simulate":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html",
|
||||
"description":"Allows to simulate a pipeline with example documents."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": [ "GET", "POST" ],
|
||||
"url":{
|
||||
"paths": [ "/_ingest/pipeline/_simulate", "/_ingest/pipeline/{id}/_simulate" ],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_ingest/pipeline/_simulate",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_ingest/pipeline/{id}/_simulate",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"id":{
|
||||
"type":"string",
|
||||
"description" : "Pipeline ID",
|
||||
"required" : false
|
||||
"description":"Pipeline ID"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"verbose":{
|
||||
|
|
@ -18,7 +35,6 @@
|
|||
"description":"Verbose mode. Display data output for each processor in executed pipeline",
|
||||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The simulate definition",
|
||||
|
|
|
|||
|
|
@ -1,16 +1,37 @@
|
|||
{
|
||||
"mget":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html",
|
||||
"description":"Allows to get multiple documents in one request."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET", "POST"],
|
||||
"url":{
|
||||
"paths": ["/_mget", "/{index}/_mget"],
|
||||
"deprecated_paths" : [
|
||||
"paths":[
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/{index}/{type}/_mget",
|
||||
"description" : "Specifying types in urls has been deprecated"
|
||||
"path":"/_mget",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_mget",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"string",
|
||||
"description":"The name of the index"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/{index}/{type}/_mget",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
|
|
@ -19,9 +40,17 @@
|
|||
},
|
||||
"type":{
|
||||
"type":"string",
|
||||
"description" : "The type of the document"
|
||||
"description":"The type of the document",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"Specifying types in urls has been deprecated"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"stored_fields":{
|
||||
"type":"list",
|
||||
|
|
@ -55,7 +84,6 @@
|
|||
"type":"list",
|
||||
"description":"A list of fields to extract and return from the _source field"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL.",
|
||||
|
|
|
|||
|
|
@ -1,20 +1,43 @@
|
|||
{
|
||||
"msearch":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html",
|
||||
"description":"Allows to execute several search operations in one request."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET", "POST"],
|
||||
"url":{
|
||||
"paths": ["/_msearch", "/{index}/_msearch"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_msearch",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_msearch",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names to use as default"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"search_type":{
|
||||
"type":"enum",
|
||||
"options" : ["query_then_fetch", "query_and_fetch", "dfs_query_then_fetch", "dfs_query_and_fetch"],
|
||||
"options":[
|
||||
"query_then_fetch",
|
||||
"query_and_fetch",
|
||||
"dfs_query_then_fetch",
|
||||
"dfs_query_and_fetch"
|
||||
],
|
||||
"description":"Search operation type"
|
||||
},
|
||||
"max_concurrent_searches":{
|
||||
|
|
@ -45,7 +68,6 @@
|
|||
"description":"Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution",
|
||||
"default":"true"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The request definitions (metadata-search request definition pairs), separated by newlines",
|
||||
|
|
|
|||
|
|
@ -1,20 +1,43 @@
|
|||
{
|
||||
"msearch_template":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html",
|
||||
"description":"Allows to execute several search template operations in one request."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET", "POST"],
|
||||
"url":{
|
||||
"paths": ["/_msearch/template", "/{index}/_msearch/template"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_msearch/template",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_msearch/template",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of index names to use as default"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"search_type":{
|
||||
"type":"enum",
|
||||
"options" : ["query_then_fetch", "query_and_fetch", "dfs_query_then_fetch", "dfs_query_and_fetch"],
|
||||
"options":[
|
||||
"query_then_fetch",
|
||||
"query_and_fetch",
|
||||
"dfs_query_then_fetch",
|
||||
"dfs_query_and_fetch"
|
||||
],
|
||||
"description":"Search operation type"
|
||||
},
|
||||
"typed_keys":{
|
||||
|
|
@ -35,7 +58,6 @@
|
|||
"description":"Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution",
|
||||
"default":"true"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"description":"The request definitions (metadata-search request definition pairs), separated by newlines",
|
||||
|
|
|
|||
|
|
@ -1,15 +1,33 @@
|
|||
{
|
||||
"mtermvectors":{
|
||||
"documentation" : "https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html",
|
||||
"description":"Returns multiple termvectors in one request."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods" : ["GET", "POST"],
|
||||
"url":{
|
||||
"paths" : ["/_mtermvectors", "/{index}/_mtermvectors"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_mtermvectors",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/{index}/_mtermvectors",
|
||||
"methods":[
|
||||
"GET",
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"index":{
|
||||
"type":"string",
|
||||
"description":"The index in which the document resides."
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"ids":{
|
||||
|
|
@ -73,15 +91,18 @@
|
|||
},
|
||||
"version_type":{
|
||||
"type":"enum",
|
||||
"options" : ["internal", "external", "external_gte", "force"],
|
||||
"options":[
|
||||
"internal",
|
||||
"external",
|
||||
"external_gte",
|
||||
"force"
|
||||
],
|
||||
"description":"Specific version type"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body":{
|
||||
"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.",
|
||||
"required":false
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,47 +1,112 @@
|
|||
{
|
||||
"nodes.hot_threads":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html",
|
||||
"description":"Returns information about hot threads on each node in the cluster."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_nodes/hot_threads", "/_nodes/{node_id}/hot_threads"],
|
||||
"deprecated_paths" : [
|
||||
"paths":[
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/_cluster/nodes/hotthreads",
|
||||
"description" : "The hot threads API accepts `hotthreads` but only `hot_threads` is documented"
|
||||
"path":"/_nodes/hot_threads",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/_cluster/nodes/{node_id}/hotthreads",
|
||||
"description" : "The hot threads API accepts `hotthreads` but only `hot_threads` is documented"
|
||||
},
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/_nodes/hotthreads",
|
||||
"description" : "The hot threads API accepts `hotthreads` but only `hot_threads` is documented"
|
||||
},
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/_nodes/{node_id}/hotthreads",
|
||||
"description" : "The hot threads API accepts `hotthreads` but only `hot_threads` is documented"
|
||||
},
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" : "/_cluster/nodes/hot_threads",
|
||||
"description" : "The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons"
|
||||
},
|
||||
{
|
||||
"version" : "7.0.0",
|
||||
"path" :"/_cluster/nodes/{node_id}/hot_threads",
|
||||
"description" : "The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons"
|
||||
}
|
||||
"path":"/_nodes/{node_id}/hot_threads",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"node_id":{
|
||||
"type":"list",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_cluster/nodes/hotthreads",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"The hot threads API accepts `hotthreads` but only `hot_threads` is documented"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_cluster/nodes/{node_id}/hotthreads",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"node_id":{
|
||||
"type":"list",
|
||||
"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"
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"The hot threads API accepts `hotthreads` but only `hot_threads` is documented"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_nodes/hotthreads",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"The hot threads API accepts `hotthreads` but only `hot_threads` is documented"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_nodes/{node_id}/hotthreads",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"node_id":{
|
||||
"type":"list",
|
||||
"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"
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"The hot threads API accepts `hotthreads` but only `hot_threads` is documented"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_cluster/nodes/hot_threads",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_cluster/nodes/{node_id}/hot_threads",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"node_id":{
|
||||
"type":"list",
|
||||
"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"
|
||||
}
|
||||
},
|
||||
"deprecated":{
|
||||
"version":"7.0.0",
|
||||
"description":"The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"interval":{
|
||||
|
|
@ -62,7 +127,11 @@
|
|||
},
|
||||
"type":{
|
||||
"type":"enum",
|
||||
"options" : ["cpu", "wait", "block"],
|
||||
"options":[
|
||||
"cpu",
|
||||
"wait",
|
||||
"block"
|
||||
],
|
||||
"description":"The type to sample (default: cpu)"
|
||||
},
|
||||
"timeout":{
|
||||
|
|
@ -70,7 +139,5 @@
|
|||
"description":"Explicit operation timeout"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,10 +1,58 @@
|
|||
{
|
||||
"nodes.info":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html",
|
||||
"description":"Returns information about nodes in the cluster."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths": ["/_nodes", "/_nodes/{node_id}", "/_nodes/{metric}", "/_nodes/{node_id}/{metric}"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_nodes",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_nodes/{node_id}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"node_id":{
|
||||
"type":"list",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_nodes/{metric}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"metric":{
|
||||
"type":"list",
|
||||
"options":[
|
||||
"settings",
|
||||
"os",
|
||||
"process",
|
||||
"jvm",
|
||||
"thread_pool",
|
||||
"transport",
|
||||
"http",
|
||||
"plugins",
|
||||
"ingest"
|
||||
],
|
||||
"description":"A comma-separated list of metrics you wish returned. Leave empty to return all."
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_nodes/{node_id}/{metric}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"node_id":{
|
||||
"type":"list",
|
||||
|
|
@ -12,9 +60,22 @@
|
|||
},
|
||||
"metric":{
|
||||
"type":"list",
|
||||
"options": ["settings", "os", "process", "jvm", "thread_pool", "transport", "http", "plugins", "ingest"],
|
||||
"options":[
|
||||
"settings",
|
||||
"os",
|
||||
"process",
|
||||
"jvm",
|
||||
"thread_pool",
|
||||
"transport",
|
||||
"http",
|
||||
"plugins",
|
||||
"ingest"
|
||||
],
|
||||
"description":"A comma-separated list of metrics you wish returned. Leave empty to return all."
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"flat_settings":{
|
||||
|
|
@ -26,7 +87,5 @@
|
|||
"description":"Explicit operation timeout"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,15 +1,31 @@
|
|||
{
|
||||
"nodes.reload_secure_settings":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings",
|
||||
"description":"Reloads secure settings."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["POST"],
|
||||
"url":{
|
||||
"paths": ["/_nodes/reload_secure_settings", "/_nodes/{node_id}/reload_secure_settings"],
|
||||
"paths":[
|
||||
{
|
||||
"path":"/_nodes/reload_secure_settings",
|
||||
"methods":[
|
||||
"POST"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_nodes/{node_id}/reload_secure_settings",
|
||||
"methods":[
|
||||
"POST"
|
||||
],
|
||||
"parts":{
|
||||
"node_id":{
|
||||
"type":"list",
|
||||
"description":"A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes."
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"timeout":{
|
||||
|
|
@ -17,7 +33,5 @@
|
|||
"description":"Explicit operation timeout"
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,32 +1,183 @@
|
|||
{
|
||||
"nodes.stats":{
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html",
|
||||
"documentation":{
|
||||
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html",
|
||||
"description":"Returns statistical information about nodes in the cluster."
|
||||
},
|
||||
"stability":"stable",
|
||||
"methods": ["GET"],
|
||||
"url":{
|
||||
"paths":[
|
||||
"/_nodes/stats",
|
||||
"/_nodes/{node_id}/stats",
|
||||
"/_nodes/stats/{metric}",
|
||||
"/_nodes/{node_id}/stats/{metric}",
|
||||
"/_nodes/stats/{metric}/{index_metric}",
|
||||
"/_nodes/{node_id}/stats/{metric}/{index_metric}"
|
||||
{
|
||||
"path":"/_nodes/stats",
|
||||
"methods":[
|
||||
"GET"
|
||||
]
|
||||
},
|
||||
{
|
||||
"path":"/_nodes/{node_id}/stats",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"node_id":{
|
||||
"type":"list",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_nodes/stats/{metric}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"metric":{
|
||||
"type":"list",
|
||||
"options" : ["_all", "breaker", "fs", "http", "indices", "jvm", "os", "process", "thread_pool", "transport", "discovery"],
|
||||
"options":[
|
||||
"_all",
|
||||
"breaker",
|
||||
"fs",
|
||||
"http",
|
||||
"indices",
|
||||
"jvm",
|
||||
"os",
|
||||
"process",
|
||||
"thread_pool",
|
||||
"transport",
|
||||
"discovery"
|
||||
],
|
||||
"description":"Limit the information returned to the specified metrics"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_nodes/{node_id}/stats/{metric}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"metric":{
|
||||
"type":"list",
|
||||
"options":[
|
||||
"_all",
|
||||
"breaker",
|
||||
"fs",
|
||||
"http",
|
||||
"indices",
|
||||
"jvm",
|
||||
"os",
|
||||
"process",
|
||||
"thread_pool",
|
||||
"transport",
|
||||
"discovery"
|
||||
],
|
||||
"description":"Limit the information returned to the specified metrics"
|
||||
},
|
||||
"node_id":{
|
||||
"type":"list",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_nodes/stats/{metric}/{index_metric}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"metric":{
|
||||
"type":"list",
|
||||
"options":[
|
||||
"_all",
|
||||
"breaker",
|
||||
"fs",
|
||||
"http",
|
||||
"indices",
|
||||
"jvm",
|
||||
"os",
|
||||
"process",
|
||||
"thread_pool",
|
||||
"transport",
|
||||
"discovery"
|
||||
],
|
||||
"description":"Limit the information returned to the specified metrics"
|
||||
},
|
||||
"index_metric":{
|
||||
"type":"list",
|
||||
"options" : ["_all", "completion", "docs", "fielddata", "query_cache", "flush", "get", "indexing", "merge", "request_cache", "refresh", "search", "segments", "store", "warmer", "suggest"],
|
||||
"options":[
|
||||
"_all",
|
||||
"completion",
|
||||
"docs",
|
||||
"fielddata",
|
||||
"query_cache",
|
||||
"flush",
|
||||
"get",
|
||||
"indexing",
|
||||
"merge",
|
||||
"request_cache",
|
||||
"refresh",
|
||||
"search",
|
||||
"segments",
|
||||
"store",
|
||||
"warmer",
|
||||
"suggest"
|
||||
],
|
||||
"description":"Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified."
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"path":"/_nodes/{node_id}/stats/{metric}/{index_metric}",
|
||||
"methods":[
|
||||
"GET"
|
||||
],
|
||||
"parts":{
|
||||
"metric":{
|
||||
"type":"list",
|
||||
"options":[
|
||||
"_all",
|
||||
"breaker",
|
||||
"fs",
|
||||
"http",
|
||||
"indices",
|
||||
"jvm",
|
||||
"os",
|
||||
"process",
|
||||
"thread_pool",
|
||||
"transport",
|
||||
"discovery"
|
||||
],
|
||||
"description":"Limit the information returned to the specified metrics"
|
||||
},
|
||||
"index_metric":{
|
||||
"type":"list",
|
||||
"options":[
|
||||
"_all",
|
||||
"completion",
|
||||
"docs",
|
||||
"fielddata",
|
||||
"query_cache",
|
||||
"flush",
|
||||
"get",
|
||||
"indexing",
|
||||
"merge",
|
||||
"request_cache",
|
||||
"refresh",
|
||||
"search",
|
||||
"segments",
|
||||
"store",
|
||||
"warmer",
|
||||
"suggest"
|
||||
],
|
||||
"description":"Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified."
|
||||
},
|
||||
"node_id":{
|
||||
"type":"list",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"params":{
|
||||
"completion_fields":{
|
||||
|
|
@ -48,7 +199,11 @@
|
|||
"level":{
|
||||
"type":"enum",
|
||||
"description":"Return indices stats aggregated at index, node or shard level",
|
||||
"options" : ["indices", "node", "shards"],
|
||||
"options":[
|
||||
"indices",
|
||||
"node",
|
||||
"shards"
|
||||
],
|
||||
"default":"node"
|
||||
},
|
||||
"types":{
|
||||
|
|
@ -65,7 +220,5 @@
|
|||
"default":false
|
||||
}
|
||||
}
|
||||
},
|
||||
"body": null
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue