Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes for API specification #46522

Merged
merged 9 commits into from
Sep 16, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"clear_scroll":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#request-body-search-scroll",
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#_clear_scroll_api",
"description":"Explicitly clears the search context for a scroll."
},
"stability":"stable",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@
},
"type":{
"type":"string",
"required":false,
"description":"The type of the document; deprecated and optional starting with 7.0",
"deprecated":true
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@
},
"type":{
"type":"string",
"required":false,
"description":"The type of the document; deprecated and optional starting with 7.0",
"deprecated":true
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,10 @@
"parts": {
"index": {
"type": "string",
"required": true,
"description": "The name of the source index to clone"
},
"target": {
"type": "string",
"required": true,
"description": "The name of the target index to clone into"
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"info":{
"documentation":{
"url":"https://www.elastic.co/guide/",
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html",
"description":"Returns basic information about the cluster."
},
"stability":"stable",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,58 +32,48 @@
"params":{
"ids":{
"type":"list",
"description":"A comma-separated list of documents ids. You must define ids as parameter or set \"ids\" or \"docs\" in the request body",
"required":false
"description":"A comma-separated list of documents ids. You must define ids as parameter or set \"ids\" or \"docs\" in the request body"
},
"term_statistics":{
"type":"boolean",
"description":"Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".",
"default":false,
"required":false
"default":false
},
"field_statistics":{
"type":"boolean",
"description":"Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".",
"default":true,
"required":false
"default":true
},
"fields":{
"type":"list",
"description":"A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".",
"required":false
"description":"A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."
},
"offsets":{
"type":"boolean",
"description":"Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".",
"default":true,
"required":false
"default":true
},
"positions":{
"type":"boolean",
"description":"Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".",
"default":true,
"required":false
"default":true
},
"payloads":{
"type":"boolean",
"description":"Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".",
"default":true,
"required":false
"default":true
},
"preference":{
"type":"string",
"description":"Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".",
"required":false
"description":"Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."
},
"routing":{
"type":"string",
"description":"Specific routing value. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\".",
"required":false
"description":"Specific routing value. Applies to all returned documents unless otherwise specified in body \"params\" or \"docs\"."
},
"realtime":{
"type":"boolean",
"description":"Specifies if requests are real-time as opposed to near-real-time (default: true).",
"required":false
"description":"Specifies if requests are real-time as opposed to near-real-time (default: true)."
},
"version":{
"type":"number",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"ping":{
"documentation":{
"url":"https://www.elastic.co/guide/",
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html",
"description":"Returns whether the cluster is running."
},
"stability":"stable",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"render_search_template":{
"documentation":{
"url":"http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html",
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html#_validating_templates",
"description":"Allows to use the Mustache language to pre-render a search definition."
},
"stability":"stable",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
{
"snapshot.cleanup_repository": {
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html",
"documentation": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.html",
"description": "Removes stale data from repository."
},
"stability": "stable",
"url": {
"paths": [
Expand All @@ -12,7 +15,6 @@
"parts": {
"repository": {
"type": "string",
"required" : true,
"description": "A repository name"
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,52 +43,43 @@
"term_statistics":{
"type":"boolean",
"description":"Specifies if total term frequency and document frequency should be returned.",
"default":false,
"required":false
"default":false
},
"field_statistics":{
"type":"boolean",
"description":"Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.",
"default":true,
"required":false
"default":true
},
"fields":{
"type":"list",
"description":"A comma-separated list of fields to return.",
"required":false
"description":"A comma-separated list of fields to return."
},
"offsets":{
"type":"boolean",
"description":"Specifies if term offsets should be returned.",
"default":true,
"required":false
"default":true
},
"positions":{
"type":"boolean",
"description":"Specifies if term positions should be returned.",
"default":true,
"required":false
"default":true
},
"payloads":{
"type":"boolean",
"description":"Specifies if term payloads should be returned.",
"default":true,
"required":false
"default":true
},
"preference":{
"type":"string",
"description":"Specify the node or shard the operation should be performed on (default: random).",
"required":false
"description":"Specify the node or shard the operation should be performed on (default: random)."
},
"routing":{
"type":"string",
"description":"Specific routing value.",
"required":false
"description":"Specific routing value."
},
"realtime":{
"type":"boolean",
"description":"Specifies if request is real-time as opposed to near-real-time (default: true).",
"required":false
"description":"Specifies if request is real-time as opposed to near-real-time (default: true)."
},
"version":{
"type":"number",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"slm.delete_lifecycle":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api.html"
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete.html"
},
"stability":"stable",
"url":{
Expand All @@ -10,7 +10,13 @@
"path":"/_slm/policy/{policy_id}",
"methods":[
"DELETE"
]
],
"parts":{
"policy_id":{
"type":"string",
"description":"The id of the snapshot lifecycle policy to remove"
}
}
}
]
},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"slm.execute_lifecycle":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api.html"
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute.html"
},
"stability":"stable",
"url":{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"slm.get_lifecycle":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api.html"
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get.html"
},
"stability":"stable",
"url":{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"slm.put_lifecycle":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api.html"
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put.html"
},
"stability":"stable",
"url":{
Expand Down