Skip to content

Commit 5a6aa3b

Browse files
authored
feat(specs): improve consistency and naming (#96)
1 parent 48ea9e1 commit 5a6aa3b

File tree

78 files changed

+811
-873
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+811
-873
lines changed

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/AssignUserIdObject.java renamed to clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/AssignUserIdParams.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
import com.google.gson.annotations.SerializedName;
44
import java.util.Objects;
55

6-
/** Assign userID object. */
7-
public class AssignUserIdObject {
6+
/** Assign userID parameters. */
7+
public class AssignUserIdParams {
88

99
@SerializedName("cluster")
1010
private String cluster;
1111

12-
public AssignUserIdObject cluster(String cluster) {
12+
public AssignUserIdParams cluster(String cluster) {
1313
this.cluster = cluster;
1414
return this;
1515
}
@@ -36,8 +36,8 @@ public boolean equals(Object o) {
3636
if (o == null || getClass() != o.getClass()) {
3737
return false;
3838
}
39-
AssignUserIdObject assignUserIdObject = (AssignUserIdObject) o;
40-
return Objects.equals(this.cluster, assignUserIdObject.cluster);
39+
AssignUserIdParams assignUserIdParams = (AssignUserIdParams) o;
40+
return Objects.equals(this.cluster, assignUserIdParams.cluster);
4141
}
4242

4343
@Override
@@ -48,7 +48,7 @@ public int hashCode() {
4848
@Override
4949
public String toString() {
5050
StringBuilder sb = new StringBuilder();
51-
sb.append("class AssignUserIdObject {\n");
51+
sb.append("class AssignUserIdParams {\n");
5252
sb.append(" cluster: ").append(toIndentedString(cluster)).append("\n");
5353
sb.append("}");
5454
return sb.toString();
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@
55
import java.util.List;
66
import java.util.Objects;
77

8-
/** Assign userID object. */
9-
public class BatchAssignUserIdsObject {
8+
/** Assign userID parameters. */
9+
public class BatchAssignUserIdsParams {
1010

1111
@SerializedName("cluster")
1212
private String cluster;
1313

1414
@SerializedName("users")
1515
private List<String> users = new ArrayList<>();
1616

17-
public BatchAssignUserIdsObject cluster(String cluster) {
17+
public BatchAssignUserIdsParams cluster(String cluster) {
1818
this.cluster = cluster;
1919
return this;
2020
}
@@ -33,12 +33,12 @@ public void setCluster(String cluster) {
3333
this.cluster = cluster;
3434
}
3535

36-
public BatchAssignUserIdsObject users(List<String> users) {
36+
public BatchAssignUserIdsParams users(List<String> users) {
3737
this.users = users;
3838
return this;
3939
}
4040

41-
public BatchAssignUserIdsObject addUsersItem(String usersItem) {
41+
public BatchAssignUserIdsParams addUsersItem(String usersItem) {
4242
this.users.add(usersItem);
4343
return this;
4444
}
@@ -65,10 +65,10 @@ public boolean equals(Object o) {
6565
if (o == null || getClass() != o.getClass()) {
6666
return false;
6767
}
68-
BatchAssignUserIdsObject batchAssignUserIdsObject = (BatchAssignUserIdsObject) o;
68+
BatchAssignUserIdsParams batchAssignUserIdsParams = (BatchAssignUserIdsParams) o;
6969
return (
70-
Objects.equals(this.cluster, batchAssignUserIdsObject.cluster) &&
71-
Objects.equals(this.users, batchAssignUserIdsObject.users)
70+
Objects.equals(this.cluster, batchAssignUserIdsParams.cluster) &&
71+
Objects.equals(this.users, batchAssignUserIdsParams.users)
7272
);
7373
}
7474

@@ -80,7 +80,7 @@ public int hashCode() {
8080
@Override
8181
public String toString() {
8282
StringBuilder sb = new StringBuilder();
83-
sb.append("class BatchAssignUserIdsObject {\n");
83+
sb.append("class BatchAssignUserIdsParams {\n");
8484
sb.append(" cluster: ").append(toIndentedString(cluster)).append("\n");
8585
sb.append(" users: ").append(toIndentedString(users)).append("\n");
8686
sb.append("}");

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/BatchObject.java renamed to clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/BatchParams.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@
55
import java.util.List;
66
import java.util.Objects;
77

8-
/** The `batch` requests. */
9-
public class BatchObject {
8+
/** The `multipleBatch` parameters. */
9+
public class BatchParams {
1010

1111
@SerializedName("requests")
1212
private List<Operation> requests = null;
1313

14-
public BatchObject requests(List<Operation> requests) {
14+
public BatchParams requests(List<Operation> requests) {
1515
this.requests = requests;
1616
return this;
1717
}
1818

19-
public BatchObject addRequestsItem(Operation requestsItem) {
19+
public BatchParams addRequestsItem(Operation requestsItem) {
2020
if (this.requests == null) {
2121
this.requests = new ArrayList<>();
2222
}
@@ -46,8 +46,8 @@ public boolean equals(Object o) {
4646
if (o == null || getClass() != o.getClass()) {
4747
return false;
4848
}
49-
BatchObject batchObject = (BatchObject) o;
50-
return Objects.equals(this.requests, batchObject.requests);
49+
BatchParams batchParams = (BatchParams) o;
50+
return Objects.equals(this.requests, batchParams.requests);
5151
}
5252

5353
@Override
@@ -58,7 +58,7 @@ public int hashCode() {
5858
@Override
5959
public String toString() {
6060
StringBuilder sb = new StringBuilder();
61-
sb.append("class BatchObject {\n");
61+
sb.append("class BatchParams {\n");
6262
sb.append(" requests: ").append(toIndentedString(requests)).append("\n");
6363
sb.append("}");
6464
return sb.toString();

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/BatchWriteObject.java renamed to clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/BatchWriteParams.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@
55
import java.util.List;
66
import java.util.Objects;
77

8-
/** The `batch` requests. */
9-
public class BatchWriteObject {
8+
/** The `batch` parameters. */
9+
public class BatchWriteParams {
1010

1111
@SerializedName("requests")
1212
private List<Operation> requests = null;
1313

14-
public BatchWriteObject requests(List<Operation> requests) {
14+
public BatchWriteParams requests(List<Operation> requests) {
1515
this.requests = requests;
1616
return this;
1717
}
1818

19-
public BatchWriteObject addRequestsItem(Operation requestsItem) {
19+
public BatchWriteParams addRequestsItem(Operation requestsItem) {
2020
if (this.requests == null) {
2121
this.requests = new ArrayList<>();
2222
}
@@ -46,8 +46,8 @@ public boolean equals(Object o) {
4646
if (o == null || getClass() != o.getClass()) {
4747
return false;
4848
}
49-
BatchWriteObject batchWriteObject = (BatchWriteObject) o;
50-
return Objects.equals(this.requests, batchWriteObject.requests);
49+
BatchWriteParams batchWriteParams = (BatchWriteParams) o;
50+
return Objects.equals(this.requests, batchWriteParams.requests);
5151
}
5252

5353
@Override
@@ -58,7 +58,7 @@ public int hashCode() {
5858
@Override
5959
public String toString() {
6060
StringBuilder sb = new StringBuilder();
61-
sb.append("class BatchWriteObject {\n");
61+
sb.append("class BatchWriteParams {\n");
6262
sb.append(" requests: ").append(toIndentedString(requests)).append("\n");
6363
sb.append("}");
6464
return sb.toString();

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/BrowseResponse.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ public class BrowseResponse {
8383
private Object userData = new Object();
8484

8585
@SerializedName("hits")
86-
private List<Record> hits = new ArrayList<>();
86+
private List<Hit> hits = new ArrayList<>();
8787

8888
@SerializedName("cursor")
8989
private String cursor;
@@ -576,12 +576,12 @@ public void setUserData(Object userData) {
576576
this.userData = userData;
577577
}
578578

579-
public BrowseResponse hits(List<Record> hits) {
579+
public BrowseResponse hits(List<Hit> hits) {
580580
this.hits = hits;
581581
return this;
582582
}
583583

584-
public BrowseResponse addHitsItem(Record hitsItem) {
584+
public BrowseResponse addHitsItem(Hit hitsItem) {
585585
this.hits.add(hitsItem);
586586
return this;
587587
}
@@ -592,11 +592,11 @@ public BrowseResponse addHitsItem(Record hitsItem) {
592592
* @return hits
593593
*/
594594
@javax.annotation.Nonnull
595-
public List<Record> getHits() {
595+
public List<Hit> getHits() {
596596
return hits;
597597
}
598598

599-
public void setHits(List<Record> hits) {
599+
public void setHits(List<Hit> hits) {
600600
this.hits = hits;
601601
}
602602

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/GetObjectsObject.java renamed to clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/GetObjectsParams.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@
55
import java.util.List;
66
import java.util.Objects;
77

8-
/** The `getObjects` requests. */
9-
public class GetObjectsObject {
8+
/** The `getObjects` parameters. */
9+
public class GetObjectsParams {
1010

1111
@SerializedName("requests")
12-
private List<MultipleGetObjectsObject> requests = null;
12+
private List<MultipleGetObjectsParams> requests = null;
1313

14-
public GetObjectsObject requests(List<MultipleGetObjectsObject> requests) {
14+
public GetObjectsParams requests(List<MultipleGetObjectsParams> requests) {
1515
this.requests = requests;
1616
return this;
1717
}
1818

19-
public GetObjectsObject addRequestsItem(
20-
MultipleGetObjectsObject requestsItem
19+
public GetObjectsParams addRequestsItem(
20+
MultipleGetObjectsParams requestsItem
2121
) {
2222
if (this.requests == null) {
2323
this.requests = new ArrayList<>();
@@ -32,11 +32,11 @@ public GetObjectsObject addRequestsItem(
3232
* @return requests
3333
*/
3434
@javax.annotation.Nullable
35-
public List<MultipleGetObjectsObject> getRequests() {
35+
public List<MultipleGetObjectsParams> getRequests() {
3636
return requests;
3737
}
3838

39-
public void setRequests(List<MultipleGetObjectsObject> requests) {
39+
public void setRequests(List<MultipleGetObjectsParams> requests) {
4040
this.requests = requests;
4141
}
4242

@@ -48,8 +48,8 @@ public boolean equals(Object o) {
4848
if (o == null || getClass() != o.getClass()) {
4949
return false;
5050
}
51-
GetObjectsObject getObjectsObject = (GetObjectsObject) o;
52-
return Objects.equals(this.requests, getObjectsObject.requests);
51+
GetObjectsParams getObjectsParams = (GetObjectsParams) o;
52+
return Objects.equals(this.requests, getObjectsParams.requests);
5353
}
5454

5555
@Override
@@ -60,7 +60,7 @@ public int hashCode() {
6060
@Override
6161
public String toString() {
6262
StringBuilder sb = new StringBuilder();
63-
sb.append("class GetObjectsObject {\n");
63+
sb.append("class GetObjectsParams {\n");
6464
sb.append(" requests: ").append(toIndentedString(requests)).append("\n");
6565
sb.append("}");
6666
return sb.toString();

clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/Record.java renamed to clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/Hit.java

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
import java.util.HashMap;
55
import java.util.Objects;
66

7-
/** A single record. */
8-
public class Record extends HashMap<String, Object> {
7+
/** A single hit. */
8+
public class Hit extends HashMap<String, Object> {
99

1010
@SerializedName("objectID")
1111
private String objectID;
@@ -22,7 +22,7 @@ public class Record extends HashMap<String, Object> {
2222
@SerializedName("_distinctSeqID")
2323
private Integer distinctSeqID;
2424

25-
public Record objectID(String objectID) {
25+
public Hit objectID(String objectID) {
2626
this.objectID = objectID;
2727
return this;
2828
}
@@ -41,7 +41,7 @@ public void setObjectID(String objectID) {
4141
this.objectID = objectID;
4242
}
4343

44-
public Record highlightResult(HighlightResult highlightResult) {
44+
public Hit highlightResult(HighlightResult highlightResult) {
4545
this.highlightResult = highlightResult;
4646
return this;
4747
}
@@ -60,7 +60,7 @@ public void setHighlightResult(HighlightResult highlightResult) {
6060
this.highlightResult = highlightResult;
6161
}
6262

63-
public Record snippetResult(SnippetResult snippetResult) {
63+
public Hit snippetResult(SnippetResult snippetResult) {
6464
this.snippetResult = snippetResult;
6565
return this;
6666
}
@@ -79,7 +79,7 @@ public void setSnippetResult(SnippetResult snippetResult) {
7979
this.snippetResult = snippetResult;
8080
}
8181

82-
public Record rankingInfo(RankingInfo rankingInfo) {
82+
public Hit rankingInfo(RankingInfo rankingInfo) {
8383
this.rankingInfo = rankingInfo;
8484
return this;
8585
}
@@ -98,7 +98,7 @@ public void setRankingInfo(RankingInfo rankingInfo) {
9898
this.rankingInfo = rankingInfo;
9999
}
100100

101-
public Record distinctSeqID(Integer distinctSeqID) {
101+
public Hit distinctSeqID(Integer distinctSeqID) {
102102
this.distinctSeqID = distinctSeqID;
103103
return this;
104104
}
@@ -125,13 +125,13 @@ public boolean equals(Object o) {
125125
if (o == null || getClass() != o.getClass()) {
126126
return false;
127127
}
128-
Record record = (Record) o;
128+
Hit hit = (Hit) o;
129129
return (
130-
Objects.equals(this.objectID, record.objectID) &&
131-
Objects.equals(this.highlightResult, record.highlightResult) &&
132-
Objects.equals(this.snippetResult, record.snippetResult) &&
133-
Objects.equals(this.rankingInfo, record.rankingInfo) &&
134-
Objects.equals(this.distinctSeqID, record.distinctSeqID) &&
130+
Objects.equals(this.objectID, hit.objectID) &&
131+
Objects.equals(this.highlightResult, hit.highlightResult) &&
132+
Objects.equals(this.snippetResult, hit.snippetResult) &&
133+
Objects.equals(this.rankingInfo, hit.rankingInfo) &&
134+
Objects.equals(this.distinctSeqID, hit.distinctSeqID) &&
135135
super.equals(o)
136136
);
137137
}
@@ -151,7 +151,7 @@ public int hashCode() {
151151
@Override
152152
public String toString() {
153153
StringBuilder sb = new StringBuilder();
154-
sb.append("class Record {\n");
154+
sb.append("class Hit {\n");
155155
sb.append(" ").append(toIndentedString(super.toString())).append("\n");
156156
sb.append(" objectID: ").append(toIndentedString(objectID)).append("\n");
157157
sb

0 commit comments

Comments
 (0)