refactor(specs): re-organise response for Composition API (generated)

algolia/api-clients-automation#5744

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>

Author: algolia-bot

src/main/scala/algoliasearch/composition/CompositionBaseSearchResponse.scala

@@ -28,48 +28,8 @@
   */
 package algoliasearch.composition
 
-import org.json4s._
-
 /** CompositionBaseSearchResponse
   */
 case class CompositionBaseSearchResponse(
-    compositions: Option[CompositionsSearchResponse] = scala.None,
-    additionalProperties: Option[List[JField]] = None
+    compositions: Option[CompositionsSearchResponse] = scala.None
 )
-
-class CompositionBaseSearchResponseSerializer extends Serializer[CompositionBaseSearchResponse] {
-
-  override def deserialize(implicit
-      format: Formats
-  ): PartialFunction[(TypeInfo, JValue), CompositionBaseSearchResponse] = {
-    case (TypeInfo(clazz, _), json) if clazz == classOf[CompositionBaseSearchResponse] =>
-      json match {
-        case jobject: JObject =>
-          val formats = format - this
-          val mf = manifest[CompositionBaseSearchResponse]
-          val obj = Extraction.extract[CompositionBaseSearchResponse](jobject)(formats, mf)
-
-          val fields = Set("compositions")
-          val additionalProperties = jobject removeField {
-            case (name, _) if fields.contains(name) => true
-            case _                                  => false
-          }
-          additionalProperties match {
-            case JObject(fieldsList) => obj copy (additionalProperties = Some(fieldsList))
-            case _                   => obj
-          }
-        case _ => throw new IllegalArgumentException(s"Can't deserialize $json as CompositionBaseSearchResponse")
-      }
-  }
-
-  override def serialize(implicit format: Formats): PartialFunction[Any, JValue] = {
-    case value: CompositionBaseSearchResponse =>
-      val formats = format - this // remove current serializer from formats to avoid stackoverflow
-      val baseObj = Extraction.decompose(value.copy(additionalProperties = None))(formats)
-
-      value.additionalProperties match {
-        case Some(fields) => baseObj merge JObject(fields)
-        case None         => baseObj
-      }
-  }
-}

src/main/scala/algoliasearch/composition/CompositionRunAppliedRules.scala

