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

client/src/commonMain/kotlin/com/algolia/client/model/composition/CompositionRunAppliedRules.kt

@@ -10,11 +10,11 @@ import kotlinx.serialization.json.*
 /**
  * CompositionRunAppliedRules
  *
- * @param objectID Unique record identifier.
+ * @param objectID The objectID of the applied composition rule on this query.
  */
 @Serializable
 public data class CompositionRunAppliedRules(
 
-  /** Unique record identifier. */
+  /** The objectID of the applied composition rule on this query. */
   @SerialName(value = "objectID") val objectID: String
 ) {}

client/src/commonMain/kotlin/com/algolia/client/model/composition/CompositionRunSearchResponse.kt

@@ -13,13 +13,13 @@ import kotlinx.serialization.json.*
 /**
  * CompositionRunSearchResponse
  *
- * @param objectID Unique record identifier.
+ * @param objectID The objectID of the composition which generated this result set.
  * @param appliedRules
  */
 @Serializable(CompositionRunSearchResponseSerializer::class)
 public data class CompositionRunSearchResponse(
 
-  /** Unique record identifier. */
+  /** The objectID of the composition which generated this result set. */
   val objectID: String,
   val appliedRules: List<CompositionRunAppliedRules>? = null,
   val additionalProperties: Map<String, JsonElement>? = null,

client/src/commonMain/kotlin/com/algolia/client/model/composition/ResultsInjectedItemAppliedRulesInfoResponse.kt

@@ -10,11 +10,11 @@ import kotlinx.serialization.json.*
 /**
  * ResultsInjectedItemAppliedRulesInfoResponse
  *
- * @param objectID Unique record identifier.
+ * @param objectID The objectID of the applied index level rule on this injected group.
  */
 @Serializable
 public data class ResultsInjectedItemAppliedRulesInfoResponse(
 
-  /** Unique record identifier. */
+  /** The objectID of the applied index level rule on this injected group. */
   @SerialName(value = "objectID") val objectID: String
 ) {}

client/src/commonMain/kotlin/com/algolia/client/model/composition/ResultsInjectedItemInfoResponse.kt

@@ -13,11 +13,13 @@ import kotlinx.serialization.json.*
 /**
  * ResultsInjectedItemInfoResponse
  *
- * @param key
+ * @param key The key of the injected group.
  * @param appliedRules
  */
 @Serializable(ResultsInjectedItemInfoResponseSerializer::class)
 public data class ResultsInjectedItemInfoResponse(
+
+  /** The key of the injected group. */
   val key: String,
   val appliedRules: List<ResultsInjectedItemAppliedRulesInfoResponse>? = null,
   val additionalProperties: Map<String, JsonElement>? = null,

client/src/commonMain/kotlin/com/algolia/client/model/composition/SearchResultsItem.kt

@@ -10,14 +10,14 @@ import kotlinx.serialization.json.*
 /**
  * SearchResultsItem
  *
- * @param page The current page of the results.
- * @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 hitsPerPage Number of hits returned per page.
+ * @param nbHits Number of results (hits).
+ * @param nbPages Number of pages of results.
+ * @param page The current page of the results.
  * @param params URL-encoded string of all search parameters.
+ * @param query The search query string.
  * @param compositions
  * @param abTestID A/B test ID. This is only included in the response for indices that are part of
  *   an A/B test.
@@ -58,29 +58,29 @@ import kotlinx.serialization.json.*
 @Serializable
 public data class SearchResultsItem(
 
-  /** The current page of the results. */
-  @SerialName(value = "page") val page: Int,
+  /**
+   * Search results (hits). Hits are records from your index that match the search criteria,
+   * augmented with additional attributes, such as, for highlighting.
+   */
+  @SerialName(value = "hits") val hits: List<Hit>,
+
+  /** Number of hits returned per page. */
+  @SerialName(value = "hitsPerPage") val hitsPerPage: Int,
 
   /** Number of results (hits). */
   @SerialName(value = "nbHits") val nbHits: Int,
 
   /** Number of pages of results. */
   @SerialName(value = "nbPages") val nbPages: Int,
 
-  /** Number of hits returned per page. */
-  @SerialName(value = "hitsPerPage") val hitsPerPage: Int,
+  /** The current page of the results. */
+  @SerialName(value = "page") val page: Int,
 
-  /**
-   * Search results (hits). Hits are records from your index that match the search criteria,
-   * augmented with additional attributes, such as, for highlighting.
-   */
-  @SerialName(value = "hits") val hits: List<Hit>,
+  /** URL-encoded string of all search parameters. */
+  @SerialName(value = "params") val params: String,
 
   /** The search query string. */
   @SerialName(value = "query") val query: String,
-
-  /** URL-encoded string of all search parameters. */
-  @SerialName(value = "params") val params: String,
   @SerialName(value = "compositions")
   val compositions: Map<kotlin.String, ResultsCompositionInfoResponse>,