fix #35262 define deprecations of API's as a whole and urls #39063
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mpdreamz
added
:Core/Infra/REST API
|
Pinging @elastic/es-core-infra |
|
@bmcconaghy will this affect Console? as @jasontedor noted need to update PR and I still need to make the version qualified up to the path (major.minor.patch) |
Mpdreamz
force-pushed
the
feature/rest-spec-deprecations
branch
from
ab35d03 to
477f99d
Compare
Mpdreamz
force-pushed
the
feature/rest-spec-deprecations
branch
2 times, most recently
from
8f181dd to
10d0836
Compare
…e body which is a safer behaviour as well
Mpdreamz
force-pushed
the
feature/rest-spec-deprecations
branch
from
10d0836 to
430108a
Compare
|
run elasticsearch-ci/1 |
1 similar comment
|
run elasticsearch-ci/1 |
jaymode
approved these changes
Apr 22, 2019
| @@ -2,6 +2,10 @@ | |||
| "indices.exists_type": { | |||
| "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-exists.html", | |||
| "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" | |||
There was a problem hiding this comment.
Suggested change
| "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" | |
| "description" : "Types are being removed from elasticsearch and therefore this API is on the way out. Read more here: https://www.elastic.co/guide/en/elasticsearch/reference/master/removal-of-types.html" |
|
Sorry, somehow did not see this ping from before. Console is not directly connected to the ES REST specs, so it will not affect console. The parser that generates the JSON for the console autocomplete will not mind that there are new attributes in these either. Console has no mechanism for warning users that endpoints are deprecated, so it could not (currently) consume them to warn users that things are going away. However, it does display deprecation warnings coming back in ES responses, so if these deprecated paths return warnings the user will be notified. |
Mpdreamz
added a commit
that referenced
this pull request
Apr 23, 2019
* fix #35262 define deprecations of API's as a whole and urls * document hot threads deprecated paths * deprecate scroll_id as part of the URL, documented only as part of the body which is a safer behaviour as well * use version numbers up to patch version * rest spec parser picks up deprecated paths as paths too (cherry picked from commit 7e06023)
This was referenced May 10, 2019
gurkankaymak
pushed a commit
to gurkankaymak/elasticsearch
that referenced
this pull request
May 27, 2019
…lastic#39063) * fix elastic#35262 define deprecations of API's as a whole and urls * document hot threads deprecated paths * deprecate scroll_id as part of the URL, documented only as part of the body which is a safer behaviour as well * use version numbers up to patch version * rest spec parser picks up deprecated paths as paths too
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This moves deprecated paths out of
pathsand into a new property calleddeprecated_paths.This allows client generators to either skip or otherwise mark these endpoints as deprecated/obsolete and use language specific mechanisms to warn the users.
This also introduces a
deprecatedblock on the API itself to mark a whole API as deprecated. Seeindices.exists_type.json