From 4736f7a08d4e41be67dc39641ff58891b650b0ae Mon Sep 17 00:00:00 2001 From: Adam Locke Date: Thu, 27 Jan 2022 15:49:19 -0500 Subject: [PATCH] [DOCS] Add breaking change for renaming the XContent library --- .../reference/migration/migrate_7_16.asciidoc | 38 +++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/docs/reference/migration/migrate_7_16.asciidoc b/docs/reference/migration/migrate_7_16.asciidoc index a511750dd296b..6491e9a45a484 100644 --- a/docs/reference/migration/migrate_7_16.asciidoc +++ b/docs/reference/migration/migrate_7_16.asciidoc @@ -64,6 +64,44 @@ disk space management if needed. This change has no impact on users outside of orchestrated environments. ==== + + +[discrete] +[[breaking_716_hlrc_changes]] +==== High Level REST Client changes + +[[breaking_716_xcontent_migration]] +.The `XContent` API is renamed and breaks imports when upgrading. +[%collapsible] +==== +*Details* + +The `XContent` library exported package is renamed from +`org.elasticsearch.common.xcontent` to `org.elasticsearch.xcontent`. This change +breaks imports when migrating to {es} 7.16. + +*Impact* + +If you're maintaining a Java client application that uses the Java High Level +Rest Client (HLRC), update any `import` statements in your Java source code that +match: + +[source,java] +---- +import org.elasticsearch.common.xcontent. +---- + +to instead use: + +[source,java] +---- +import org.elasticsearch.xcontent. +---- + +This is the minimum required change. You must then recompile your source code to +work with {es} 7.17. + +A more permanent solution is to +{java-api-client}/migrate-hlrc.html[migrate from the (HLRC)] entirely. +==== // end::notable-breaking-changes[] [discrete]