From 71678e54ae6cb70385023c0333b98faa2fa971b4 Mon Sep 17 00:00:00 2001
From: Paul Constant <paul+gitlab@ayolab.com>
Date: Fri, 11 Oct 2024 10:37:19 +0200
Subject: [PATCH] Add docValueFields to TopHitsAggregation

---
 .../requests/searches/aggs/TopHitsAggregation.scala          | 4 ++++
 .../searches/aggs/builders/TopHitsAggregationBuilder.scala   | 5 ++++-
 .../requests/searches/TopHitsAggregationBuilderTest.scala    | 5 +++--
 3 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/elastic4s-core/src/main/scala/com/sksamuel/elastic4s/requests/searches/aggs/TopHitsAggregation.scala b/elastic4s-core/src/main/scala/com/sksamuel/elastic4s/requests/searches/aggs/TopHitsAggregation.scala
index 2439f3c8c..24286b303 100644
--- a/elastic4s-core/src/main/scala/com/sksamuel/elastic4s/requests/searches/aggs/TopHitsAggregation.scala
+++ b/elastic4s-core/src/main/scala/com/sksamuel/elastic4s/requests/searches/aggs/TopHitsAggregation.scala
@@ -16,6 +16,7 @@ case class TopHitsAggregation(name: String,
                               version: Option[Boolean] = None,
                               scripts: Map[String, Script] = Map.empty,
                               storedFields: Seq[String] = Nil,
+                              docValueFields: Seq[String] = Nil,
                               subaggs: Seq[AbstractAggregation] = Nil,
                               metadata: Map[String, AnyRef] = Map.empty,
                               highlight: Option[Highlight] = None)
@@ -42,6 +43,9 @@ case class TopHitsAggregation(name: String,
   def storedFields(first: String, rest: String*): TopHitsAggregation = storedFields(first +: rest)
   def storedFields(fields: Iterable[String]): TopHitsAggregation     = copy(storedFields = fields.toSeq)
 
+  def docValueFields(docValueFields: Iterable[String]): TopHitsAggregation =
+    copy(docValueFields = docValueFields.toSeq)
+
   def version(version: Boolean): TopHitsAggregation         = copy(version = version.some)
   def trackScores(trackScores: Boolean): TopHitsAggregation = copy(trackScores = trackScores.some)
 
diff --git a/elastic4s-core/src/main/scala/com/sksamuel/elastic4s/requests/searches/aggs/builders/TopHitsAggregationBuilder.scala b/elastic4s-core/src/main/scala/com/sksamuel/elastic4s/requests/searches/aggs/builders/TopHitsAggregationBuilder.scala
index 2a8e2a0a6..1156b0d8b 100644
--- a/elastic4s-core/src/main/scala/com/sksamuel/elastic4s/requests/searches/aggs/builders/TopHitsAggregationBuilder.scala
+++ b/elastic4s-core/src/main/scala/com/sksamuel/elastic4s/requests/searches/aggs/builders/TopHitsAggregationBuilder.scala
@@ -28,7 +28,10 @@ object TopHitsAggregationBuilder {
     agg.explain.foreach(builder.field("explain", _))
 
     if (agg.storedFields.nonEmpty)
-      builder.array("docvalue_fields", agg.storedFields.toArray)
+      builder.array("stored_fields", agg.storedFields.toArray)
+
+    if (agg.docValueFields.nonEmpty)
+      builder.array("docvalue_fields", agg.docValueFields.toArray)
 
     agg.highlight.foreach { highlight =>
       builder.rawField("highlight", HighlightBuilderFn(highlight))
diff --git a/elastic4s-core/src/test/scala/com/sksamuel/elastic4s/requests/searches/TopHitsAggregationBuilderTest.scala b/elastic4s-core/src/test/scala/com/sksamuel/elastic4s/requests/searches/TopHitsAggregationBuilderTest.scala
index 7b9b5b407..3c01b73aa 100644
--- a/elastic4s-core/src/test/scala/com/sksamuel/elastic4s/requests/searches/TopHitsAggregationBuilderTest.scala
+++ b/elastic4s-core/src/test/scala/com/sksamuel/elastic4s/requests/searches/TopHitsAggregationBuilderTest.scala
@@ -13,10 +13,11 @@ class TopHitsAggregationBuilderTest extends AnyFunSuite with Matchers {
       .from(10)
       .version(true)
       .explain(false)
-      .storedFields(List("name"))
+      .docValueFields(List("name"))
+      .storedFields(List("currency"))
       .sortBy(List(FieldSort("price").sortMode(SortMode.Median)))
     TopHitsAggregationBuilder(q).string shouldBe
-      """{"top_hits":{"size":5,"from":10,"sort":[{"price":{"mode":"median","order":"asc"}}],"explain":false,"docvalue_fields":["name"],"version":true}}"""
+      """{"top_hits":{"size":5,"from":10,"sort":[{"price":{"mode":"median","order":"asc"}}],"explain":false,"stored_fields":["currency"],"docvalue_fields":["name"],"version":true}}"""
   }
 
   test("top hits aggregation builder should support highlighting") {