@@ -31,7 +31,7 @@ package algoliasearch.composition
 /** CompositionRunAppliedRules
   *
   * @param objectID
-  *   Unique record identifier.
+  *   The objectID of the applied composition rule on this query.
   */
 case class CompositionRunAppliedRules(
     objectID: String

src/main/scala/algoliasearch/composition/CompositionRunSearchResponse.scala

@@ -33,7 +33,7 @@ import org.json4s._
 /** CompositionRunSearchResponse
   *
   * @param objectID
-  *   Unique record identifier.
+  *   The objectID of the composition which generated this result set.
   */
 case class CompositionRunSearchResponse(
     objectID: String,

src/main/scala/algoliasearch/composition/JsonSupport.scala

@@ -69,15 +69,12 @@ object JsonSupport {
 
   private def classMapSerializers: Seq[Serializer[?]] = Seq[Serializer[?]]() :+
     new BaseSearchResponseSerializer() :+
-    new CompositionBaseSearchResponseSerializer() :+
     new CompositionRunSearchResponseSerializer() :+
     new CompositionsSearchResponseSerializer() :+
     new ErrorBaseSerializer() :+
     new HitSerializer() :+
     new HitMetadataSerializer() :+
-    new ResultsCompositionsResponseSerializer() :+
     new ResultsInjectedItemInfoResponseSerializer() :+
-    new SearchHitsSerializer() :+
     new SearchResultsItemSerializer()
 
   implicit val format: Formats = DefaultFormats ++ enumSerializers ++ oneOfsSerializers ++ classMapSerializers

src/main/scala/algoliasearch/composition/ResultsCompositionsResponse.scala

@@ -28,48 +28,8 @@
   */
 package algoliasearch.composition
 
-import org.json4s._
-
 /** ResultsCompositionsResponse
   */
 case class ResultsCompositionsResponse(
-    compositions: Map[String, ResultsCompositionInfoResponse],
-    additionalProperties: Option[List[JField]] = None
+    compositions: Map[String, ResultsCompositionInfoResponse]
 )
-
-class ResultsCompositionsResponseSerializer extends Serializer[ResultsCompositionsResponse] {
-
-  override def deserialize(implicit
-      format: Formats
-  ): PartialFunction[(TypeInfo, JValue), ResultsCompositionsResponse] = {
-    case (TypeInfo(clazz, _), json) if clazz == classOf[ResultsCompositionsResponse] =>
-      json match {
-        case jobject: JObject =>
-          val formats = format - this
-          val mf = manifest[ResultsCompositionsResponse]
-          val obj = Extraction.extract[ResultsCompositionsResponse](jobject)(formats, mf)
-
-          val fields = Set("compositions")
-          val additionalProperties = jobject removeField {
-            case (name, _) if fields.contains(name) => true
-            case _                                  => false
-          }
-          additionalProperties match {
-            case JObject(fieldsList) => obj copy (additionalProperties = Some(fieldsList))
-            case _                   => obj
-          }
-        case _ => throw new IllegalArgumentException(s"Can't deserialize $json as ResultsCompositionsResponse")
-      }
-  }
-
-  override def serialize(implicit format: Formats): PartialFunction[Any, JValue] = {
-    case value: ResultsCompositionsResponse =>
-      val formats = format - this // remove current serializer from formats to avoid stackoverflow
-      val baseObj = Extraction.decompose(value.copy(additionalProperties = None))(formats)
-
-      value.additionalProperties match {
-        case Some(fields) => baseObj merge JObject(fields)
-        case None         => baseObj
-      }
-  }
-}

src/main/scala/algoliasearch/composition/ResultsInjectedItemAppliedRulesInfoResponse.scala

@@ -31,7 +31,7 @@ package algoliasearch.composition
 /** ResultsInjectedItemAppliedRulesInfoResponse
   *
   * @param objectID
-  *   Unique record identifier.
+  *   The objectID of the applied index level rule on this injected group.
   */
 case class ResultsInjectedItemAppliedRulesInfoResponse(
     objectID: String

src/main/scala/algoliasearch/composition/ResultsInjectedItemInfoResponse.scala

@@ -31,6 +31,9 @@ package algoliasearch.composition
 import org.json4s._
 
 /** ResultsInjectedItemInfoResponse
+  *
+  * @param key
+  *   The key of the injected group.
   */
 case class ResultsInjectedItemInfoResponse(
     key: String,

…earch/composition/SearchPagination.scala …liasearch/composition/SearchFields.scalasrc/main/scala/algoliasearch/composition/SearchPagination.scala renamed to src/main/scala/algoliasearch/composition/SearchFields.scala src/main/scala/algoliasearch/composition/SearchPagination.scala renamed to src/main/scala/algoliasearch/composition/SearchFields.scala

@@ -28,20 +28,30 @@
   */
 package algoliasearch.composition
 
-/** SearchPagination
+/** SearchFields
   *
-  * @param page
-  *   The current page of the results.
+  * @param hits
+  *   Search results (hits). Hits are records from your index that match the search criteria, augmented with additional
+  *   attributes, such as, for highlighting.
+  * @param hitsPerPage
+  *   Number of hits returned per page.
   * @param nbHits
   *   Number of results (hits).
   * @param nbPages
   *   Number of pages of results.
-  * @param hitsPerPage
-  *   Number of hits returned per page.
+  * @param page
+  *   The current page of the results.
+  * @param params
+  *   URL-encoded string of all search parameters.
+  * @param query
+  *   The search query string.
   */
-case class SearchPagination(
-    page: Int,
+case class SearchFields(
+    hits: Seq[Hit],
+    hitsPerPage: Int,
     nbHits: Int,
     nbPages: Int,
-    hitsPerPage: Int
+    page: Int,
+    params: String,
+    query: String
 )

src/main/scala/algoliasearch/composition/SearchHits.scala

@@ -81,21 +81,21 @@ import org.json4s._
   *   analytics](https://www.algolia.com/doc/guides/analytics/click-analytics).
   * @param automaticInsights
   *   Whether automatic events collection is enabled for the application.
-  * @param page
-  *   The current page of the results.
+  * @param hits
+  *   Search results (hits). Hits are records from your index that match the search criteria, augmented with additional
+  *   attributes, such as, for highlighting.
+  * @param hitsPerPage
+  *   Number of hits returned per page.
   * @param nbHits
   *   Number of results (hits).
   * @param nbPages
   *   Number of pages of results.
-  * @param hitsPerPage
-  *   Number of hits returned per page.
-  * @param hits
-  *   Search results (hits). Hits are records from your index that match the search criteria, augmented with additional
-  *   attributes, such as, for highlighting.
-  * @param query
-  *   The search query string.
+  * @param page
+  *   The current page of the results.
   * @param params
   *   URL-encoded string of all search parameters.
+  * @param query
+  *   The search query string.
   */
 case class SearchResultsItem(
     abTestID: Option[Int] = scala.None,
@@ -124,13 +124,13 @@ case class SearchResultsItem(
     userData: Option[Any] = scala.None,
     queryID: Option[String] = scala.None,
     automaticInsights /* _automaticInsights */: Option[Boolean] = scala.None,
-    page: Int,
+    hits: Seq[Hit],
+    hitsPerPage: Int,
     nbHits: Int,
     nbPages: Int,
-    hitsPerPage: Int,
-    hits: Seq[Hit],
-    query: String,
+    page: Int,
     params: String,
+    query: String,
     compositions: Map[String, ResultsCompositionInfoResponse]
 )