api.asciidoc 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. [float]
  2. [[breaking_70_api_changes]]
  3. === API changes
  4. [float]
  5. ==== Camel case and underscore parameters deprecated in 6.x have been removed
  6. A number of duplicate parameters deprecated in 6.x have been removed from
  7. Bulk request, Multi Get request, Term Vectors request, and More Like This Query
  8. requests.
  9. The following camel case parameters have been removed:
  10. * `opType`
  11. * `versionType`, `_versionType`
  12. The following parameters starting with underscore have been removed:
  13. * `_parent`
  14. * `_retry_on_conflict`
  15. * `_routing`
  16. * `_version`
  17. * `_version_type`
  18. Instead of these removed parameters, use their non camel case equivalents without
  19. starting underscore, e.g. use `version_type` instead of `_version_type` or `versionType`.
  20. [float]
  21. ==== Thread pool info
  22. In previous versions of Elasticsearch, the thread pool info returned in the
  23. <<cluster-nodes-info,nodes info API>> returned `min` and `max` values reflecting
  24. the configured minimum and maximum number of threads that could be in each
  25. thread pool. The trouble with this representation is that it does not align with
  26. the configuration parameters used to configure thread pools. For
  27. <<modules-threadpool,scaling thread pools>>, the minimum number of threads is
  28. configured by a parameter called `core` and the maximum number of threads is
  29. configured by a parameter called `max`. For <<modules-threadpool,fixed thread
  30. pools>>, there is only one configuration parameter along these lines and that
  31. parameter is called `size`, reflecting the fixed number of threads in the
  32. pool. This discrepancy between the API and the configuration parameters has been
  33. rectified. Now, the API will report `core` and `max` for scaling thread pools,
  34. and `size` for fixed thread pools.
  35. Similarly, in the cat thread pool API the existing `size` output has been
  36. renamed to `pool_size` which reflects the number of threads currently in the
  37. pool; the shortcut for this value has been changed from `s` to `psz`. The `min`
  38. output has been renamed to `core` with a shortcut of `cr`, the shortcut for
  39. `max` has been changed to `mx`, and the `size` output with a shortcut of `sz`
  40. has been reused to report the configured number of threads in the pool. This
  41. aligns the output of the API with the configuration values for thread
  42. pools. Note that `core` and `max` will be populated for scaling thread pools,
  43. and `size` will be populated for fixed thread pools.
  44. [float]
  45. ==== The parameter `fields` deprecated in 6.x has been removed from Bulk request
  46. and Update request. The Update API returns `400 - Bad request` if request contains
  47. unknown parameters (instead of ignored in the previous version).
  48. [float]
  49. [[remove-suggest-metric]]
  50. ==== Remove support for `suggest` metric/index metric in indices stats and nodes stats APIs
  51. Previously, `suggest` stats were folded into `search` stats. Support for the
  52. `suggest` metric on the indices stats and nodes stats APIs remained for
  53. backwards compatibility. Backwards support for the `suggest` metric was
  54. deprecated in 6.3.0 and now removed in 7.0.0.
  55. [[remove-field-caps-body]]
  56. In the past, `fields` could be provided either as a parameter, or as part of the request
  57. body. Specifying `fields` in the request body as opposed to a parameter was deprecated
  58. in 6.4.0, and is now unsupported in 7.0.0.
  59. [float]
  60. ==== `copy_settings` is deprecated on shrink and split APIs
  61. Versions of Elasticsearch prior to 6.4.0 did not copy index settings on shrink
  62. and split operations. Starting with Elasticsearch 7.0.0, the default behavior
  63. will be for such settings to be copied on such operations. To enable users in
  64. 6.4.0 to transition in 6.4.0 to the default behavior in 7.0.0, the
  65. `copy_settings` parameter was added on the REST layer. As this behavior will be
  66. the only behavior in 8.0.0, this parameter is deprecated in 7.0.0 for removal in
  67. 8.0.0.
  68. [float]
  69. ==== The deprecated stored script contexts have now been removed
  70. When putting stored scripts, support for storing them with the deprecated `template` context or without a context is
  71. now removed. Scripts must be stored using the `script` context as mentioned in the documentation.
  72. [float]
  73. ==== Get Aliases API limitations when {security} is enabled removed
  74. The behavior and response codes of the get aliases API no longer vary
  75. depending on whether {security} is enabled. Previously a
  76. 404 - NOT FOUND (IndexNotFoundException) could be returned in case the
  77. current user was not authorized for any alias. An empty response with
  78. status 200 - OK is now returned instead at all times.
  79. [float]
  80. ==== Put User API response no longer has `user` object
  81. The Put User API response was changed in 6.5.0 to add the `created` field
  82. outside of the user object where it previously had been. In 7.0.0 the user
  83. object has been removed in favor of the top level `created` field.