api.asciidoc 3.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. [[breaking_70_api_changes]]
  2. === Breaking API changes in 7.0
  3. ==== Camel case and underscore parameters deprecated in 6.x have been removed
  4. A number of duplicate parameters deprecated in 6.x have been removed from
  5. Bulk request, Multi Get request, Term Vectors request, and More Like This Query
  6. requests.
  7. The following camel case parameters have been removed:
  8. * `opType`
  9. * `versionType`, `_versionType`
  10. The following parameters starting with underscore have been removed:
  11. * `_parent`
  12. * `_retry_on_conflict`
  13. * `_routing`
  14. * `_version`
  15. * `_version_type`
  16. Instead of these removed parameters, use their non camel case equivalents without
  17. starting underscore, e.g. use `version_type` instead of `_version_type` or `versionType`.
  18. ==== Thread pool info
  19. In previous versions of Elasticsearch, the thread pool info returned in the
  20. <<cluster-nodes-info,nodes info API>> returned `min` and `max` values reflecting
  21. the configured minimum and maximum number of threads that could be in each
  22. thread pool. The trouble with this representation is that it does not align with
  23. the configuration parameters used to configure thread pools. For
  24. <<modules-threadpool,scaling thread pools>>, the minimum number of threads is
  25. configured by a parameter called `core` and the maximum number of threads is
  26. configured by a parameter called `max`. For <<modules-threadpool,fixed thread
  27. pools>>, there is only one configuration parameter along these lines and that
  28. parameter is called `size`, reflecting the fixed number of threads in the
  29. pool. This discrepancy between the API and the configuration parameters has been
  30. rectified. Now, the API will report `core` and `max` for scaling thread pools,
  31. and `size` for fixed thread pools.
  32. Similarly, in the cat thread pool API the existing `size` output has been
  33. renamed to `pool_size` which reflects the number of threads currently in the
  34. pool; the shortcut for this value has been changed from `s` to `psz`. The `min`
  35. output has been renamed to `core` with a shortcut of `cr`, the shortcut for
  36. `max` has been changed to `mx`, and the `size` output with a shortcut of `sz`
  37. has been reused to report the configured number of threads in the pool. This
  38. aligns the output of the API with the configuration values for thread
  39. pools. Note that `core` and `max` will be populated for scaling thread pools,
  40. and `size` will be populated for fixed thread pools.
  41. ==== The parameter `fields` deprecated in 6.x has been removed from Bulk request
  42. and Update request. The Update API returns `400 - Bad request` if request contains
  43. unknown parameters (instead of ignored in the previous version).
  44. [[remove-suggest-metric]]
  45. ==== Remove support for `suggest` metric/index metric in indices stats and nodes stats APIs
  46. Previously, `suggest` stats were folded into `search` stats. Support for the
  47. `suggest` metric on the indices stats and nodes stats APIs remained for
  48. backwards compatibility. Backwards support for the `suggest` metric was
  49. deprecated in 6.3.0 and now removed in 7.0.0.
  50. [[remove-field-caps-body]]
  51. In the past, `fields` could be provided either as a parameter, or as part of the request
  52. body. Specifying `fields` in the request body as opposed to a parameter was deprecated
  53. in 6.4.0, and is now unsupported in 7.0.0.
  54. ==== `copy_settings` is deprecated on shrink and split APIs
  55. Versions of Elasticsearch prior to 6.4.0 did not copy index settings on shrink
  56. and split operations. Starting with Elasticsearch 7.0.0, the default behavior
  57. will be for such settings to be copied on such operations. To enable users in
  58. 6.4.0 to transition in 6.4.0 to the default behavior in 7.0.0, the
  59. `copy_settings` parameter was added on the REST layer. As this behavior will be
  60. the only behavior in 8.0.0, this parameter is deprecated in 7.0.0 for removal in
  61. 8.0.0.