Skip to content

Remove obsolete parameters from analyze rest spec #31795

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 6, 2018
Merged

Remove obsolete parameters from analyze rest spec #31795

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/java-rest/high-level/indices/analyze.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ You can analyze text using the mappings for a particular field in an index:
include-tagged::{doc-tests}/IndicesClientDocumentationIT.java[analyze-field-request]
---------------------------------------------------

==== Optional arguemnts
==== Optional arguments
The following arguments can also optionally be provided:

["source","java",subs="attributes,callouts,macros"]
Expand Down
10 changes: 0 additions & 10 deletions rest-api-spec/src/main/resources/rest-api-spec/api/indices.analyze.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,6 @@
"index": {
Copy link
Contributor Author

@romseygeek romseygeek Jul 4, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've left the "index" parameter in here, despite it being a path param, as IIUC then path params and URL params get collapsed into a single params object in the rest handler.

Copy link
Member

@javanna javanna Jul 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is correct, index should be left as-is.

"type" : "string",
"description" : "The name of the index to scope the operation"
},
"prefer_local": {
"type" : "boolean",
"description" : "With `true`, specify that a local shard should be used if available, with `false`, use a random shard (default: true)"
},
"format": {
"type": "enum",
"options" : ["detailed","text"],
"default": "detailed",
"description": "Format of the output"
}
}
},
Expand Down