honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/rest-api-spec/api/update.json

92 lines
2.7 KiB
JSON
Raw Normal View History

[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
{
"update": {
[SPEC] Updated docs URLs to point to master
2014-01-22 08:40:31 -05:00
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-update.html",
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
"methods": ["POST"],
"url": {
"path": "/{index}/{type}/{id}/_update",
"paths": ["/{index}/{type}/{id}/_update"],
"parts": {
[SETUP] Changed, that `parts` and `params` API definitions are sorted alphabetically
2013-05-26 06:20:43 -04:00
"id": {
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"type": "string",
"required": true,
"description": "Document ID"
[SETUP] Changed, that `parts` and `params` API definitions are sorted alphabetically
2013-05-26 06:20:43 -04:00
},
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
"index": {
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"type": "string",
"required": true,
"description": "The name of the index"
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
},
"type": {
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"type": "string",
"required": true,
"description": "The type of the document"
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
}
},
"params": {
[SETUP] Changed, that `parts` and `params` API definitions are sorted alphabetically
2013-05-26 06:20:43 -04:00
"consistency": {
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"type": "enum",
"options": ["one", "quorum", "all"],
"description": "Explicit write consistency setting for the operation"
[SETUP] Changed, that `parts` and `params` API definitions are sorted alphabetically
2013-05-26 06:20:43 -04:00
},
"fields": {
Added the API definition for updating a document
2013-05-27 17:57:02 -04:00
"type": "list",
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"description": "A comma-separated list of fields to return in the response"
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
},
[SETUP] Changed, that `parts` and `params` API definitions are sorted alphabetically
2013-05-26 06:20:43 -04:00
"lang": {
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"type": "string",
Switch to Groovy as the default scripting language This is a breaking change to move from MVEL -> Groovy
2014-06-20 06:11:59 -04:00
"description": "The script language (default: groovy)"
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
},
"parent": {
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"type": "string",
"description": "ID of the parent document"
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
},
"refresh": {
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"type": "boolean",
"description": "Refresh the index after performing the operation"
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
},
"replication": {
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"type": "enum",
"options": ["sync", "async"],
"default": "sync",
"description": "Specific replication type"
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
},
[SETUP] Changed, that `parts` and `params` API definitions are sorted alphabetically
2013-05-26 06:20:43 -04:00
"retry_on_conflict": {
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"type": "number",
"description": "Specify how many times should the operation be retried when a conflict occurs (default: 0)"
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
},
[SETUP] Changed, that `parts` and `params` API definitions are sorted alphabetically
2013-05-26 06:20:43 -04:00
"routing": {
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"type": "string",
"description": "Specific routing value"
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
},
"script": {
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"description": "The URL-encoded script definition (instead of using request body)"
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
},
[SETUP] Changed, that `parts` and `params` API definitions are sorted alphabetically
2013-05-26 06:20:43 -04:00
"timeout": {
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"type": "time",
"description": "Explicit operation timeout"
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
},
"timestamp": {
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"type": "time",
"description": "Explicit timestamp for the document"
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
},
"ttl": {
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"type": "duration",
"description": "Expiration time for the document"
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
},
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"version": {
"type": "number",
"description": "Explicit version number for concurrency control"
Added "version" param to delete and update
2013-06-20 05:34:09 -04:00
},
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
"version_type": {
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"type": "enum",
"options": ["internal", "force"],
"description": "Specific version type"
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
}
}
},
"body": {
Version types `EXTERNAL` & `EXTERNAL_GTE` test for version equality in read operation & disallow them in the Update API Separate version check logic for reads and writes for all version types, which allows different behavior in these cases. Change `VersionType.EXTERNAL` & `VersionType.EXTERNAL_GTE` to behave the same as `VersionType.INTERNAL` for read operations. The previous behavior was fit for writes but is useless in reads. This commit also makes the usage of `EXTERNAL` & `EXTERNAL_GTE` in the update api raise a validation error as it make cause data to be lost. Closes #5663 , Closes #5661, Closes #5929
2014-04-23 05:13:25 -04:00
"description": "The request definition using either `script` or partial `doc`"
[SETUP] Added the generated JSON skeleton files Files were generated with the `thor api:generate:spec --force --verbose --crawl` command, and based on the 0.90 branch (elasticsearch/elasticsearch@5ec4064).
2013-05-24 06:02:42 -04:00
}
}
}