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

algoliasearch/src/main/java/com/algolia/model/composition/CompositionRunAppliedRules.java

@@ -18,7 +18,7 @@ public CompositionRunAppliedRules setObjectID(String objectID) {
     return this;
   }
 
-  /** Unique record identifier. */
+  /** The objectID of the applied composition rule on this query. */
   @javax.annotation.Nonnull
   public String getObjectID() {
     return objectID;

algoliasearch/src/main/java/com/algolia/model/composition/CompositionRunSearchResponse.java

@@ -38,7 +38,7 @@ public CompositionRunSearchResponse setObjectID(String objectID) {
     return this;
   }
 
-  /** Unique record identifier. */
+  /** The objectID of the composition which generated this result set. */
   @javax.annotation.Nonnull
   public String getObjectID() {
     return objectID;

algoliasearch/src/main/java/com/algolia/model/composition/ResultsInjectedItemAppliedRulesInfoResponse.java

@@ -18,7 +18,7 @@ public ResultsInjectedItemAppliedRulesInfoResponse setObjectID(String objectID)
     return this;
   }
 
-  /** Unique record identifier. */
+  /** The objectID of the applied index level rule on this injected group. */
   @javax.annotation.Nonnull
   public String getObjectID() {
     return objectID;

algoliasearch/src/main/java/com/algolia/model/composition/ResultsInjectedItemInfoResponse.java

@@ -38,7 +38,7 @@ public ResultsInjectedItemInfoResponse setKey(String key) {
     return this;
   }
 
-  /** Get key */
+  /** The key of the injected group. */
   @javax.annotation.Nonnull
   public String getKey() {
     return key;

algoliasearch/src/main/java/com/algolia/model/composition/SearchResultsItem.java

@@ -92,27 +92,27 @@ public class SearchResultsItem<T> {
   @JsonProperty("_automaticInsights")
   private Boolean automaticInsights;
 
-  @JsonProperty("page")
-  private Integer page;
+  @JsonProperty("hits")
+  private List<T> hits = new ArrayList<>();
+
+  @JsonProperty("hitsPerPage")
+  private Integer hitsPerPage;
 
   @JsonProperty("nbHits")
   private Integer nbHits;
 
   @JsonProperty("nbPages")
   private Integer nbPages;
 
-  @JsonProperty("hitsPerPage")
-  private Integer hitsPerPage;
+  @JsonProperty("page")
+  private Integer page;
 
-  @JsonProperty("hits")
-  private List<T> hits = new ArrayList<>();
+  @JsonProperty("params")
+  private String params;
 
   @JsonProperty("query")
   private String query;
 
-  @JsonProperty("params")
-  private String params;
-
   @JsonProperty("compositions")
   private Map<String, ResultsCompositionInfoResponse> compositions = new HashMap<>();
 
@@ -461,15 +461,34 @@ public Boolean getAutomaticInsights() {
     return automaticInsights;
   }
 
-  public SearchResultsItem<T> setPage(Integer page) {
-    this.page = page;
+  public SearchResultsItem<T> setHits(List<T> hits) {
+    this.hits = hits;
     return this;
   }
 
-  /** The current page of the results. */
+  public SearchResultsItem<T> addHits(T hitsItem) {
+    this.hits.add(hitsItem);
+    return this;
+  }
+
+  /**
+   * Search results (hits). Hits are records from your index that match the search criteria,
+   * augmented with additional attributes, such as, for highlighting.
+   */
   @javax.annotation.Nonnull
-  public Integer getPage() {
-    return page;
+  public List<T> getHits() {
+    return hits;
+  }
+
+  public SearchResultsItem<T> setHitsPerPage(Integer hitsPerPage) {
+    this.hitsPerPage = hitsPerPage;
+    return this;
+  }
+
+  /** Number of hits returned per page. */
+  @javax.annotation.Nonnull
+  public Integer getHitsPerPage() {
+    return hitsPerPage;
   }
 
   public SearchResultsItem<T> setNbHits(Integer nbHits) {
@@ -494,34 +513,26 @@ public Integer getNbPages() {
     return nbPages;
   }
 
-  public SearchResultsItem<T> setHitsPerPage(Integer hitsPerPage) {
-    this.hitsPerPage = hitsPerPage;
+  public SearchResultsItem<T> setPage(Integer page) {
+    this.page = page;
     return this;
   }
 
-  /** Number of hits returned per page. */
+  /** The current page of the results. */
   @javax.annotation.Nonnull
-  public Integer getHitsPerPage() {
-    return hitsPerPage;
-  }
-
-  public SearchResultsItem<T> setHits(List<T> hits) {
-    this.hits = hits;
-    return this;
+  public Integer getPage() {
+    return page;
   }
 
-  public SearchResultsItem<T> addHits(T hitsItem) {
-    this.hits.add(hitsItem);
+  public SearchResultsItem<T> setParams(String params) {
+    this.params = params;
     return this;
   }
 
-  /**
-   * Search results (hits). Hits are records from your index that match the search criteria,
-   * augmented with additional attributes, such as, for highlighting.
-   */
+  /** URL-encoded string of all search parameters. */
   @javax.annotation.Nonnull
-  public List<T> getHits() {
-    return hits;
+  public String getParams() {
+    return params;
   }
 
   public SearchResultsItem<T> setQuery(String query) {
@@ -535,17 +546,6 @@ public String getQuery() {
     return query;
   }
 
-  public SearchResultsItem<T> setParams(String params) {
-    this.params = params;
-    return this;
-  }
-
-  /** URL-encoded string of all search parameters. */
-  @javax.annotation.Nonnull
-  public String getParams() {
-    return params;
-  }
-
   public SearchResultsItem<T> setCompositions(Map<String, ResultsCompositionInfoResponse> compositions) {
     this.compositions = compositions;
     return this;
@@ -598,13 +598,13 @@ public boolean equals(Object o) {
       Objects.equals(this.userData, searchResultsItem.userData) &&
       Objects.equals(this.queryID, searchResultsItem.queryID) &&
       Objects.equals(this.automaticInsights, searchResultsItem.automaticInsights) &&
-      Objects.equals(this.page, searchResultsItem.page) &&
+      Objects.equals(this.hits, searchResultsItem.hits) &&
+      Objects.equals(this.hitsPerPage, searchResultsItem.hitsPerPage) &&
       Objects.equals(this.nbHits, searchResultsItem.nbHits) &&
       Objects.equals(this.nbPages, searchResultsItem.nbPages) &&
-      Objects.equals(this.hitsPerPage, searchResultsItem.hitsPerPage) &&
-      Objects.equals(this.hits, searchResultsItem.hits) &&
-      Objects.equals(this.query, searchResultsItem.query) &&
+      Objects.equals(this.page, searchResultsItem.page) &&
       Objects.equals(this.params, searchResultsItem.params) &&
+      Objects.equals(this.query, searchResultsItem.query) &&
       Objects.equals(this.compositions, searchResultsItem.compositions)
     );
   }
@@ -638,13 +638,13 @@ public int hashCode() {
       userData,
       queryID,
       automaticInsights,
-      page,
+      hits,
+      hitsPerPage,
       nbHits,
       nbPages,
-      hitsPerPage,
-      hits,
-      query,
+      page,
       params,
+      query,
       compositions
     );
   }
@@ -679,13 +679,13 @@ public String toString() {
     sb.append("    userData: ").append(toIndentedString(userData)).append("\n");
     sb.append("    queryID: ").append(toIndentedString(queryID)).append("\n");
     sb.append("    automaticInsights: ").append(toIndentedString(automaticInsights)).append("\n");
-    sb.append("    page: ").append(toIndentedString(page)).append("\n");
+    sb.append("    hits: ").append(toIndentedString(hits)).append("\n");
+    sb.append("    hitsPerPage: ").append(toIndentedString(hitsPerPage)).append("\n");
     sb.append("    nbHits: ").append(toIndentedString(nbHits)).append("\n");
     sb.append("    nbPages: ").append(toIndentedString(nbPages)).append("\n");
-    sb.append("    hitsPerPage: ").append(toIndentedString(hitsPerPage)).append("\n");
-    sb.append("    hits: ").append(toIndentedString(hits)).append("\n");
-    sb.append("    query: ").append(toIndentedString(query)).append("\n");
+    sb.append("    page: ").append(toIndentedString(page)).append("\n");
     sb.append("    params: ").append(toIndentedString(params)).append("\n");
+    sb.append("    query: ").append(toIndentedString(query)).append("\n");
     sb.append("    compositions: ").append(toIndentedString(compositions)).append("\n");
     sb.append("}");
     return sb.toString();