From 849e6c5c770c8ef28a905ee91e6621afd357b54c Mon Sep 17 00:00:00 2001 From: philippus Date: Mon, 19 Aug 2024 22:32:18 -0500 Subject: [PATCH] Deprecate forceSource method/parameter --- .../sksamuel/elastic4s/requests/searches/HighlightField.scala | 2 ++ .../sksamuel/elastic4s/requests/searches/HighlightOptions.scala | 2 ++ .../elastic4s/handlers/searches/HighlightBuilderFn.scala | 1 - .../elastic4s/handlers/searches/HighlightFieldBuilderFn.scala | 1 - 4 files changed, 4 insertions(+), 2 deletions(-) diff --git a/elastic4s-domain/src/main/scala/com/sksamuel/elastic4s/requests/searches/HighlightField.scala b/elastic4s-domain/src/main/scala/com/sksamuel/elastic4s/requests/searches/HighlightField.scala index 610fb230f..9e7dc198f 100644 --- a/elastic4s-domain/src/main/scala/com/sksamuel/elastic4s/requests/searches/HighlightField.scala +++ b/elastic4s-domain/src/main/scala/com/sksamuel/elastic4s/requests/searches/HighlightField.scala @@ -6,6 +6,7 @@ import com.sksamuel.elastic4s.requests.searches.queries.Query case class HighlightField(field: String, boundaryChars: Option[Array[Char]] = None, boundaryMaxScan: Option[Int] = None, + @deprecated("This parameter has no effect", "8.15.0") forceSource: Option[Boolean] = None, fragmenter: Option[String] = None, fragmentOffset: Option[Int] = None, @@ -43,6 +44,7 @@ case class HighlightField(field: String, def requireFieldMatch(requireFieldMatch: Boolean): HighlightField = copy(requireFieldMatch = requireFieldMatch.some) + @deprecated("This method has no effect", "8.15.0") def forceSource(forceSource: Boolean): HighlightField = copy(forceSource = forceSource.some) def highlightFilter(highlightFilter: Boolean): HighlightField = copy(highlightFilter = highlightFilter.some) diff --git a/elastic4s-domain/src/main/scala/com/sksamuel/elastic4s/requests/searches/HighlightOptions.scala b/elastic4s-domain/src/main/scala/com/sksamuel/elastic4s/requests/searches/HighlightOptions.scala index c426ad44f..d8dc06e0f 100644 --- a/elastic4s-domain/src/main/scala/com/sksamuel/elastic4s/requests/searches/HighlightOptions.scala +++ b/elastic4s-domain/src/main/scala/com/sksamuel/elastic4s/requests/searches/HighlightOptions.scala @@ -12,6 +12,7 @@ case class HighlightOptions(encoder: Option[String] = None, boundaryScannerLocale: Option[String] = None, fragmenter: Option[String] = None, fragmentSize: Option[Int] = None, + @deprecated("This parameter has no effect", "8.15.0") forceSource: Option[Boolean] = None, highlighterType: Option[String] = None, highlightFilter: Option[Boolean] = None, @@ -43,6 +44,7 @@ case class HighlightOptions(encoder: Option[String] = None, def fragmenter(fragmenter: String): HighlightOptions = copy(fragmenter = fragmenter.some) def fragmentOffset(fragmentOffset: Int): HighlightOptions = copy(fragmentOffset = fragmentOffset.some) def fragmentSize(fragmentSize: Int): HighlightOptions = copy(fragmentSize = fragmentSize.some) + @deprecated("This method has no effect", "8.15.0") def forceSource(forceSource: Boolean): HighlightOptions = copy(forceSource = forceSource.some) def highlighterType(highlighterType: String): HighlightOptions = diff --git a/elastic4s-handlers/src/main/scala/com/sksamuel/elastic4s/handlers/searches/HighlightBuilderFn.scala b/elastic4s-handlers/src/main/scala/com/sksamuel/elastic4s/handlers/searches/HighlightBuilderFn.scala index ae9ce1966..a06de85a0 100644 --- a/elastic4s-handlers/src/main/scala/com/sksamuel/elastic4s/handlers/searches/HighlightBuilderFn.scala +++ b/elastic4s-handlers/src/main/scala/com/sksamuel/elastic4s/handlers/searches/HighlightBuilderFn.scala @@ -19,7 +19,6 @@ object HighlightBuilderFn { highlight.options.fragmentSize.foreach(builder.field("fragment_size", _)) highlight.options.numOfFragments.foreach(builder.field("number_of_fragments", _)) highlight.options.encoder.foreach(builder.field("encoder", _)) - highlight.options.forceSource.foreach(builder.field("force_source", _)) highlight.options.highlighterType.foreach(builder.field("type", _)) highlight.options.highlightQuery.map(QueryBuilderFn.apply).foreach { highlight => builder.rawField("highlight_query", highlight) diff --git a/elastic4s-handlers/src/main/scala/com/sksamuel/elastic4s/handlers/searches/HighlightFieldBuilderFn.scala b/elastic4s-handlers/src/main/scala/com/sksamuel/elastic4s/handlers/searches/HighlightFieldBuilderFn.scala index 7d5fac5fe..08dc1654e 100644 --- a/elastic4s-handlers/src/main/scala/com/sksamuel/elastic4s/handlers/searches/HighlightFieldBuilderFn.scala +++ b/elastic4s-handlers/src/main/scala/com/sksamuel/elastic4s/handlers/searches/HighlightFieldBuilderFn.scala @@ -13,7 +13,6 @@ object HighlightFieldBuilderFn { field.boundaryChars.foreach(chars => builder.field("boundary_chars", String.valueOf(chars))) field.boundaryMaxScan.foreach(builder.field("boundary_max_scan", _)) field.encoder.foreach(builder.field("encoder", _)) - field.forceSource.foreach(builder.field("force_source", _)) field.fragmenter.foreach(builder.field("fragmenter", _)) field.fragmentOffset.foreach(builder.field("fragment_offset", _)) field.fragmentSize.foreach(builder.field("fragment_size", _))