diff --git a/.eslintrc.js b/.eslintrc.js index ea2658cd25..3c2e9e3c98 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -5,6 +5,37 @@ module.exports = { 'plugin:import/errors', 'plugin:import/warnings', 'plugin:import/typescript', + 'plugin:yml/standard', + ], + + // yml linter + overrides: [ + { + files: ['*.yml'], + parser: 'yaml-eslint-parser', + rules: { + '@typescript-eslint/naming-convention': 0, + 'yml/quotes': [ + 2, + { + prefer: 'single', + avoidEscape: true, + }, + ], + 'yml/no-multiple-empty-lines': [ + 2, + { + max: 1, + maxEOF: 0, + maxBOF: 0, + }, + ], + 'yml/require-string-key': 2, + + // Should be removed once the specs are finished + 'yml/no-empty-document': 0, + }, + }, ], env: { diff --git a/.github/actions/cache/action.yml b/.github/actions/cache/action.yml index c80ad208ff..eb261f8b69 100644 --- a/.github/actions/cache/action.yml +++ b/.github/actions/cache/action.yml @@ -3,7 +3,7 @@ name: Cache description: Restore cached dependencies. runs: - using: 'composite' + using: composite steps: - name: Get yarn cache directory path shell: bash @@ -26,5 +26,5 @@ runs: - name: Restore maven dependencies uses: actions/cache@v2 with: - path: '~/.m2/repository' + path: ~/.m2/repository key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} diff --git a/.github/actions/setup/action.yml b/.github/actions/setup/action.yml index 01c7e786ce..8a737a34cf 100644 --- a/.github/actions/setup/action.yml +++ b/.github/actions/setup/action.yml @@ -3,7 +3,7 @@ name: Setup description: Setup CI environment. runs: - using: 'composite' + using: composite steps: - name: Restore cache uses: ./.github/actions/cache @@ -15,18 +15,14 @@ runs: - name: Install Java uses: actions/setup-java@v2 with: - distribution: 'zulu' - java-version: '11.0.4' + distribution: zulu + java-version: 11.0.4 - name: Install Node uses: actions/setup-node@v2 with: - node-version-file: '.nvmrc' + node-version-file: .nvmrc - name: Install JavaScript Dependencies shell: bash run: yarn install - - - name: Install spec linter - shell: bash - run: sudo apt-get -y install yamllint diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index f175c6d256..a3cc084a2c 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -37,7 +37,7 @@ jobs: run: yarn build:specs analytics - name: Lint - run: yamllint specs + run: yarn specs:lint client_javascript: runs-on: ubuntu-20.04 diff --git a/Dockerfile b/Dockerfile index 84b333e327..79a38bc689 100644 --- a/Dockerfile +++ b/Dockerfile @@ -4,7 +4,7 @@ FROM node:$NODE_VERSION-alpine ENV DOCKER=true -RUN apk add openjdk11 maven jq bash yamllint perl curl +RUN apk add openjdk11 maven jq bash perl curl WORKDIR /app diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/AssignUserIdResponse.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/AssignUserIdResponse.java deleted file mode 100644 index f18853c2eb..0000000000 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/AssignUserIdResponse.java +++ /dev/null @@ -1,77 +0,0 @@ -package com.algolia.model; - -import com.google.gson.annotations.SerializedName; -import io.swagger.annotations.ApiModelProperty; -import java.time.OffsetDateTime; -import java.util.Objects; - -/** AssignUserIdResponse */ -public class AssignUserIdResponse { - - public static final String SERIALIZED_NAME_CREATED_AT = "createdAt"; - - @SerializedName(SERIALIZED_NAME_CREATED_AT) - private OffsetDateTime createdAt; - - public AssignUserIdResponse createdAt(OffsetDateTime createdAt) { - this.createdAt = createdAt; - return this; - } - - /** - * Date of creation (ISO-8601 format). - * - * @return createdAt - */ - @javax.annotation.Nonnull - @ApiModelProperty( - required = true, - value = "Date of creation (ISO-8601 format)." - ) - public OffsetDateTime getCreatedAt() { - return createdAt; - } - - public void setCreatedAt(OffsetDateTime createdAt) { - this.createdAt = createdAt; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - AssignUserIdResponse assignUserIdResponse = (AssignUserIdResponse) o; - return Objects.equals(this.createdAt, assignUserIdResponse.createdAt); - } - - @Override - public int hashCode() { - return Objects.hash(createdAt); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class AssignUserIdResponse {\n"); - sb - .append(" createdAt: ") - .append(toIndentedString(createdAt)) - .append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } -} diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/BatchAssignUserIdsResponse.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/BatchAssignUserIdsResponse.java deleted file mode 100644 index beff188d92..0000000000 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/BatchAssignUserIdsResponse.java +++ /dev/null @@ -1,77 +0,0 @@ -package com.algolia.model; - -import com.google.gson.annotations.SerializedName; -import io.swagger.annotations.ApiModelProperty; -import java.time.OffsetDateTime; -import java.util.Objects; - -/** BatchAssignUserIdsResponse */ -public class BatchAssignUserIdsResponse { - - public static final String SERIALIZED_NAME_CREATED_AT = "createdAt"; - - @SerializedName(SERIALIZED_NAME_CREATED_AT) - private OffsetDateTime createdAt; - - public BatchAssignUserIdsResponse createdAt(OffsetDateTime createdAt) { - this.createdAt = createdAt; - return this; - } - - /** - * Date of creation (ISO-8601 format). - * - * @return createdAt - */ - @javax.annotation.Nonnull - @ApiModelProperty( - required = true, - value = "Date of creation (ISO-8601 format)." - ) - public OffsetDateTime getCreatedAt() { - return createdAt; - } - - public void setCreatedAt(OffsetDateTime createdAt) { - this.createdAt = createdAt; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - BatchAssignUserIdsResponse batchAssignUserIdsResponse = (BatchAssignUserIdsResponse) o; - return Objects.equals(this.createdAt, batchAssignUserIdsResponse.createdAt); - } - - @Override - public int hashCode() { - return Objects.hash(createdAt); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class BatchAssignUserIdsResponse {\n"); - sb - .append(" createdAt: ") - .append(toIndentedString(createdAt)) - .append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } -} diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/ClearAllSynonymsResponse.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/ClearAllSynonymsResponse.java deleted file mode 100644 index f3f206367c..0000000000 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/ClearAllSynonymsResponse.java +++ /dev/null @@ -1,109 +0,0 @@ -package com.algolia.model; - -import com.google.gson.annotations.SerializedName; -import io.swagger.annotations.ApiModelProperty; -import java.time.OffsetDateTime; -import java.util.Objects; - -/** ClearAllSynonymsResponse */ -public class ClearAllSynonymsResponse { - - public static final String SERIALIZED_NAME_TASK_I_D = "taskID"; - - @SerializedName(SERIALIZED_NAME_TASK_I_D) - private Integer taskID; - - public static final String SERIALIZED_NAME_UPDATED_AT = "updatedAt"; - - @SerializedName(SERIALIZED_NAME_UPDATED_AT) - private OffsetDateTime updatedAt; - - public ClearAllSynonymsResponse taskID(Integer taskID) { - this.taskID = taskID; - return this; - } - - /** - * taskID of the indexing task to wait for. - * - * @return taskID - */ - @javax.annotation.Nonnull - @ApiModelProperty( - required = true, - value = "taskID of the indexing task to wait for." - ) - public Integer getTaskID() { - return taskID; - } - - public void setTaskID(Integer taskID) { - this.taskID = taskID; - } - - public ClearAllSynonymsResponse updatedAt(OffsetDateTime updatedAt) { - this.updatedAt = updatedAt; - return this; - } - - /** - * Date of last update (ISO-8601 format). - * - * @return updatedAt - */ - @javax.annotation.Nonnull - @ApiModelProperty( - required = true, - value = "Date of last update (ISO-8601 format)." - ) - public OffsetDateTime getUpdatedAt() { - return updatedAt; - } - - public void setUpdatedAt(OffsetDateTime updatedAt) { - this.updatedAt = updatedAt; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ClearAllSynonymsResponse clearAllSynonymsResponse = (ClearAllSynonymsResponse) o; - return ( - Objects.equals(this.taskID, clearAllSynonymsResponse.taskID) && - Objects.equals(this.updatedAt, clearAllSynonymsResponse.updatedAt) - ); - } - - @Override - public int hashCode() { - return Objects.hash(taskID, updatedAt); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ClearAllSynonymsResponse {\n"); - sb.append(" taskID: ").append(toIndentedString(taskID)).append("\n"); - sb - .append(" updatedAt: ") - .append(toIndentedString(updatedAt)) - .append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } -} diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/AppendSourceResponse.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/CreatedAtResponse.java similarity index 77% rename from clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/AppendSourceResponse.java rename to clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/CreatedAtResponse.java index cbd8b08f6a..199391743f 100644 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/AppendSourceResponse.java +++ b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/CreatedAtResponse.java @@ -1,19 +1,21 @@ package com.algolia.model; import com.google.gson.annotations.SerializedName; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.time.OffsetDateTime; import java.util.Objects; -/** AppendSourceResponse */ -public class AppendSourceResponse { +/** The response with a createdAt timestamp. */ +@ApiModel(description = "The response with a createdAt timestamp.") +public class CreatedAtResponse { public static final String SERIALIZED_NAME_CREATED_AT = "createdAt"; @SerializedName(SERIALIZED_NAME_CREATED_AT) private OffsetDateTime createdAt; - public AppendSourceResponse createdAt(OffsetDateTime createdAt) { + public CreatedAtResponse createdAt(OffsetDateTime createdAt) { this.createdAt = createdAt; return this; } @@ -44,8 +46,8 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - AppendSourceResponse appendSourceResponse = (AppendSourceResponse) o; - return Objects.equals(this.createdAt, appendSourceResponse.createdAt); + CreatedAtResponse createdAtResponse = (CreatedAtResponse) o; + return Objects.equals(this.createdAt, createdAtResponse.createdAt); } @Override @@ -56,7 +58,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class AppendSourceResponse {\n"); + sb.append("class CreatedAtResponse {\n"); sb .append(" createdAt: ") .append(toIndentedString(createdAt)) diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DeleteIndexResponse.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DeleteIndexResponse.java deleted file mode 100644 index 3f8c11a7fb..0000000000 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DeleteIndexResponse.java +++ /dev/null @@ -1,103 +0,0 @@ -package com.algolia.model; - -import com.google.gson.annotations.SerializedName; -import io.swagger.annotations.ApiModelProperty; -import java.time.OffsetDateTime; -import java.util.Objects; - -/** DeleteIndexResponse */ -public class DeleteIndexResponse { - - public static final String SERIALIZED_NAME_TASK_I_D = "taskID"; - - @SerializedName(SERIALIZED_NAME_TASK_I_D) - private Integer taskID; - - public static final String SERIALIZED_NAME_DELETED_AT = "deletedAt"; - - @SerializedName(SERIALIZED_NAME_DELETED_AT) - private OffsetDateTime deletedAt; - - public DeleteIndexResponse taskID(Integer taskID) { - this.taskID = taskID; - return this; - } - - /** - * taskID of the indexing task to wait for. - * - * @return taskID - */ - @javax.annotation.Nullable - @ApiModelProperty(value = "taskID of the indexing task to wait for.") - public Integer getTaskID() { - return taskID; - } - - public void setTaskID(Integer taskID) { - this.taskID = taskID; - } - - public DeleteIndexResponse deletedAt(OffsetDateTime deletedAt) { - this.deletedAt = deletedAt; - return this; - } - - /** - * Date of deletion (ISO-8601 format). - * - * @return deletedAt - */ - @javax.annotation.Nullable - @ApiModelProperty(value = "Date of deletion (ISO-8601 format).") - public OffsetDateTime getDeletedAt() { - return deletedAt; - } - - public void setDeletedAt(OffsetDateTime deletedAt) { - this.deletedAt = deletedAt; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DeleteIndexResponse deleteIndexResponse = (DeleteIndexResponse) o; - return ( - Objects.equals(this.taskID, deleteIndexResponse.taskID) && - Objects.equals(this.deletedAt, deleteIndexResponse.deletedAt) - ); - } - - @Override - public int hashCode() { - return Objects.hash(taskID, deletedAt); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DeleteIndexResponse {\n"); - sb.append(" taskID: ").append(toIndentedString(taskID)).append("\n"); - sb - .append(" deletedAt: ") - .append(toIndentedString(deletedAt)) - .append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } -} diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DeleteSynonymResponse.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DeletedAtResponse.java similarity index 78% rename from clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DeleteSynonymResponse.java rename to clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DeletedAtResponse.java index f087b81734..9a442e84a7 100644 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DeleteSynonymResponse.java +++ b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DeletedAtResponse.java @@ -1,12 +1,14 @@ package com.algolia.model; import com.google.gson.annotations.SerializedName; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.time.OffsetDateTime; import java.util.Objects; -/** DeleteSynonymResponse */ -public class DeleteSynonymResponse { +/** The response with a taskID and a deletedAt timestamp. */ +@ApiModel(description = "The response with a taskID and a deletedAt timestamp.") +public class DeletedAtResponse { public static final String SERIALIZED_NAME_TASK_I_D = "taskID"; @@ -18,7 +20,7 @@ public class DeleteSynonymResponse { @SerializedName(SERIALIZED_NAME_DELETED_AT) private OffsetDateTime deletedAt; - public DeleteSynonymResponse taskID(Integer taskID) { + public DeletedAtResponse taskID(Integer taskID) { this.taskID = taskID; return this; } @@ -41,7 +43,7 @@ public void setTaskID(Integer taskID) { this.taskID = taskID; } - public DeleteSynonymResponse deletedAt(OffsetDateTime deletedAt) { + public DeletedAtResponse deletedAt(OffsetDateTime deletedAt) { this.deletedAt = deletedAt; return this; } @@ -72,10 +74,10 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - DeleteSynonymResponse deleteSynonymResponse = (DeleteSynonymResponse) o; + DeletedAtResponse deletedAtResponse = (DeletedAtResponse) o; return ( - Objects.equals(this.taskID, deleteSynonymResponse.taskID) && - Objects.equals(this.deletedAt, deleteSynonymResponse.deletedAt) + Objects.equals(this.taskID, deletedAtResponse.taskID) && + Objects.equals(this.deletedAt, deletedAtResponse.deletedAt) ); } @@ -87,7 +89,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class DeleteSynonymResponse {\n"); + sb.append("class DeletedAtResponse {\n"); sb.append(" taskID: ").append(toIndentedString(taskID)).append("\n"); sb .append(" deletedAt: ") diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DictionaryEntriesResponse.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DictionaryEntriesResponse.java deleted file mode 100644 index 1618f73afb..0000000000 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DictionaryEntriesResponse.java +++ /dev/null @@ -1,111 +0,0 @@ -package com.algolia.model; - -import com.google.gson.annotations.SerializedName; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.time.OffsetDateTime; -import java.util.Objects; - -/** The dictionary entry reponse. */ -@ApiModel(description = "The dictionary entry reponse.") -public class DictionaryEntriesResponse { - - public static final String SERIALIZED_NAME_TASK_ID = "taskId"; - - @SerializedName(SERIALIZED_NAME_TASK_ID) - private Integer taskId; - - public static final String SERIALIZED_NAME_UPDATED_AT = "updatedAt"; - - @SerializedName(SERIALIZED_NAME_UPDATED_AT) - private OffsetDateTime updatedAt; - - public DictionaryEntriesResponse taskId(Integer taskId) { - this.taskId = taskId; - return this; - } - - /** - * taskID of the indexing task to wait for. - * - * @return taskId - */ - @javax.annotation.Nonnull - @ApiModelProperty( - required = true, - value = "taskID of the indexing task to wait for." - ) - public Integer getTaskId() { - return taskId; - } - - public void setTaskId(Integer taskId) { - this.taskId = taskId; - } - - public DictionaryEntriesResponse updatedAt(OffsetDateTime updatedAt) { - this.updatedAt = updatedAt; - return this; - } - - /** - * Date of last update (ISO-8601 format). - * - * @return updatedAt - */ - @javax.annotation.Nonnull - @ApiModelProperty( - required = true, - value = "Date of last update (ISO-8601 format)." - ) - public OffsetDateTime getUpdatedAt() { - return updatedAt; - } - - public void setUpdatedAt(OffsetDateTime updatedAt) { - this.updatedAt = updatedAt; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DictionaryEntriesResponse dictionaryEntriesResponse = (DictionaryEntriesResponse) o; - return ( - Objects.equals(this.taskId, dictionaryEntriesResponse.taskId) && - Objects.equals(this.updatedAt, dictionaryEntriesResponse.updatedAt) - ); - } - - @Override - public int hashCode() { - return Objects.hash(taskId, updatedAt); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DictionaryEntriesResponse {\n"); - sb.append(" taskId: ").append(toIndentedString(taskId)).append("\n"); - sb - .append(" updatedAt: ") - .append(toIndentedString(updatedAt)) - .append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } -} diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/HasPendingMappingsResponse.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/HasPendingMappingsResponse.java deleted file mode 100644 index fa84912716..0000000000 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/HasPendingMappingsResponse.java +++ /dev/null @@ -1,77 +0,0 @@ -package com.algolia.model; - -import com.google.gson.annotations.SerializedName; -import io.swagger.annotations.ApiModelProperty; -import java.time.OffsetDateTime; -import java.util.Objects; - -/** HasPendingMappingsResponse */ -public class HasPendingMappingsResponse { - - public static final String SERIALIZED_NAME_CREATED_AT = "createdAt"; - - @SerializedName(SERIALIZED_NAME_CREATED_AT) - private OffsetDateTime createdAt; - - public HasPendingMappingsResponse createdAt(OffsetDateTime createdAt) { - this.createdAt = createdAt; - return this; - } - - /** - * Date of creation (ISO-8601 format). - * - * @return createdAt - */ - @javax.annotation.Nonnull - @ApiModelProperty( - required = true, - value = "Date of creation (ISO-8601 format)." - ) - public OffsetDateTime getCreatedAt() { - return createdAt; - } - - public void setCreatedAt(OffsetDateTime createdAt) { - this.createdAt = createdAt; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - HasPendingMappingsResponse hasPendingMappingsResponse = (HasPendingMappingsResponse) o; - return Objects.equals(this.createdAt, hasPendingMappingsResponse.createdAt); - } - - @Override - public int hashCode() { - return Objects.hash(createdAt); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class HasPendingMappingsResponse {\n"); - sb - .append(" createdAt: ") - .append(toIndentedString(createdAt)) - .append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } -} diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/OperationIndexResponse.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/OperationIndexResponse.java deleted file mode 100644 index 0a4b6bb252..0000000000 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/OperationIndexResponse.java +++ /dev/null @@ -1,103 +0,0 @@ -package com.algolia.model; - -import com.google.gson.annotations.SerializedName; -import io.swagger.annotations.ApiModelProperty; -import java.time.OffsetDateTime; -import java.util.Objects; - -/** OperationIndexResponse */ -public class OperationIndexResponse { - - public static final String SERIALIZED_NAME_TASK_I_D = "taskID"; - - @SerializedName(SERIALIZED_NAME_TASK_I_D) - private Integer taskID; - - public static final String SERIALIZED_NAME_UPDATED_AT = "updatedAt"; - - @SerializedName(SERIALIZED_NAME_UPDATED_AT) - private OffsetDateTime updatedAt; - - public OperationIndexResponse taskID(Integer taskID) { - this.taskID = taskID; - return this; - } - - /** - * taskID of the indexing task to wait for. - * - * @return taskID - */ - @javax.annotation.Nullable - @ApiModelProperty(value = "taskID of the indexing task to wait for.") - public Integer getTaskID() { - return taskID; - } - - public void setTaskID(Integer taskID) { - this.taskID = taskID; - } - - public OperationIndexResponse updatedAt(OffsetDateTime updatedAt) { - this.updatedAt = updatedAt; - return this; - } - - /** - * Date of last update (ISO-8601 format). - * - * @return updatedAt - */ - @javax.annotation.Nullable - @ApiModelProperty(value = "Date of last update (ISO-8601 format).") - public OffsetDateTime getUpdatedAt() { - return updatedAt; - } - - public void setUpdatedAt(OffsetDateTime updatedAt) { - this.updatedAt = updatedAt; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OperationIndexResponse operationIndexResponse = (OperationIndexResponse) o; - return ( - Objects.equals(this.taskID, operationIndexResponse.taskID) && - Objects.equals(this.updatedAt, operationIndexResponse.updatedAt) - ); - } - - @Override - public int hashCode() { - return Objects.hash(taskID, updatedAt); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OperationIndexResponse {\n"); - sb.append(" taskID: ").append(toIndentedString(taskID)).append("\n"); - sb - .append(" updatedAt: ") - .append(toIndentedString(updatedAt)) - .append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } -} diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/SetSettingsResponse.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/SetSettingsResponse.java deleted file mode 100644 index bdb6ef85d2..0000000000 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/SetSettingsResponse.java +++ /dev/null @@ -1,103 +0,0 @@ -package com.algolia.model; - -import com.google.gson.annotations.SerializedName; -import io.swagger.annotations.ApiModelProperty; -import java.time.OffsetDateTime; -import java.util.Objects; - -/** SetSettingsResponse */ -public class SetSettingsResponse { - - public static final String SERIALIZED_NAME_TASK_I_D = "taskID"; - - @SerializedName(SERIALIZED_NAME_TASK_I_D) - private Integer taskID; - - public static final String SERIALIZED_NAME_UPDATED_AT = "updatedAt"; - - @SerializedName(SERIALIZED_NAME_UPDATED_AT) - private OffsetDateTime updatedAt; - - public SetSettingsResponse taskID(Integer taskID) { - this.taskID = taskID; - return this; - } - - /** - * taskID of the indexing task to wait for. - * - * @return taskID - */ - @javax.annotation.Nullable - @ApiModelProperty(value = "taskID of the indexing task to wait for.") - public Integer getTaskID() { - return taskID; - } - - public void setTaskID(Integer taskID) { - this.taskID = taskID; - } - - public SetSettingsResponse updatedAt(OffsetDateTime updatedAt) { - this.updatedAt = updatedAt; - return this; - } - - /** - * Date of last update (ISO-8601 format). - * - * @return updatedAt - */ - @javax.annotation.Nullable - @ApiModelProperty(value = "Date of last update (ISO-8601 format).") - public OffsetDateTime getUpdatedAt() { - return updatedAt; - } - - public void setUpdatedAt(OffsetDateTime updatedAt) { - this.updatedAt = updatedAt; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - SetSettingsResponse setSettingsResponse = (SetSettingsResponse) o; - return ( - Objects.equals(this.taskID, setSettingsResponse.taskID) && - Objects.equals(this.updatedAt, setSettingsResponse.updatedAt) - ); - } - - @Override - public int hashCode() { - return Objects.hash(taskID, updatedAt); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class SetSettingsResponse {\n"); - sb.append(" taskID: ").append(toIndentedString(taskID)).append("\n"); - sb - .append(" updatedAt: ") - .append(toIndentedString(updatedAt)) - .append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } -} diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/SaveSynonymsResponse.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/UpdatedAtResponse.java similarity index 78% rename from clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/SaveSynonymsResponse.java rename to clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/UpdatedAtResponse.java index f6b8e6da20..fe0fb18ec7 100644 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/SaveSynonymsResponse.java +++ b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/UpdatedAtResponse.java @@ -1,12 +1,16 @@ package com.algolia.model; import com.google.gson.annotations.SerializedName; +import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.time.OffsetDateTime; import java.util.Objects; -/** SaveSynonymsResponse */ -public class SaveSynonymsResponse { +/** The response with a taskID and an updatedAt timestamp. */ +@ApiModel( + description = "The response with a taskID and an updatedAt timestamp." +) +public class UpdatedAtResponse { public static final String SERIALIZED_NAME_TASK_I_D = "taskID"; @@ -18,7 +22,7 @@ public class SaveSynonymsResponse { @SerializedName(SERIALIZED_NAME_UPDATED_AT) private OffsetDateTime updatedAt; - public SaveSynonymsResponse taskID(Integer taskID) { + public UpdatedAtResponse taskID(Integer taskID) { this.taskID = taskID; return this; } @@ -41,7 +45,7 @@ public void setTaskID(Integer taskID) { this.taskID = taskID; } - public SaveSynonymsResponse updatedAt(OffsetDateTime updatedAt) { + public UpdatedAtResponse updatedAt(OffsetDateTime updatedAt) { this.updatedAt = updatedAt; return this; } @@ -72,10 +76,10 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - SaveSynonymsResponse saveSynonymsResponse = (SaveSynonymsResponse) o; + UpdatedAtResponse updatedAtResponse = (UpdatedAtResponse) o; return ( - Objects.equals(this.taskID, saveSynonymsResponse.taskID) && - Objects.equals(this.updatedAt, saveSynonymsResponse.updatedAt) + Objects.equals(this.taskID, updatedAtResponse.taskID) && + Objects.equals(this.updatedAt, updatedAtResponse.updatedAt) ); } @@ -87,7 +91,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class SaveSynonymsResponse {\n"); + sb.append("class UpdatedAtResponse {\n"); sb.append(" taskID: ").append(toIndentedString(taskID)).append("\n"); sb .append(" updatedAt: ") diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/UpdatedRuleResponseWithoutObjectID.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/UpdatedRuleResponseWithoutObjectID.java deleted file mode 100644 index 28d358b98a..0000000000 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/UpdatedRuleResponseWithoutObjectID.java +++ /dev/null @@ -1,114 +0,0 @@ -package com.algolia.model; - -import com.google.gson.annotations.SerializedName; -import io.swagger.annotations.ApiModelProperty; -import java.time.OffsetDateTime; -import java.util.Objects; - -/** UpdatedRuleResponseWithoutObjectID */ -public class UpdatedRuleResponseWithoutObjectID { - - public static final String SERIALIZED_NAME_UPDATED_AT = "updatedAt"; - - @SerializedName(SERIALIZED_NAME_UPDATED_AT) - private OffsetDateTime updatedAt; - - public static final String SERIALIZED_NAME_TASK_I_D = "taskID"; - - @SerializedName(SERIALIZED_NAME_TASK_I_D) - private Integer taskID; - - public UpdatedRuleResponseWithoutObjectID updatedAt( - OffsetDateTime updatedAt - ) { - this.updatedAt = updatedAt; - return this; - } - - /** - * Date of last update (ISO-8601 format). - * - * @return updatedAt - */ - @javax.annotation.Nonnull - @ApiModelProperty( - required = true, - value = "Date of last update (ISO-8601 format)." - ) - public OffsetDateTime getUpdatedAt() { - return updatedAt; - } - - public void setUpdatedAt(OffsetDateTime updatedAt) { - this.updatedAt = updatedAt; - } - - public UpdatedRuleResponseWithoutObjectID taskID(Integer taskID) { - this.taskID = taskID; - return this; - } - - /** - * taskID of the indexing task to wait for. - * - * @return taskID - */ - @javax.annotation.Nonnull - @ApiModelProperty( - required = true, - value = "taskID of the indexing task to wait for." - ) - public Integer getTaskID() { - return taskID; - } - - public void setTaskID(Integer taskID) { - this.taskID = taskID; - } - - @Override - public boolean equals(Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UpdatedRuleResponseWithoutObjectID updatedRuleResponseWithoutObjectID = (UpdatedRuleResponseWithoutObjectID) o; - return ( - Objects.equals( - this.updatedAt, - updatedRuleResponseWithoutObjectID.updatedAt - ) && - Objects.equals(this.taskID, updatedRuleResponseWithoutObjectID.taskID) - ); - } - - @Override - public int hashCode() { - return Objects.hash(updatedAt, taskID); - } - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UpdatedRuleResponseWithoutObjectID {\n"); - sb - .append(" updatedAt: ") - .append(toIndentedString(updatedAt)) - .append("\n"); - sb.append(" taskID: ").append(toIndentedString(taskID)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces (except the first line). - */ - private String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } -} diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/search/SearchApi.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/search/SearchApi.java index f149bdc3d7..7ea519fcd7 100644 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/search/SearchApi.java +++ b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/search/SearchApi.java @@ -7,28 +7,22 @@ import com.algolia.Pair; import com.algolia.model.AddApiKeyResponse; import com.algolia.model.ApiKey; -import com.algolia.model.AppendSourceResponse; import com.algolia.model.AssignUserIdObject; -import com.algolia.model.AssignUserIdResponse; import com.algolia.model.BatchAssignUserIdsObject; -import com.algolia.model.BatchAssignUserIdsResponse; import com.algolia.model.BatchDictionaryEntries; import com.algolia.model.BatchObject; import com.algolia.model.BatchResponse; import com.algolia.model.BrowseRequest; import com.algolia.model.BrowseResponse; -import com.algolia.model.ClearAllSynonymsResponse; +import com.algolia.model.CreatedAtResponse; import com.algolia.model.DeleteApiKeyResponse; -import com.algolia.model.DeleteIndexResponse; import com.algolia.model.DeleteSourceResponse; -import com.algolia.model.DeleteSynonymResponse; -import com.algolia.model.DictionaryEntriesResponse; +import com.algolia.model.DeletedAtResponse; import com.algolia.model.DictionarySettingsRequest; import com.algolia.model.GetDictionarySettingsResponse; import com.algolia.model.GetLogsResponse; import com.algolia.model.GetTaskResponse; import com.algolia.model.GetTopUserIdsResponse; -import com.algolia.model.HasPendingMappingsResponse; import com.algolia.model.IndexSettings; import com.algolia.model.KeyObject; import com.algolia.model.Languages; @@ -39,13 +33,11 @@ import com.algolia.model.MultipleQueriesObject; import com.algolia.model.MultipleQueriesResponse; import com.algolia.model.OperationIndexObject; -import com.algolia.model.OperationIndexResponse; import com.algolia.model.RemoveUserIdResponse; import com.algolia.model.ReplaceSourceResponse; import com.algolia.model.Rule; import com.algolia.model.SaveObjectResponse; import com.algolia.model.SaveSynonymResponse; -import com.algolia.model.SaveSynonymsResponse; import com.algolia.model.SearchDictionaryEntries; import com.algolia.model.SearchForFacetValuesRequest; import com.algolia.model.SearchForFacetValuesResponse; @@ -56,12 +48,11 @@ import com.algolia.model.SearchSynonymsResponse; import com.algolia.model.SearchUserIdsObject; import com.algolia.model.SearchUserIdsResponse; -import com.algolia.model.SetSettingsResponse; import com.algolia.model.Source; import com.algolia.model.SynonymHit; import com.algolia.model.UpdateApiKeyResponse; +import com.algolia.model.UpdatedAtResponse; import com.algolia.model.UpdatedRuleResponse; -import com.algolia.model.UpdatedRuleResponseWithoutObjectID; import com.algolia.model.UserId; import com.google.gson.reflect.TypeToken; import java.lang.reflect.Type; @@ -296,7 +287,7 @@ private okhttp3.Call appendSourceValidateBeforeCall( * Add a single source to the list of allowed sources. * * @param source The source to add. (required) - * @return AppendSourceResponse + * @return CreatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -305,8 +296,8 @@ private okhttp3.Call appendSourceValidateBeforeCall( * 200 OK - * */ - public AppendSourceResponse appendSource(Source source) throws ApiException { - ApiResponse localVarResp = appendSourceWithHttpInfo( + public CreatedAtResponse appendSource(Source source) throws ApiException { + ApiResponse localVarResp = appendSourceWithHttpInfo( source ); return localVarResp.getData(); @@ -316,7 +307,7 @@ public AppendSourceResponse appendSource(Source source) throws ApiException { * Add a single source to the list of allowed sources. * * @param source The source to add. (required) - * @return ApiResponse<AppendSourceResponse> + * @return ApiResponse<CreatedAtResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -325,12 +316,10 @@ public AppendSourceResponse appendSource(Source source) throws ApiException { * 200 OK - * */ - public ApiResponse appendSourceWithHttpInfo( - Source source - ) throws ApiException { + public ApiResponse appendSourceWithHttpInfo(Source source) + throws ApiException { okhttp3.Call localVarCall = appendSourceValidateBeforeCall(source, null); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); return this.execute(localVarCall, localVarReturnType); } @@ -349,14 +338,13 @@ public ApiResponse appendSourceWithHttpInfo( */ public okhttp3.Call appendSourceAsync( Source source, - final ApiCallback _callback + final ApiCallback _callback ) throws ApiException { okhttp3.Call localVarCall = appendSourceValidateBeforeCall( source, _callback ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); this.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -463,7 +451,7 @@ private okhttp3.Call assignUserIdValidateBeforeCall( * * @param xAlgoliaUserID userID to assign. (required) * @param assignUserIdObject (required) - * @return AssignUserIdResponse + * @return CreatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -476,11 +464,11 @@ private okhttp3.Call assignUserIdValidateBeforeCall( * 404 Index not found. - * */ - public AssignUserIdResponse assignUserId( + public CreatedAtResponse assignUserId( Object xAlgoliaUserID, AssignUserIdObject assignUserIdObject ) throws ApiException { - ApiResponse localVarResp = assignUserIdWithHttpInfo( + ApiResponse localVarResp = assignUserIdWithHttpInfo( xAlgoliaUserID, assignUserIdObject ); @@ -495,7 +483,7 @@ public AssignUserIdResponse assignUserId( * * @param xAlgoliaUserID userID to assign. (required) * @param assignUserIdObject (required) - * @return ApiResponse<AssignUserIdResponse> + * @return ApiResponse<CreatedAtResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -508,7 +496,7 @@ public AssignUserIdResponse assignUserId( * 404 Index not found. - * */ - public ApiResponse assignUserIdWithHttpInfo( + public ApiResponse assignUserIdWithHttpInfo( Object xAlgoliaUserID, AssignUserIdObject assignUserIdObject ) throws ApiException { @@ -517,8 +505,7 @@ public ApiResponse assignUserIdWithHttpInfo( assignUserIdObject, null ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); return this.execute(localVarCall, localVarReturnType); } @@ -546,15 +533,14 @@ public ApiResponse assignUserIdWithHttpInfo( public okhttp3.Call assignUserIdAsync( Object xAlgoliaUserID, AssignUserIdObject assignUserIdObject, - final ApiCallback _callback + final ApiCallback _callback ) throws ApiException { okhttp3.Call localVarCall = assignUserIdValidateBeforeCall( xAlgoliaUserID, assignUserIdObject, _callback ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); this.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -840,7 +826,7 @@ private okhttp3.Call batchAssignUserIdsValidateBeforeCall( * * @param xAlgoliaUserID userID to assign. (required) * @param batchAssignUserIdsObject (required) - * @return BatchAssignUserIdsResponse + * @return CreatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -853,11 +839,11 @@ private okhttp3.Call batchAssignUserIdsValidateBeforeCall( * 404 Index not found. - * */ - public BatchAssignUserIdsResponse batchAssignUserIds( + public CreatedAtResponse batchAssignUserIds( Object xAlgoliaUserID, BatchAssignUserIdsObject batchAssignUserIdsObject ) throws ApiException { - ApiResponse localVarResp = batchAssignUserIdsWithHttpInfo( + ApiResponse localVarResp = batchAssignUserIdsWithHttpInfo( xAlgoliaUserID, batchAssignUserIdsObject ); @@ -871,7 +857,7 @@ public BatchAssignUserIdsResponse batchAssignUserIds( * * @param xAlgoliaUserID userID to assign. (required) * @param batchAssignUserIdsObject (required) - * @return ApiResponse<BatchAssignUserIdsResponse> + * @return ApiResponse<CreatedAtResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -884,7 +870,7 @@ public BatchAssignUserIdsResponse batchAssignUserIds( * 404 Index not found. - * */ - public ApiResponse batchAssignUserIdsWithHttpInfo( + public ApiResponse batchAssignUserIdsWithHttpInfo( Object xAlgoliaUserID, BatchAssignUserIdsObject batchAssignUserIdsObject ) throws ApiException { @@ -893,8 +879,7 @@ public ApiResponse batchAssignUserIdsWithHttpInfo( batchAssignUserIdsObject, null ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); return this.execute(localVarCall, localVarReturnType); } @@ -921,15 +906,14 @@ public ApiResponse batchAssignUserIdsWithHttpInfo( public okhttp3.Call batchAssignUserIdsAsync( Object xAlgoliaUserID, BatchAssignUserIdsObject batchAssignUserIdsObject, - final ApiCallback _callback + final ApiCallback _callback ) throws ApiException { okhttp3.Call localVarCall = batchAssignUserIdsValidateBeforeCall( xAlgoliaUserID, batchAssignUserIdsObject, _callback ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); this.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -1033,7 +1017,7 @@ private okhttp3.Call batchDictionaryEntriesValidateBeforeCall( * * @param dictionaryName The dictionary to search in. (required) * @param batchDictionaryEntries (required) - * @return DictionaryEntriesResponse + * @return UpdatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -1046,11 +1030,11 @@ private okhttp3.Call batchDictionaryEntriesValidateBeforeCall( * 404 Index not found. - * */ - public DictionaryEntriesResponse batchDictionaryEntries( + public UpdatedAtResponse batchDictionaryEntries( String dictionaryName, BatchDictionaryEntries batchDictionaryEntries ) throws ApiException { - ApiResponse localVarResp = batchDictionaryEntriesWithHttpInfo( + ApiResponse localVarResp = batchDictionaryEntriesWithHttpInfo( dictionaryName, batchDictionaryEntries ); @@ -1062,7 +1046,7 @@ public DictionaryEntriesResponse batchDictionaryEntries( * * @param dictionaryName The dictionary to search in. (required) * @param batchDictionaryEntries (required) - * @return ApiResponse<DictionaryEntriesResponse> + * @return ApiResponse<UpdatedAtResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -1075,7 +1059,7 @@ public DictionaryEntriesResponse batchDictionaryEntries( * 404 Index not found. - * */ - public ApiResponse batchDictionaryEntriesWithHttpInfo( + public ApiResponse batchDictionaryEntriesWithHttpInfo( String dictionaryName, BatchDictionaryEntries batchDictionaryEntries ) throws ApiException { @@ -1084,8 +1068,7 @@ public ApiResponse batchDictionaryEntriesWithHttpInfo batchDictionaryEntries, null ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); return this.execute(localVarCall, localVarReturnType); } @@ -1110,15 +1093,14 @@ public ApiResponse batchDictionaryEntriesWithHttpInfo public okhttp3.Call batchDictionaryEntriesAsync( String dictionaryName, BatchDictionaryEntries batchDictionaryEntries, - final ApiCallback _callback + final ApiCallback _callback ) throws ApiException { okhttp3.Call localVarCall = batchDictionaryEntriesValidateBeforeCall( dictionaryName, batchDictionaryEntries, _callback ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); this.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -1246,7 +1228,7 @@ private okhttp3.Call batchRulesValidateBeforeCall( * indexName. (optional) * @param clearExistingRules When true, existing Rules are cleared before adding this batch. When * false, existing Rules are kept. (optional) - * @return UpdatedRuleResponseWithoutObjectID + * @return UpdatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -1259,13 +1241,13 @@ private okhttp3.Call batchRulesValidateBeforeCall( * 404 Index not found. - * */ - public UpdatedRuleResponseWithoutObjectID batchRules( + public UpdatedAtResponse batchRules( String indexName, List rule, Boolean forwardToReplicas, Boolean clearExistingRules ) throws ApiException { - ApiResponse localVarResp = batchRulesWithHttpInfo( + ApiResponse localVarResp = batchRulesWithHttpInfo( indexName, rule, forwardToReplicas, @@ -1283,7 +1265,7 @@ public UpdatedRuleResponseWithoutObjectID batchRules( * indexName. (optional) * @param clearExistingRules When true, existing Rules are cleared before adding this batch. When * false, existing Rules are kept. (optional) - * @return ApiResponse<UpdatedRuleResponseWithoutObjectID> + * @return ApiResponse<UpdatedAtResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -1296,7 +1278,7 @@ public UpdatedRuleResponseWithoutObjectID batchRules( * 404 Index not found. - * */ - public ApiResponse batchRulesWithHttpInfo( + public ApiResponse batchRulesWithHttpInfo( String indexName, List rule, Boolean forwardToReplicas, @@ -1309,8 +1291,7 @@ public ApiResponse batchRulesWithHttpInfo( clearExistingRules, null ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); return this.execute(localVarCall, localVarReturnType); } @@ -1341,7 +1322,7 @@ public okhttp3.Call batchRulesAsync( List rule, Boolean forwardToReplicas, Boolean clearExistingRules, - final ApiCallback _callback + final ApiCallback _callback ) throws ApiException { okhttp3.Call localVarCall = batchRulesValidateBeforeCall( indexName, @@ -1350,8 +1331,7 @@ public okhttp3.Call batchRulesAsync( clearExistingRules, _callback ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); this.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -1653,7 +1633,7 @@ private okhttp3.Call clearAllSynonymsValidateBeforeCall( * @param indexName The index in which to perform the request. (required) * @param forwardToReplicas When true, changes are also propagated to replicas of the given * indexName. (optional) - * @return ClearAllSynonymsResponse + * @return UpdatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -1666,11 +1646,11 @@ private okhttp3.Call clearAllSynonymsValidateBeforeCall( * 404 Index not found. - * */ - public ClearAllSynonymsResponse clearAllSynonyms( + public UpdatedAtResponse clearAllSynonyms( String indexName, Boolean forwardToReplicas ) throws ApiException { - ApiResponse localVarResp = clearAllSynonymsWithHttpInfo( + ApiResponse localVarResp = clearAllSynonymsWithHttpInfo( indexName, forwardToReplicas ); @@ -1683,7 +1663,7 @@ public ClearAllSynonymsResponse clearAllSynonyms( * @param indexName The index in which to perform the request. (required) * @param forwardToReplicas When true, changes are also propagated to replicas of the given * indexName. (optional) - * @return ApiResponse<ClearAllSynonymsResponse> + * @return ApiResponse<UpdatedAtResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -1696,7 +1676,7 @@ public ClearAllSynonymsResponse clearAllSynonyms( * 404 Index not found. - * */ - public ApiResponse clearAllSynonymsWithHttpInfo( + public ApiResponse clearAllSynonymsWithHttpInfo( String indexName, Boolean forwardToReplicas ) throws ApiException { @@ -1705,8 +1685,7 @@ public ApiResponse clearAllSynonymsWithHttpInfo( forwardToReplicas, null ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); return this.execute(localVarCall, localVarReturnType); } @@ -1732,15 +1711,14 @@ public ApiResponse clearAllSynonymsWithHttpInfo( public okhttp3.Call clearAllSynonymsAsync( String indexName, Boolean forwardToReplicas, - final ApiCallback _callback + final ApiCallback _callback ) throws ApiException { okhttp3.Call localVarCall = clearAllSynonymsValidateBeforeCall( indexName, forwardToReplicas, _callback ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); this.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -1844,7 +1822,7 @@ private okhttp3.Call clearRulesValidateBeforeCall( * @param indexName The index in which to perform the request. (required) * @param forwardToReplicas When true, changes are also propagated to replicas of the given * indexName. (optional) - * @return UpdatedRuleResponseWithoutObjectID + * @return UpdatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -1857,11 +1835,11 @@ private okhttp3.Call clearRulesValidateBeforeCall( * 404 Index not found. - * */ - public UpdatedRuleResponseWithoutObjectID clearRules( + public UpdatedAtResponse clearRules( String indexName, Boolean forwardToReplicas ) throws ApiException { - ApiResponse localVarResp = clearRulesWithHttpInfo( + ApiResponse localVarResp = clearRulesWithHttpInfo( indexName, forwardToReplicas ); @@ -1874,7 +1852,7 @@ public UpdatedRuleResponseWithoutObjectID clearRules( * @param indexName The index in which to perform the request. (required) * @param forwardToReplicas When true, changes are also propagated to replicas of the given * indexName. (optional) - * @return ApiResponse<UpdatedRuleResponseWithoutObjectID> + * @return ApiResponse<UpdatedAtResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -1887,7 +1865,7 @@ public UpdatedRuleResponseWithoutObjectID clearRules( * 404 Index not found. - * */ - public ApiResponse clearRulesWithHttpInfo( + public ApiResponse clearRulesWithHttpInfo( String indexName, Boolean forwardToReplicas ) throws ApiException { @@ -1896,8 +1874,7 @@ public ApiResponse clearRulesWithHttpInfo( forwardToReplicas, null ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); return this.execute(localVarCall, localVarReturnType); } @@ -1923,15 +1900,14 @@ public ApiResponse clearRulesWithHttpInfo( public okhttp3.Call clearRulesAsync( String indexName, Boolean forwardToReplicas, - final ApiCallback _callback + final ApiCallback _callback ) throws ApiException { okhttp3.Call localVarCall = clearRulesValidateBeforeCall( indexName, forwardToReplicas, _callback ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); this.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -2173,7 +2149,7 @@ private okhttp3.Call deleteIndexValidateBeforeCall( * Delete index. Delete an existing index. * * @param indexName The index in which to perform the request. (required) - * @return DeleteIndexResponse + * @return DeletedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -2186,8 +2162,8 @@ private okhttp3.Call deleteIndexValidateBeforeCall( * 404 Index not found. - * */ - public DeleteIndexResponse deleteIndex(String indexName) throws ApiException { - ApiResponse localVarResp = deleteIndexWithHttpInfo( + public DeletedAtResponse deleteIndex(String indexName) throws ApiException { + ApiResponse localVarResp = deleteIndexWithHttpInfo( indexName ); return localVarResp.getData(); @@ -2197,7 +2173,7 @@ public DeleteIndexResponse deleteIndex(String indexName) throws ApiException { * Delete index. Delete an existing index. * * @param indexName The index in which to perform the request. (required) - * @return ApiResponse<DeleteIndexResponse> + * @return ApiResponse<DeletedAtResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -2210,11 +2186,11 @@ public DeleteIndexResponse deleteIndex(String indexName) throws ApiException { * 404 Index not found. - * */ - public ApiResponse deleteIndexWithHttpInfo( + public ApiResponse deleteIndexWithHttpInfo( String indexName ) throws ApiException { okhttp3.Call localVarCall = deleteIndexValidateBeforeCall(indexName, null); - Type localVarReturnType = new TypeToken() {}.getType(); + Type localVarReturnType = new TypeToken() {}.getType(); return this.execute(localVarCall, localVarReturnType); } @@ -2237,13 +2213,13 @@ public ApiResponse deleteIndexWithHttpInfo( */ public okhttp3.Call deleteIndexAsync( String indexName, - final ApiCallback _callback + final ApiCallback _callback ) throws ApiException { okhttp3.Call localVarCall = deleteIndexValidateBeforeCall( indexName, _callback ); - Type localVarReturnType = new TypeToken() {}.getType(); + Type localVarReturnType = new TypeToken() {}.getType(); this.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -2363,7 +2339,7 @@ private okhttp3.Call deleteRuleValidateBeforeCall( * @param objectID Unique identifier of an object. (required) * @param forwardToReplicas When true, changes are also propagated to replicas of the given * indexName. (optional) - * @return UpdatedRuleResponseWithoutObjectID + * @return UpdatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -2376,12 +2352,12 @@ private okhttp3.Call deleteRuleValidateBeforeCall( * 404 Index not found. - * */ - public UpdatedRuleResponseWithoutObjectID deleteRule( + public UpdatedAtResponse deleteRule( String indexName, String objectID, Boolean forwardToReplicas ) throws ApiException { - ApiResponse localVarResp = deleteRuleWithHttpInfo( + ApiResponse localVarResp = deleteRuleWithHttpInfo( indexName, objectID, forwardToReplicas @@ -2396,7 +2372,7 @@ public UpdatedRuleResponseWithoutObjectID deleteRule( * @param objectID Unique identifier of an object. (required) * @param forwardToReplicas When true, changes are also propagated to replicas of the given * indexName. (optional) - * @return ApiResponse<UpdatedRuleResponseWithoutObjectID> + * @return ApiResponse<UpdatedAtResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -2409,7 +2385,7 @@ public UpdatedRuleResponseWithoutObjectID deleteRule( * 404 Index not found. - * */ - public ApiResponse deleteRuleWithHttpInfo( + public ApiResponse deleteRuleWithHttpInfo( String indexName, String objectID, Boolean forwardToReplicas @@ -2420,8 +2396,7 @@ public ApiResponse deleteRuleWithHttpInfo( forwardToReplicas, null ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); return this.execute(localVarCall, localVarReturnType); } @@ -2449,7 +2424,7 @@ public okhttp3.Call deleteRuleAsync( String indexName, String objectID, Boolean forwardToReplicas, - final ApiCallback _callback + final ApiCallback _callback ) throws ApiException { okhttp3.Call localVarCall = deleteRuleValidateBeforeCall( indexName, @@ -2457,8 +2432,7 @@ public okhttp3.Call deleteRuleAsync( forwardToReplicas, _callback ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); this.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -2722,7 +2696,7 @@ private okhttp3.Call deleteSynonymValidateBeforeCall( * @param objectID Unique identifier of an object. (required) * @param forwardToReplicas When true, changes are also propagated to replicas of the given * indexName. (optional) - * @return DeleteSynonymResponse + * @return DeletedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -2735,12 +2709,12 @@ private okhttp3.Call deleteSynonymValidateBeforeCall( * 404 Index not found. - * */ - public DeleteSynonymResponse deleteSynonym( + public DeletedAtResponse deleteSynonym( String indexName, String objectID, Boolean forwardToReplicas ) throws ApiException { - ApiResponse localVarResp = deleteSynonymWithHttpInfo( + ApiResponse localVarResp = deleteSynonymWithHttpInfo( indexName, objectID, forwardToReplicas @@ -2755,7 +2729,7 @@ public DeleteSynonymResponse deleteSynonym( * @param objectID Unique identifier of an object. (required) * @param forwardToReplicas When true, changes are also propagated to replicas of the given * indexName. (optional) - * @return ApiResponse<DeleteSynonymResponse> + * @return ApiResponse<DeletedAtResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -2768,7 +2742,7 @@ public DeleteSynonymResponse deleteSynonym( * 404 Index not found. - * */ - public ApiResponse deleteSynonymWithHttpInfo( + public ApiResponse deleteSynonymWithHttpInfo( String indexName, String objectID, Boolean forwardToReplicas @@ -2779,8 +2753,7 @@ public ApiResponse deleteSynonymWithHttpInfo( forwardToReplicas, null ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); return this.execute(localVarCall, localVarReturnType); } @@ -2809,7 +2782,7 @@ public okhttp3.Call deleteSynonymAsync( String indexName, String objectID, Boolean forwardToReplicas, - final ApiCallback _callback + final ApiCallback _callback ) throws ApiException { okhttp3.Call localVarCall = deleteSynonymValidateBeforeCall( indexName, @@ -2817,8 +2790,7 @@ public okhttp3.Call deleteSynonymAsync( forwardToReplicas, _callback ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); this.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -4685,7 +4657,7 @@ private okhttp3.Call hasPendingMappingsValidateBeforeCall( * taken into account, and the userIDs are directly usable. * * @param getClusters (optional) - * @return HasPendingMappingsResponse + * @return CreatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -4698,9 +4670,9 @@ private okhttp3.Call hasPendingMappingsValidateBeforeCall( * 404 Index not found. - * */ - public HasPendingMappingsResponse hasPendingMappings(Boolean getClusters) + public CreatedAtResponse hasPendingMappings(Boolean getClusters) throws ApiException { - ApiResponse localVarResp = hasPendingMappingsWithHttpInfo( + ApiResponse localVarResp = hasPendingMappingsWithHttpInfo( getClusters ); return localVarResp.getData(); @@ -4714,7 +4686,7 @@ public HasPendingMappingsResponse hasPendingMappings(Boolean getClusters) * taken into account, and the userIDs are directly usable. * * @param getClusters (optional) - * @return ApiResponse<HasPendingMappingsResponse> + * @return ApiResponse<CreatedAtResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -4727,15 +4699,14 @@ public HasPendingMappingsResponse hasPendingMappings(Boolean getClusters) * 404 Index not found. - * */ - public ApiResponse hasPendingMappingsWithHttpInfo( + public ApiResponse hasPendingMappingsWithHttpInfo( Boolean getClusters ) throws ApiException { okhttp3.Call localVarCall = hasPendingMappingsValidateBeforeCall( getClusters, null ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); return this.execute(localVarCall, localVarReturnType); } @@ -4762,14 +4733,13 @@ public ApiResponse hasPendingMappingsWithHttpInfo( */ public okhttp3.Call hasPendingMappingsAsync( Boolean getClusters, - final ApiCallback _callback + final ApiCallback _callback ) throws ApiException { okhttp3.Call localVarCall = hasPendingMappingsValidateBeforeCall( getClusters, _callback ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); this.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -5652,7 +5622,7 @@ private okhttp3.Call operationIndexValidateBeforeCall( * * @param indexName The index in which to perform the request. (required) * @param operationIndexObject (required) - * @return OperationIndexResponse + * @return UpdatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -5665,11 +5635,11 @@ private okhttp3.Call operationIndexValidateBeforeCall( * 404 Index not found. - * */ - public OperationIndexResponse operationIndex( + public UpdatedAtResponse operationIndex( String indexName, OperationIndexObject operationIndexObject ) throws ApiException { - ApiResponse localVarResp = operationIndexWithHttpInfo( + ApiResponse localVarResp = operationIndexWithHttpInfo( indexName, operationIndexObject ); @@ -5681,7 +5651,7 @@ public OperationIndexResponse operationIndex( * * @param indexName The index in which to perform the request. (required) * @param operationIndexObject (required) - * @return ApiResponse<OperationIndexResponse> + * @return ApiResponse<UpdatedAtResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -5694,7 +5664,7 @@ public OperationIndexResponse operationIndex( * 404 Index not found. - * */ - public ApiResponse operationIndexWithHttpInfo( + public ApiResponse operationIndexWithHttpInfo( String indexName, OperationIndexObject operationIndexObject ) throws ApiException { @@ -5703,8 +5673,7 @@ public ApiResponse operationIndexWithHttpInfo( operationIndexObject, null ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); return this.execute(localVarCall, localVarReturnType); } @@ -5729,15 +5698,14 @@ public ApiResponse operationIndexWithHttpInfo( public okhttp3.Call operationIndexAsync( String indexName, OperationIndexObject operationIndexObject, - final ApiCallback _callback + final ApiCallback _callback ) throws ApiException { okhttp3.Call localVarCall = operationIndexValidateBeforeCall( indexName, operationIndexObject, _callback ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); this.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -6977,7 +6945,7 @@ private okhttp3.Call saveSynonymsValidateBeforeCall( * indexName. (optional) * @param replaceExistingSynonyms Replace all synonyms of the index with the ones sent with this * request. (optional) - * @return SaveSynonymsResponse + * @return UpdatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -6990,13 +6958,13 @@ private okhttp3.Call saveSynonymsValidateBeforeCall( * 404 Index not found. - * */ - public SaveSynonymsResponse saveSynonyms( + public UpdatedAtResponse saveSynonyms( String indexName, List synonymHit, Boolean forwardToReplicas, Boolean replaceExistingSynonyms ) throws ApiException { - ApiResponse localVarResp = saveSynonymsWithHttpInfo( + ApiResponse localVarResp = saveSynonymsWithHttpInfo( indexName, synonymHit, forwardToReplicas, @@ -7015,7 +6983,7 @@ public SaveSynonymsResponse saveSynonyms( * indexName. (optional) * @param replaceExistingSynonyms Replace all synonyms of the index with the ones sent with this * request. (optional) - * @return ApiResponse<SaveSynonymsResponse> + * @return ApiResponse<UpdatedAtResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -7028,7 +6996,7 @@ public SaveSynonymsResponse saveSynonyms( * 404 Index not found. - * */ - public ApiResponse saveSynonymsWithHttpInfo( + public ApiResponse saveSynonymsWithHttpInfo( String indexName, List synonymHit, Boolean forwardToReplicas, @@ -7041,8 +7009,7 @@ public ApiResponse saveSynonymsWithHttpInfo( replaceExistingSynonyms, null ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); return this.execute(localVarCall, localVarReturnType); } @@ -7074,7 +7041,7 @@ public okhttp3.Call saveSynonymsAsync( List synonymHit, Boolean forwardToReplicas, Boolean replaceExistingSynonyms, - final ApiCallback _callback + final ApiCallback _callback ) throws ApiException { okhttp3.Call localVarCall = saveSynonymsValidateBeforeCall( indexName, @@ -7083,8 +7050,7 @@ public okhttp3.Call saveSynonymsAsync( replaceExistingSynonyms, _callback ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); this.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -7367,7 +7333,7 @@ private okhttp3.Call searchDictionaryEntriesValidateBeforeCall( * * @param dictionaryName The dictionary to search in. (required) * @param searchDictionaryEntries (required) - * @return DictionaryEntriesResponse + * @return UpdatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -7380,11 +7346,11 @@ private okhttp3.Call searchDictionaryEntriesValidateBeforeCall( * 404 Index not found. - * */ - public DictionaryEntriesResponse searchDictionaryEntries( + public UpdatedAtResponse searchDictionaryEntries( String dictionaryName, SearchDictionaryEntries searchDictionaryEntries ) throws ApiException { - ApiResponse localVarResp = searchDictionaryEntriesWithHttpInfo( + ApiResponse localVarResp = searchDictionaryEntriesWithHttpInfo( dictionaryName, searchDictionaryEntries ); @@ -7396,7 +7362,7 @@ public DictionaryEntriesResponse searchDictionaryEntries( * * @param dictionaryName The dictionary to search in. (required) * @param searchDictionaryEntries (required) - * @return ApiResponse<DictionaryEntriesResponse> + * @return ApiResponse<UpdatedAtResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -7409,7 +7375,7 @@ public DictionaryEntriesResponse searchDictionaryEntries( * 404 Index not found. - * */ - public ApiResponse searchDictionaryEntriesWithHttpInfo( + public ApiResponse searchDictionaryEntriesWithHttpInfo( String dictionaryName, SearchDictionaryEntries searchDictionaryEntries ) throws ApiException { @@ -7418,8 +7384,7 @@ public ApiResponse searchDictionaryEntriesWithHttpInf searchDictionaryEntries, null ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); return this.execute(localVarCall, localVarReturnType); } @@ -7444,15 +7409,14 @@ public ApiResponse searchDictionaryEntriesWithHttpInf public okhttp3.Call searchDictionaryEntriesAsync( String dictionaryName, SearchDictionaryEntries searchDictionaryEntries, - final ApiCallback _callback + final ApiCallback _callback ) throws ApiException { okhttp3.Call localVarCall = searchDictionaryEntriesValidateBeforeCall( dictionaryName, searchDictionaryEntries, _callback ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); this.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -8371,7 +8335,7 @@ private okhttp3.Call setDictionarySettingsValidateBeforeCall( * Set dictionary settings. Set dictionary settings. * * @param dictionarySettingsRequest (required) - * @return DictionaryEntriesResponse + * @return UpdatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -8384,10 +8348,10 @@ private okhttp3.Call setDictionarySettingsValidateBeforeCall( * 404 Index not found. - * */ - public DictionaryEntriesResponse setDictionarySettings( + public UpdatedAtResponse setDictionarySettings( DictionarySettingsRequest dictionarySettingsRequest ) throws ApiException { - ApiResponse localVarResp = setDictionarySettingsWithHttpInfo( + ApiResponse localVarResp = setDictionarySettingsWithHttpInfo( dictionarySettingsRequest ); return localVarResp.getData(); @@ -8397,7 +8361,7 @@ public DictionaryEntriesResponse setDictionarySettings( * Set dictionary settings. Set dictionary settings. * * @param dictionarySettingsRequest (required) - * @return ApiResponse<DictionaryEntriesResponse> + * @return ApiResponse<UpdatedAtResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -8410,15 +8374,14 @@ public DictionaryEntriesResponse setDictionarySettings( * 404 Index not found. - * */ - public ApiResponse setDictionarySettingsWithHttpInfo( + public ApiResponse setDictionarySettingsWithHttpInfo( DictionarySettingsRequest dictionarySettingsRequest ) throws ApiException { okhttp3.Call localVarCall = setDictionarySettingsValidateBeforeCall( dictionarySettingsRequest, null ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); return this.execute(localVarCall, localVarReturnType); } @@ -8441,14 +8404,13 @@ public ApiResponse setDictionarySettingsWithHttpInfo( */ public okhttp3.Call setDictionarySettingsAsync( DictionarySettingsRequest dictionarySettingsRequest, - final ApiCallback _callback + final ApiCallback _callback ) throws ApiException { okhttp3.Call localVarCall = setDictionarySettingsValidateBeforeCall( dictionarySettingsRequest, _callback ); - Type localVarReturnType = new TypeToken() {} - .getType(); + Type localVarReturnType = new TypeToken() {}.getType(); this.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -8564,7 +8526,7 @@ private okhttp3.Call setSettingsValidateBeforeCall( * @param indexSettings (required) * @param forwardToReplicas When true, changes are also propagated to replicas of the given * indexName. (optional) - * @return SetSettingsResponse + * @return UpdatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -8577,12 +8539,12 @@ private okhttp3.Call setSettingsValidateBeforeCall( * 404 Index not found. - * */ - public SetSettingsResponse setSettings( + public UpdatedAtResponse setSettings( String indexName, IndexSettings indexSettings, Boolean forwardToReplicas ) throws ApiException { - ApiResponse localVarResp = setSettingsWithHttpInfo( + ApiResponse localVarResp = setSettingsWithHttpInfo( indexName, indexSettings, forwardToReplicas @@ -8598,7 +8560,7 @@ public SetSettingsResponse setSettings( * @param indexSettings (required) * @param forwardToReplicas When true, changes are also propagated to replicas of the given * indexName. (optional) - * @return ApiResponse<SetSettingsResponse> + * @return ApiResponse<UpdatedAtResponse> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body * @http.response.details @@ -8611,7 +8573,7 @@ public SetSettingsResponse setSettings( * 404 Index not found. - * */ - public ApiResponse setSettingsWithHttpInfo( + public ApiResponse setSettingsWithHttpInfo( String indexName, IndexSettings indexSettings, Boolean forwardToReplicas @@ -8622,7 +8584,7 @@ public ApiResponse setSettingsWithHttpInfo( forwardToReplicas, null ); - Type localVarReturnType = new TypeToken() {}.getType(); + Type localVarReturnType = new TypeToken() {}.getType(); return this.execute(localVarCall, localVarReturnType); } @@ -8652,7 +8614,7 @@ public okhttp3.Call setSettingsAsync( String indexName, IndexSettings indexSettings, Boolean forwardToReplicas, - final ApiCallback _callback + final ApiCallback _callback ) throws ApiException { okhttp3.Call localVarCall = setSettingsValidateBeforeCall( indexName, @@ -8660,7 +8622,7 @@ public okhttp3.Call setSettingsAsync( forwardToReplicas, _callback ); - Type localVarReturnType = new TypeToken() {}.getType(); + Type localVarReturnType = new TypeToken() {}.getType(); this.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } diff --git a/clients/algoliasearch-client-javascript/client-analytics/model/getClickPositionsResponsePositions.ts b/clients/algoliasearch-client-javascript/client-analytics/model/getClickPositionsResponsePositions.ts index 639a2fafec..f1fb8bbecd 100644 --- a/clients/algoliasearch-client-javascript/client-analytics/model/getClickPositionsResponsePositions.ts +++ b/clients/algoliasearch-client-javascript/client-analytics/model/getClickPositionsResponsePositions.ts @@ -1,6 +1,6 @@ export type GetClickPositionsResponsePositions = { /** - * Range of positions with the following pattern: Positions from 1 to 10 included are displayed in separated groups. Positions from 11 to 20 included are grouped together. Positions from 21 and up are grouped together. + * Range of positions with the following pattern: Positions from 1 to 10 included are displayed in separated groups. Positions from 11 to 20 included are grouped together. Positions from 21 and up are grouped together. */ position: number[]; /** diff --git a/clients/algoliasearch-client-javascript/client-analytics/src/analyticsApi.ts b/clients/algoliasearch-client-javascript/client-analytics/src/analyticsApi.ts index d9b94350a3..751d944917 100644 --- a/clients/algoliasearch-client-javascript/client-analytics/src/analyticsApi.ts +++ b/clients/algoliasearch-client-javascript/client-analytics/src/analyticsApi.ts @@ -101,8 +101,8 @@ export class AnalyticsApi { * * @summary Returns the average click position. * @param index - The index name to target. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. */ getAverageClickPosition( @@ -154,8 +154,8 @@ export class AnalyticsApi { * * @summary Returns the distribution of clicks per range of positions. * @param index - The index name to target. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. */ getClickPositions( @@ -207,8 +207,8 @@ export class AnalyticsApi { * * @summary Returns a click-through rate (CTR). * @param index - The index name to target. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. */ getClickThroughRate( @@ -260,8 +260,8 @@ export class AnalyticsApi { * * @summary Returns a conversion rate (CR). * @param index - The index name to target. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. */ getConversationRate( @@ -313,8 +313,8 @@ export class AnalyticsApi { * * @summary Returns the rate at which searches didn\'t lead to any clicks. * @param index - The index name to target. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. */ getNoClickRate( @@ -366,8 +366,8 @@ export class AnalyticsApi { * * @summary Returns the rate at which searches didn\'t return any results. * @param index - The index name to target. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. */ getNoResultsRate( @@ -419,8 +419,8 @@ export class AnalyticsApi { * * @summary Returns the number of searches across the given time range. * @param index - The index name to target. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. */ getSearchesCount( @@ -472,8 +472,8 @@ export class AnalyticsApi { * * @summary Returns top searches that didn\'t lead to any clicks. * @param index - The index name to target. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param limit - How many items to fetch. * @param offset - From which position to start retrieving results. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. @@ -537,8 +537,8 @@ export class AnalyticsApi { * * @summary Returns top searches that didn\'t return any results. * @param index - The index name to target. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param limit - How many items to fetch. * @param offset - From which position to start retrieving results. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. @@ -635,8 +635,8 @@ export class AnalyticsApi { * * @summary Returns top countries. * @param index - The index name to target. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param limit - How many items to fetch. * @param offset - From which position to start retrieving results. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. @@ -700,8 +700,8 @@ export class AnalyticsApi { * * @summary Returns top filter attributes. * @param index - The index name to target. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param limit - How many items to fetch. * @param offset - From which position to start retrieving results. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. @@ -766,8 +766,8 @@ export class AnalyticsApi { * @summary Returns top filter attributes for a given search. * @param index - The index name to target. * @param search - The query term. Must match the exact user input. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param limit - How many items to fetch. * @param offset - From which position to start retrieving results. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. @@ -842,8 +842,8 @@ export class AnalyticsApi { * @summary Returns top filters for the given attribute. * @param attribute - The exact name of the attribute. * @param index - The index name to target. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param limit - How many items to fetch. * @param offset - From which position to start retrieving results. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. @@ -919,8 +919,8 @@ export class AnalyticsApi { * @param attributes - The exact names of the attributes, separated by commas. * @param index - The index name to target. * @param search - The query term. Must match the exact user input. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param limit - How many items to fetch. * @param offset - From which position to start retrieving results. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. @@ -1000,8 +1000,8 @@ export class AnalyticsApi { * * @summary Returns top filters with no results. * @param index - The index name to target. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param limit - How many items to fetch. * @param offset - From which position to start retrieving results. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. @@ -1066,8 +1066,8 @@ export class AnalyticsApi { * @summary Returns top filters for the given no result search. * @param index - The index name to target. * @param search - The query term. Must match the exact user input. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param limit - How many items to fetch. * @param offset - From which position to start retrieving results. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. @@ -1142,8 +1142,8 @@ export class AnalyticsApi { * @summary Returns top hits. * @param index - The index name to target. * @param clickAnalytics - Whether to include the click-through and conversion rates for a search. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param limit - How many items to fetch. * @param offset - From which position to start retrieving results. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. @@ -1214,8 +1214,8 @@ export class AnalyticsApi { * @param index - The index name to target. * @param search - The query term. Must match the exact user input. * @param clickAnalytics - Whether to include the click-through and conversion rates for a search. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param limit - How many items to fetch. * @param offset - From which position to start retrieving results. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. @@ -1295,8 +1295,8 @@ export class AnalyticsApi { * @summary Returns top searches. * @param index - The index name to target. * @param clickAnalytics - Whether to include the click-through and conversion rates for a search. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param orderBy - Reorder the results. * @param direction - The sorting of the result. * @param limit - How many items to fetch. @@ -1377,8 +1377,8 @@ export class AnalyticsApi { * * @summary Returns the distinct count of users across the given time range. * @param index - The index name to target. - * @param startDate - The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. - * @param endDate - The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. + * @param startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. + * @param endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze. * @param tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. */ getUsersCount( diff --git a/clients/algoliasearch-client-javascript/client-search/model/appendSourceResponse.ts b/clients/algoliasearch-client-javascript/client-search/model/appendSourceResponse.ts deleted file mode 100644 index 698eb57260..0000000000 --- a/clients/algoliasearch-client-javascript/client-search/model/appendSourceResponse.ts +++ /dev/null @@ -1,6 +0,0 @@ -export type AppendSourceResponse = { - /** - * Date of creation (ISO-8601 format). - */ - createdAt: Date; -}; diff --git a/clients/algoliasearch-client-javascript/client-search/model/assignUserIdResponse.ts b/clients/algoliasearch-client-javascript/client-search/model/assignUserIdResponse.ts deleted file mode 100644 index 9323e49396..0000000000 --- a/clients/algoliasearch-client-javascript/client-search/model/assignUserIdResponse.ts +++ /dev/null @@ -1,6 +0,0 @@ -export type AssignUserIdResponse = { - /** - * Date of creation (ISO-8601 format). - */ - createdAt: Date; -}; diff --git a/clients/algoliasearch-client-javascript/client-search/model/batchAssignUserIdsResponse.ts b/clients/algoliasearch-client-javascript/client-search/model/batchAssignUserIdsResponse.ts deleted file mode 100644 index a4e64bda6a..0000000000 --- a/clients/algoliasearch-client-javascript/client-search/model/batchAssignUserIdsResponse.ts +++ /dev/null @@ -1,6 +0,0 @@ -export type BatchAssignUserIdsResponse = { - /** - * Date of creation (ISO-8601 format). - */ - createdAt: Date; -}; diff --git a/clients/algoliasearch-client-javascript/client-search/model/createdAtResponse.ts b/clients/algoliasearch-client-javascript/client-search/model/createdAtResponse.ts new file mode 100644 index 0000000000..ed372bbb72 --- /dev/null +++ b/clients/algoliasearch-client-javascript/client-search/model/createdAtResponse.ts @@ -0,0 +1,9 @@ +/** + * The response with a createdAt timestamp. + */ +export type CreatedAtResponse = { + /** + * Date of creation (ISO-8601 format). + */ + createdAt: Date; +}; diff --git a/clients/algoliasearch-client-javascript/client-search/model/deleteIndexResponse.ts b/clients/algoliasearch-client-javascript/client-search/model/deleteIndexResponse.ts deleted file mode 100644 index b03c54272b..0000000000 --- a/clients/algoliasearch-client-javascript/client-search/model/deleteIndexResponse.ts +++ /dev/null @@ -1,10 +0,0 @@ -export type DeleteIndexResponse = { - /** - * TaskID of the indexing task to wait for. - */ - taskID?: number; - /** - * Date of deletion (ISO-8601 format). - */ - deletedAt?: Date; -}; diff --git a/clients/algoliasearch-client-javascript/client-search/model/deleteSynonymResponse.ts b/clients/algoliasearch-client-javascript/client-search/model/deletedAtResponse.ts similarity index 60% rename from clients/algoliasearch-client-javascript/client-search/model/deleteSynonymResponse.ts rename to clients/algoliasearch-client-javascript/client-search/model/deletedAtResponse.ts index 575406c024..3220c48b17 100644 --- a/clients/algoliasearch-client-javascript/client-search/model/deleteSynonymResponse.ts +++ b/clients/algoliasearch-client-javascript/client-search/model/deletedAtResponse.ts @@ -1,4 +1,7 @@ -export type DeleteSynonymResponse = { +/** + * The response with a taskID and a deletedAt timestamp. + */ +export type DeletedAtResponse = { /** * TaskID of the indexing task to wait for. */ diff --git a/clients/algoliasearch-client-javascript/client-search/model/dictionaryEntriesResponse.ts b/clients/algoliasearch-client-javascript/client-search/model/dictionaryEntriesResponse.ts deleted file mode 100644 index c85e85d827..0000000000 --- a/clients/algoliasearch-client-javascript/client-search/model/dictionaryEntriesResponse.ts +++ /dev/null @@ -1,13 +0,0 @@ -/** - * The dictionary entry reponse. - */ -export type DictionaryEntriesResponse = { - /** - * TaskID of the indexing task to wait for. - */ - taskId: number; - /** - * Date of last update (ISO-8601 format). - */ - updatedAt: Date; -}; diff --git a/clients/algoliasearch-client-javascript/client-search/model/hasPendingMappingsResponse.ts b/clients/algoliasearch-client-javascript/client-search/model/hasPendingMappingsResponse.ts deleted file mode 100644 index 5384d3e819..0000000000 --- a/clients/algoliasearch-client-javascript/client-search/model/hasPendingMappingsResponse.ts +++ /dev/null @@ -1,6 +0,0 @@ -export type HasPendingMappingsResponse = { - /** - * Date of creation (ISO-8601 format). - */ - createdAt: Date; -}; diff --git a/clients/algoliasearch-client-javascript/client-search/model/models.ts b/clients/algoliasearch-client-javascript/client-search/model/models.ts index fd324f9246..8010ce261f 100644 --- a/clients/algoliasearch-client-javascript/client-search/model/models.ts +++ b/clients/algoliasearch-client-javascript/client-search/model/models.ts @@ -4,9 +4,7 @@ import type { RequestOptions } from '../utils/types'; export * from './addApiKeyResponse'; export * from './anchoring'; export * from './apiKey'; -export * from './appendSourceResponse'; export * from './assignUserIdObject'; -export * from './assignUserIdResponse'; export * from './automaticFacetFilter'; export * from './baseBrowseResponse'; export * from './baseIndexSettings'; @@ -14,23 +12,20 @@ export * from './baseSearchParams'; export * from './baseSearchResponse'; export * from './baseSearchResponseFacetsStats'; export * from './batchAssignUserIdsObject'; -export * from './batchAssignUserIdsResponse'; export * from './batchDictionaryEntries'; export * from './batchDictionaryEntriesRequest'; export * from './batchObject'; export * from './batchResponse'; export * from './browseRequest'; export * from './browseResponse'; -export * from './clearAllSynonymsResponse'; export * from './condition'; export * from './consequence'; export * from './consequenceHide'; export * from './createdAtObject'; +export * from './createdAtResponse'; export * from './deleteApiKeyResponse'; -export * from './deleteIndexResponse'; export * from './deleteSourceResponse'; -export * from './deleteSynonymResponse'; -export * from './dictionaryEntriesResponse'; +export * from './deletedAtResponse'; export * from './dictionaryEntry'; export * from './dictionaryLanguage'; export * from './dictionarySettingsRequest'; @@ -41,7 +36,6 @@ export * from './getLogsResponseInnerQueries'; export * from './getLogsResponseLogs'; export * from './getTaskResponse'; export * from './getTopUserIdsResponse'; -export * from './hasPendingMappingsResponse'; export * from './highlightResult'; export * from './index'; export * from './indexSettings'; @@ -57,7 +51,6 @@ export * from './multipleQueriesObject'; export * from './multipleQueriesResponse'; export * from './operation'; export * from './operationIndexObject'; -export * from './operationIndexResponse'; export * from './params'; export * from './promote'; export * from './rankingInfo'; @@ -68,7 +61,6 @@ export * from './replaceSourceResponse'; export * from './rule'; export * from './saveObjectResponse'; export * from './saveSynonymResponse'; -export * from './saveSynonymsResponse'; export * from './searchDictionaryEntries'; export * from './searchForFacetValuesRequest'; export * from './searchForFacetValuesResponse'; @@ -84,7 +76,6 @@ export * from './searchUserIdsObject'; export * from './searchUserIdsResponse'; export * from './searchUserIdsResponseHighlightResult'; export * from './searchUserIdsResponseHits'; -export * from './setSettingsResponse'; export * from './snippetResult'; export * from './source'; export * from './standardEntries'; @@ -92,8 +83,8 @@ export * from './synonymHit'; export * from './synonymHitHighlightResult'; export * from './timeRange'; export * from './updateApiKeyResponse'; +export * from './updatedAtResponse'; export * from './updatedRuleResponse'; -export * from './updatedRuleResponseWithoutObjectID'; export * from './userId'; export interface Authentication { diff --git a/clients/algoliasearch-client-javascript/client-search/model/operationIndexResponse.ts b/clients/algoliasearch-client-javascript/client-search/model/operationIndexResponse.ts deleted file mode 100644 index 974190a4a1..0000000000 --- a/clients/algoliasearch-client-javascript/client-search/model/operationIndexResponse.ts +++ /dev/null @@ -1,10 +0,0 @@ -export type OperationIndexResponse = { - /** - * TaskID of the indexing task to wait for. - */ - taskID?: number; - /** - * Date of last update (ISO-8601 format). - */ - updatedAt?: Date; -}; diff --git a/clients/algoliasearch-client-javascript/client-search/model/saveSynonymsResponse.ts b/clients/algoliasearch-client-javascript/client-search/model/saveSynonymsResponse.ts deleted file mode 100644 index fe37f948a0..0000000000 --- a/clients/algoliasearch-client-javascript/client-search/model/saveSynonymsResponse.ts +++ /dev/null @@ -1,10 +0,0 @@ -export type SaveSynonymsResponse = { - /** - * TaskID of the indexing task to wait for. - */ - taskID: number; - /** - * Date of last update (ISO-8601 format). - */ - updatedAt: Date; -}; diff --git a/clients/algoliasearch-client-javascript/client-search/model/setSettingsResponse.ts b/clients/algoliasearch-client-javascript/client-search/model/setSettingsResponse.ts deleted file mode 100644 index 9b00cdaa0b..0000000000 --- a/clients/algoliasearch-client-javascript/client-search/model/setSettingsResponse.ts +++ /dev/null @@ -1,10 +0,0 @@ -export type SetSettingsResponse = { - /** - * TaskID of the indexing task to wait for. - */ - taskID?: number; - /** - * Date of last update (ISO-8601 format). - */ - updatedAt?: Date; -}; diff --git a/clients/algoliasearch-client-javascript/client-search/model/clearAllSynonymsResponse.ts b/clients/algoliasearch-client-javascript/client-search/model/updatedAtResponse.ts similarity index 60% rename from clients/algoliasearch-client-javascript/client-search/model/clearAllSynonymsResponse.ts rename to clients/algoliasearch-client-javascript/client-search/model/updatedAtResponse.ts index 8dc07e6503..92f9b6d740 100644 --- a/clients/algoliasearch-client-javascript/client-search/model/clearAllSynonymsResponse.ts +++ b/clients/algoliasearch-client-javascript/client-search/model/updatedAtResponse.ts @@ -1,4 +1,7 @@ -export type ClearAllSynonymsResponse = { +/** + * The response with a taskID and an updatedAt timestamp. + */ +export type UpdatedAtResponse = { /** * TaskID of the indexing task to wait for. */ diff --git a/clients/algoliasearch-client-javascript/client-search/model/updatedRuleResponseWithoutObjectID.ts b/clients/algoliasearch-client-javascript/client-search/model/updatedRuleResponseWithoutObjectID.ts deleted file mode 100644 index cb245abbdf..0000000000 --- a/clients/algoliasearch-client-javascript/client-search/model/updatedRuleResponseWithoutObjectID.ts +++ /dev/null @@ -1,10 +0,0 @@ -export type UpdatedRuleResponseWithoutObjectID = { - /** - * Date of last update (ISO-8601 format). - */ - updatedAt: Date; - /** - * TaskID of the indexing task to wait for. - */ - taskID: number; -}; diff --git a/clients/algoliasearch-client-javascript/client-search/src/searchApi.ts b/clients/algoliasearch-client-javascript/client-search/src/searchApi.ts index 3402c747f0..17e084980d 100644 --- a/clients/algoliasearch-client-javascript/client-search/src/searchApi.ts +++ b/clients/algoliasearch-client-javascript/client-search/src/searchApi.ts @@ -1,27 +1,21 @@ import type { AddApiKeyResponse } from '../model/addApiKeyResponse'; import type { ApiKey } from '../model/apiKey'; -import type { AppendSourceResponse } from '../model/appendSourceResponse'; import type { AssignUserIdObject } from '../model/assignUserIdObject'; -import type { AssignUserIdResponse } from '../model/assignUserIdResponse'; import type { BatchAssignUserIdsObject } from '../model/batchAssignUserIdsObject'; -import type { BatchAssignUserIdsResponse } from '../model/batchAssignUserIdsResponse'; import type { BatchDictionaryEntries } from '../model/batchDictionaryEntries'; import type { BatchObject } from '../model/batchObject'; import type { BatchResponse } from '../model/batchResponse'; import type { BrowseRequest } from '../model/browseRequest'; import type { BrowseResponse } from '../model/browseResponse'; -import type { ClearAllSynonymsResponse } from '../model/clearAllSynonymsResponse'; +import type { CreatedAtResponse } from '../model/createdAtResponse'; import type { DeleteApiKeyResponse } from '../model/deleteApiKeyResponse'; -import type { DeleteIndexResponse } from '../model/deleteIndexResponse'; import type { DeleteSourceResponse } from '../model/deleteSourceResponse'; -import type { DeleteSynonymResponse } from '../model/deleteSynonymResponse'; -import type { DictionaryEntriesResponse } from '../model/dictionaryEntriesResponse'; +import type { DeletedAtResponse } from '../model/deletedAtResponse'; import type { DictionarySettingsRequest } from '../model/dictionarySettingsRequest'; import type { GetDictionarySettingsResponse } from '../model/getDictionarySettingsResponse'; import type { GetLogsResponse } from '../model/getLogsResponse'; import type { GetTaskResponse } from '../model/getTaskResponse'; import type { GetTopUserIdsResponse } from '../model/getTopUserIdsResponse'; -import type { HasPendingMappingsResponse } from '../model/hasPendingMappingsResponse'; import type { IndexSettings } from '../model/indexSettings'; import type { KeyObject } from '../model/keyObject'; import type { Languages } from '../model/languages'; @@ -33,13 +27,11 @@ import { ApiKeyAuth } from '../model/models'; import type { MultipleQueriesObject } from '../model/multipleQueriesObject'; import type { MultipleQueriesResponse } from '../model/multipleQueriesResponse'; import type { OperationIndexObject } from '../model/operationIndexObject'; -import type { OperationIndexResponse } from '../model/operationIndexResponse'; import type { RemoveUserIdResponse } from '../model/removeUserIdResponse'; import type { ReplaceSourceResponse } from '../model/replaceSourceResponse'; import type { Rule } from '../model/rule'; import type { SaveObjectResponse } from '../model/saveObjectResponse'; import type { SaveSynonymResponse } from '../model/saveSynonymResponse'; -import type { SaveSynonymsResponse } from '../model/saveSynonymsResponse'; import type { SearchDictionaryEntries } from '../model/searchDictionaryEntries'; import type { SearchForFacetValuesRequest } from '../model/searchForFacetValuesRequest'; import type { SearchForFacetValuesResponse } from '../model/searchForFacetValuesResponse'; @@ -51,12 +43,11 @@ import type { SearchRulesResponse } from '../model/searchRulesResponse'; import type { SearchSynonymsResponse } from '../model/searchSynonymsResponse'; import type { SearchUserIdsObject } from '../model/searchUserIdsObject'; import type { SearchUserIdsResponse } from '../model/searchUserIdsResponse'; -import type { SetSettingsResponse } from '../model/setSettingsResponse'; import type { Source } from '../model/source'; import type { SynonymHit } from '../model/synonymHit'; import type { UpdateApiKeyResponse } from '../model/updateApiKeyResponse'; +import type { UpdatedAtResponse } from '../model/updatedAtResponse'; import type { UpdatedRuleResponse } from '../model/updatedRuleResponse'; -import type { UpdatedRuleResponseWithoutObjectID } from '../model/updatedRuleResponseWithoutObjectID'; import type { UserId } from '../model/userId'; import { Transporter } from '../utils/Transporter'; import { shuffle } from '../utils/helpers'; @@ -188,7 +179,7 @@ export class SearchApi { * * @param source - The source to add. */ - appendSource(source: Source): Promise { + appendSource(source: Source): Promise { const path = '/1/security/sources/append'; const headers: Headers = { Accept: 'application/json' }; const queryParameters: Record = {}; @@ -222,7 +213,7 @@ export class SearchApi { assignUserId( xAlgoliaUserID: Record, assignUserIdObject: AssignUserIdObject - ): Promise { + ): Promise { const path = '/1/clusters/mapping'; const headers: Headers = { Accept: 'application/json' }; const queryParameters: Record = {}; @@ -305,7 +296,7 @@ export class SearchApi { batchAssignUserIds( xAlgoliaUserID: Record, batchAssignUserIdsObject: BatchAssignUserIdsObject - ): Promise { + ): Promise { const path = '/1/clusters/mapping/batch'; const headers: Headers = { Accept: 'application/json' }; const queryParameters: Record = {}; @@ -352,7 +343,7 @@ export class SearchApi { batchDictionaryEntries( dictionaryName: 'compounds' | 'plurals' | 'stopwords', batchDictionaryEntries: BatchDictionaryEntries - ): Promise { + ): Promise { const path = '/1/dictionaries/{dictionaryName}/batch'.replace( '{dictionaryName}', encodeURIComponent(String(dictionaryName)) @@ -402,7 +393,7 @@ export class SearchApi { rule: Rule[], forwardToReplicas?: boolean, clearExistingRules?: boolean - ): Promise { + ): Promise { const path = '/1/indexes/{indexName}/rules/batch'.replace( '{indexName}', encodeURIComponent(String(indexName)) @@ -496,7 +487,7 @@ export class SearchApi { clearAllSynonyms( indexName: string, forwardToReplicas?: boolean - ): Promise { + ): Promise { const path = '/1/indexes/{indexName}/synonyms/clear'.replace( '{indexName}', encodeURIComponent(String(indexName)) @@ -536,7 +527,7 @@ export class SearchApi { clearRules( indexName: string, forwardToReplicas?: boolean - ): Promise { + ): Promise { const path = '/1/indexes/{indexName}/rules/clear'.replace( '{indexName}', encodeURIComponent(String(indexName)) @@ -604,7 +595,7 @@ export class SearchApi { * @summary Delete index. * @param indexName - The index in which to perform the request. */ - deleteIndex(indexName: string): Promise { + deleteIndex(indexName: string): Promise { const path = '/1/indexes/{indexName}'.replace( '{indexName}', encodeURIComponent(String(indexName)) @@ -642,7 +633,7 @@ export class SearchApi { indexName: string, objectID: string, forwardToReplicas?: boolean - ): Promise { + ): Promise { const path = '/1/indexes/{indexName}/rules/{objectID}' .replace('{indexName}', encodeURIComponent(String(indexName))) .replace('{objectID}', encodeURIComponent(String(objectID))); @@ -720,7 +711,7 @@ export class SearchApi { indexName: string, objectID: string, forwardToReplicas?: boolean - ): Promise { + ): Promise { const path = '/1/indexes/{indexName}/synonyms/{objectID}' .replace('{indexName}', encodeURIComponent(String(indexName))) .replace('{objectID}', encodeURIComponent(String(objectID))); @@ -1101,9 +1092,7 @@ export class SearchApi { * @summary Has pending mappings. * @param getClusters - The getClusters. */ - hasPendingMappings( - getClusters?: boolean - ): Promise { + hasPendingMappings(getClusters?: boolean): Promise { const path = '/1/clusters/mapping/pending'; const headers: Headers = { Accept: 'application/json' }; const queryParameters: Record = {}; @@ -1271,7 +1260,7 @@ export class SearchApi { operationIndex( indexName: string, operationIndexObject: OperationIndexObject - ): Promise { + ): Promise { const path = '/1/indexes/{indexName}/operation'.replace( '{indexName}', encodeURIComponent(String(indexName)) @@ -1565,7 +1554,7 @@ export class SearchApi { synonymHit: SynonymHit[], forwardToReplicas?: boolean, replaceExistingSynonyms?: boolean - ): Promise { + ): Promise { const path = '/1/indexes/{indexName}/synonyms/batch'.replace( '{indexName}', encodeURIComponent(String(indexName)) @@ -1662,7 +1651,7 @@ export class SearchApi { searchDictionaryEntries( dictionaryName: 'compounds' | 'plurals' | 'stopwords', searchDictionaryEntries: SearchDictionaryEntries - ): Promise { + ): Promise { const path = '/1/dictionaries/{dictionaryName}/search'.replace( '{dictionaryName}', encodeURIComponent(String(dictionaryName)) @@ -1897,7 +1886,7 @@ export class SearchApi { */ setDictionarySettings( dictionarySettingsRequest: DictionarySettingsRequest - ): Promise { + ): Promise { const path = '/1/dictionaries/*/settings'; const headers: Headers = { Accept: 'application/json' }; const queryParameters: Record = {}; @@ -1935,7 +1924,7 @@ export class SearchApi { indexName: string, indexSettings: IndexSettings, forwardToReplicas?: boolean - ): Promise { + ): Promise { const path = '/1/indexes/{indexName}/settings'.replace( '{indexName}', encodeURIComponent(String(indexName)) diff --git a/clients/algoliasearch-client-javascript/recommend/model/baseSearchParams.ts b/clients/algoliasearch-client-javascript/recommend/model/baseSearchParams.ts index f23907fbe3..57083d9194 100644 --- a/clients/algoliasearch-client-javascript/recommend/model/baseSearchParams.ts +++ b/clients/algoliasearch-client-javascript/recommend/model/baseSearchParams.ts @@ -64,7 +64,7 @@ export type BaseSearchParams = { */ aroundLatLng?: string; /** - * Search for entries around a given location automatically computed from the requester’s IP address. + * Search for entries around a given location automatically computed from the requester\'s IP address. */ aroundLatLngViaIP?: boolean; /** diff --git a/clients/algoliasearch-client-javascript/recommend/model/baseSearchResponse.ts b/clients/algoliasearch-client-javascript/recommend/model/baseSearchResponse.ts index e66b56a7e3..0913c5da60 100644 --- a/clients/algoliasearch-client-javascript/recommend/model/baseSearchResponse.ts +++ b/clients/algoliasearch-client-javascript/recommend/model/baseSearchResponse.ts @@ -46,7 +46,7 @@ export type BaseSearchResponse = { */ index?: string; /** - * Index name used for the query. In the case of an A/B test, the targeted index isn’t always the index used by the query. + * Index name used for the query. In the case of an A/B test, the targeted index isn\'t always the index used by the query. */ indexUsed?: string; /** diff --git a/clients/algoliasearch-client-javascript/recommend/model/indexSettingsAsSearchParams.ts b/clients/algoliasearch-client-javascript/recommend/model/indexSettingsAsSearchParams.ts index 937cd43c07..85cea282b5 100644 --- a/clients/algoliasearch-client-javascript/recommend/model/indexSettingsAsSearchParams.ts +++ b/clients/algoliasearch-client-javascript/recommend/model/indexSettingsAsSearchParams.ts @@ -8,7 +8,7 @@ export type IndexSettingsAsSearchParams = { */ attributesForFaceting?: string[]; /** - * List of attributes that can’t be retrieved at query time. + * List of attributes that can\'t be retrieved at query time. */ unretrievableAttributes?: string[]; /** @@ -28,7 +28,7 @@ export type IndexSettingsAsSearchParams = { */ customRanking?: string[]; /** - * Controls the relevancy threshold below which less relevant results aren’t included in the results. + * Controls the relevancy threshold below which less relevant results aren\'t included in the results. */ relevancyStrictness?: number; /** @@ -72,7 +72,7 @@ export type IndexSettingsAsSearchParams = { */ typoTolerance?: IndexSettingsAsSearchParams.TypoToleranceEnum; /** - * Whether to allow typos on numbers (“numeric tokens”) in the query string. + * Whether to allow typos on numbers (\"numeric tokens\") in the query string. */ allowTyposOnNumericTokens?: boolean; /** @@ -92,7 +92,7 @@ export type IndexSettingsAsSearchParams = { */ removeStopWords?: string; /** - * List of characters that the engine shouldn’t automatically normalize. + * List of characters that the engine shouldn\'t automatically normalize. */ keepDiacriticsOnCharacters?: string; /** @@ -116,7 +116,7 @@ export type IndexSettingsAsSearchParams = { */ queryType?: IndexSettingsAsSearchParams.QueryTypeEnum; /** - * Selects a strategy to remove words from the query when it doesn’t match any hits. + * Selects a strategy to remove words from the query when it doesn\'t match any hits. */ removeWordsIfNoResults?: IndexSettingsAsSearchParams.RemoveWordsIfNoResultsEnum; /** @@ -140,7 +140,7 @@ export type IndexSettingsAsSearchParams = { */ alternativesAsExact?: IndexSettingsAsSearchParams.AlternativesAsExactEnum[]; /** - * Allows you to specify which advanced syntax features are active when ‘advancedSyntax’ is enabled. + * Allows you to specify which advanced syntax features are active when ‘advancedSyntax\' is enabled. */ advancedSyntaxFeatures?: IndexSettingsAsSearchParams.AdvancedSyntaxFeaturesEnum[]; /** @@ -148,7 +148,7 @@ export type IndexSettingsAsSearchParams = { */ distinct?: number; /** - * Whether to take into account an index’s synonyms for a particular search. + * Whether to take into account an index\'s synonyms for a particular search. */ synonyms?: boolean; /** @@ -164,7 +164,7 @@ export type IndexSettingsAsSearchParams = { */ responseFields?: string[]; /** - * Maximum number of facet hits to return during a search for facet values. + * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100. */ maxFacetHits?: number; /** diff --git a/clients/algoliasearch-client-javascript/recommend/model/recommendationRequest.ts b/clients/algoliasearch-client-javascript/recommend/model/recommendationRequest.ts index c403c70be5..b87f44b999 100644 --- a/clients/algoliasearch-client-javascript/recommend/model/recommendationRequest.ts +++ b/clients/algoliasearch-client-javascript/recommend/model/recommendationRequest.ts @@ -19,7 +19,7 @@ export type RecommendationRequest = { */ threshold: number; /** - * The max number of recommendations to retrieve. If it’s set to 0, all the recommendations of the objectID may be returned. + * The max number of recommendations to retrieve. If it\'s set to 0, all the recommendations of the objectID may be returned. */ maxRecommendations?: number; /** diff --git a/package.json b/package.json index e26e18f762..bcd872685e 100644 --- a/package.json +++ b/package.json @@ -26,7 +26,8 @@ "playground:js:personalization": "yarn workspace javascript-playground start:personalization", "playground:js:recommend": "yarn workspace javascript-playground start:recommend", "playground:js:search": "yarn workspace javascript-playground start:search", - "specs:format": "yarn prettier --write specs" + "specs:format": "yarn prettier --write specs", + "specs:lint": "eslint --ext=yml specs/ .github/" }, "devDependencies": { "@openapitools/openapi-generator-cli": "2.4.18", @@ -42,6 +43,7 @@ "eslint-plugin-jsdoc": "37.1.0", "eslint-plugin-prettier": "4.0.0", "eslint-plugin-unused-imports": "2.0.0", + "eslint-plugin-yml": "0.12.0", "json": "11.0.0", "prettier": "2.5.0", "prettier-plugin-java": "1.6.0", diff --git a/specs/abtesting/paths/abtest.yml b/specs/abtesting/paths/abtest.yml index 4a95117692..dd6df7bf20 100644 --- a/specs/abtesting/paths/abtest.yml +++ b/specs/abtesting/paths/abtest.yml @@ -1,2 +1,2 @@ -get: -delete: +# get: +# delete: diff --git a/specs/abtesting/paths/abtests.yml b/specs/abtesting/paths/abtests.yml index 9791372547..f687ddeb1f 100644 --- a/specs/abtesting/paths/abtests.yml +++ b/specs/abtesting/paths/abtests.yml @@ -1,2 +1,2 @@ -post: -get: +# post: +# get: diff --git a/specs/abtesting/paths/stopAbTest.yml b/specs/abtesting/paths/stopAbTest.yml index 6adb517bf4..bf62725b88 100644 --- a/specs/abtesting/paths/stopAbTest.yml +++ b/specs/abtesting/paths/stopAbTest.yml @@ -1 +1 @@ -post: +# post: diff --git a/specs/abtesting/spec.yml b/specs/abtesting/spec.yml index b36adac061..91e0f82b4f 100644 --- a/specs/abtesting/spec.yml +++ b/specs/abtesting/spec.yml @@ -1,21 +1,21 @@ -openapi: 3.0.2 -info: - title: A/B Testing API - description: API powering the A/B Testing feature of Algolia. - version: 0.0.1 -components: - securitySchemes: - appId: - $ref: '../common/securitySchemes.yml#/appId' - apiKey: - $ref: '../common/securitySchemes.yml#/apiKey' -security: - - appId: [] - apiKey: [] -paths: - /2/abtests: - $ref: './paths/abtests.yml' -# /2/abtests/{id}: -# $ref: './paths/abtest.yml' -# /2/abtests/{id}/stop: -# $ref: './paths/stopAbTest.yml' +# openapi: 3.0.2 +# info: +# title: A/B Testing API +# description: API powering the A/B Testing feature of Algolia. +# version: 0.0.1 +# components: +# securitySchemes: +# appId: +# $ref: '../common/securitySchemes.yml#/appId' +# apiKey: +# $ref: '../common/securitySchemes.yml#/apiKey' +# security: +# - appId: [] +# apiKey: [] +# paths: +# /2/abtests: +# $ref: paths/abtests.yml +# /2/abtests/{id}: +# $ref: 'paths/abtest.yml' +# /2/abtests/{id}/stop: +# $ref: 'paths/stopAbTest.yml' diff --git a/specs/analytics/paths/click/getAverageClickPosition.yml b/specs/analytics/paths/click/getAverageClickPosition.yml index f30f554f45..ed6ce8d382 100644 --- a/specs/analytics/paths/click/getAverageClickPosition.yml +++ b/specs/analytics/paths/click/getAverageClickPosition.yml @@ -45,10 +45,10 @@ get: date: $ref: '../common/parameters.yml#/date' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/click/getClickPositions.yml b/specs/analytics/paths/click/getClickPositions.yml index f7d444120d..81937ce87a 100644 --- a/specs/analytics/paths/click/getClickPositions.yml +++ b/specs/analytics/paths/click/getClickPositions.yml @@ -34,7 +34,7 @@ get: - clickCount properties: position: - description: | + description: > Range of positions with the following pattern: Positions from 1 to 10 included are displayed in separated groups. @@ -46,10 +46,10 @@ get: clickCount: $ref: '../common/parameters.yml#/clickCount' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/click/getClickThroughRate.yml b/specs/analytics/paths/click/getClickThroughRate.yml index cbba6c80af..eec7a29f51 100644 --- a/specs/analytics/paths/click/getClickThroughRate.yml +++ b/specs/analytics/paths/click/getClickThroughRate.yml @@ -51,10 +51,10 @@ get: date: $ref: '../common/parameters.yml#/date' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/click/getConversionRate.yml b/specs/analytics/paths/click/getConversionRate.yml index 9ae6d3b69d..9cf8b51990 100644 --- a/specs/analytics/paths/click/getConversionRate.yml +++ b/specs/analytics/paths/click/getConversionRate.yml @@ -51,10 +51,10 @@ get: date: $ref: '../common/parameters.yml#/date' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/common/parameters.yml b/specs/analytics/paths/common/parameters.yml index 7a4b51ec63..15b02a5fbe 100644 --- a/specs/analytics/paths/common/parameters.yml +++ b/specs/analytics/paths/common/parameters.yml @@ -14,7 +14,7 @@ OrderBy: description: Reorder the results. schema: enum: [searchCount, clickThroughRate, conversionRate, averageClickPosition] - default: 'searchCount' + default: searchCount Direction: in: query @@ -22,7 +22,7 @@ Direction: description: The sorting of the result. schema: enum: [asc, desc] - default: 'asc' + default: asc ClickAnalytics: in: query diff --git a/specs/analytics/paths/search/getNoClickRate.yml b/specs/analytics/paths/search/getNoClickRate.yml index 4f22268c30..e7c3d1684f 100644 --- a/specs/analytics/paths/search/getNoClickRate.yml +++ b/specs/analytics/paths/search/getNoClickRate.yml @@ -51,10 +51,10 @@ get: date: $ref: '../common/parameters.yml#/date' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/search/getNoResultsRate.yml b/specs/analytics/paths/search/getNoResultsRate.yml index 8d296b5299..218702f5b5 100644 --- a/specs/analytics/paths/search/getNoResultsRate.yml +++ b/specs/analytics/paths/search/getNoResultsRate.yml @@ -51,10 +51,10 @@ get: rate: $ref: '../common/parameters.yml#/rate' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/search/getSearchAttributesTopFilters.yml b/specs/analytics/paths/search/getSearchAttributesTopFilters.yml index 704196afee..2dbe813d59 100644 --- a/specs/analytics/paths/search/getSearchAttributesTopFilters.yml +++ b/specs/analytics/paths/search/getSearchAttributesTopFilters.yml @@ -54,10 +54,10 @@ get: value: $ref: '../common/parameters.yml#/value' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/search/getSearchesCount.yml b/specs/analytics/paths/search/getSearchesCount.yml index b32486050d..b538ad4a9b 100644 --- a/specs/analytics/paths/search/getSearchesCount.yml +++ b/specs/analytics/paths/search/getSearchesCount.yml @@ -39,10 +39,10 @@ get: count: $ref: '../common/parameters.yml#/count' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/search/getSearchesNoClicks.yml b/specs/analytics/paths/search/getSearchesNoClicks.yml index 9d85431889..a0f02af567 100644 --- a/specs/analytics/paths/search/getSearchesNoClicks.yml +++ b/specs/analytics/paths/search/getSearchesNoClicks.yml @@ -41,10 +41,10 @@ get: withFilterCount: $ref: '../common/parameters.yml#/count' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/search/getSearchesNoResults.yml b/specs/analytics/paths/search/getSearchesNoResults.yml index 99a672a051..2dd8148f92 100644 --- a/specs/analytics/paths/search/getSearchesNoResults.yml +++ b/specs/analytics/paths/search/getSearchesNoResults.yml @@ -41,10 +41,10 @@ get: nbHits: $ref: '../common/parameters.yml#/nbHits' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/search/getTopCountries.yml b/specs/analytics/paths/search/getTopCountries.yml index a534cfd36d..352a0fead7 100644 --- a/specs/analytics/paths/search/getTopCountries.yml +++ b/specs/analytics/paths/search/getTopCountries.yml @@ -39,10 +39,10 @@ get: count: $ref: '../common/parameters.yml#/count' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/search/getTopFilterAttributes.yml b/specs/analytics/paths/search/getTopFilterAttributes.yml index 340fc201de..226d54638d 100644 --- a/specs/analytics/paths/search/getTopFilterAttributes.yml +++ b/specs/analytics/paths/search/getTopFilterAttributes.yml @@ -19,10 +19,10 @@ get: schema: $ref: '../common/schemas/getTopFilterAttributes.yml#/getTopFilterAttributesResponse' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/search/getTopFilterAttributesForSearch.yml b/specs/analytics/paths/search/getTopFilterAttributesForSearch.yml index 4e17faf84a..71073a7f27 100644 --- a/specs/analytics/paths/search/getTopFilterAttributesForSearch.yml +++ b/specs/analytics/paths/search/getTopFilterAttributesForSearch.yml @@ -20,10 +20,10 @@ get: schema: $ref: '../common/schemas/getTopFilterAttributes.yml#/getTopFilterAttributesResponse' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/search/getTopFilterForAttribute.yml b/specs/analytics/paths/search/getTopFilterForAttribute.yml index af79b7fef0..dce6dd8306 100644 --- a/specs/analytics/paths/search/getTopFilterForAttribute.yml +++ b/specs/analytics/paths/search/getTopFilterForAttribute.yml @@ -20,10 +20,10 @@ get: schema: $ref: '../common/schemas/getTopFilterForAttribute.yml#/getTopFilterForAttributeResponse' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/search/getTopFiltersForAttributesSearch.yml b/specs/analytics/paths/search/getTopFiltersForAttributesSearch.yml index 06e3ad7b20..26f7cc00f6 100644 --- a/specs/analytics/paths/search/getTopFiltersForAttributesSearch.yml +++ b/specs/analytics/paths/search/getTopFiltersForAttributesSearch.yml @@ -26,10 +26,10 @@ get: schema: $ref: '../common/schemas/getTopFilterForAttribute.yml#/getTopFilterForAttributeResponse' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/search/getTopFiltersNoResults.yml b/specs/analytics/paths/search/getTopFiltersNoResults.yml index a33b70ff90..232c984035 100644 --- a/specs/analytics/paths/search/getTopFiltersNoResults.yml +++ b/specs/analytics/paths/search/getTopFiltersNoResults.yml @@ -19,10 +19,10 @@ get: schema: $ref: '../common/schemas/getTopFiltersNoResults.yml#/getTopFiltersNoResultsResponse' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/search/getTopFiltersNoResultsForSearch.yml b/specs/analytics/paths/search/getTopFiltersNoResultsForSearch.yml index adb433a211..e6f7e768f5 100644 --- a/specs/analytics/paths/search/getTopFiltersNoResultsForSearch.yml +++ b/specs/analytics/paths/search/getTopFiltersNoResultsForSearch.yml @@ -20,10 +20,10 @@ get: schema: $ref: '../common/schemas/getTopFiltersNoResults.yml#/getTopFiltersNoResultsResponse' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/search/getTopHits.yml b/specs/analytics/paths/search/getTopHits.yml index 9772ac391c..ce6b8af451 100644 --- a/specs/analytics/paths/search/getTopHits.yml +++ b/specs/analytics/paths/search/getTopHits.yml @@ -22,10 +22,10 @@ get: - $ref: '../common/schemas/getTopHits.yml#/getTopHitsResponse' - $ref: '../common/schemas/getTopHits.yml#/getTopHitsResponseWithAnalytics' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/search/getTopHitsForSearch.yml b/specs/analytics/paths/search/getTopHitsForSearch.yml index 393217b069..a96d68a62e 100644 --- a/specs/analytics/paths/search/getTopHitsForSearch.yml +++ b/specs/analytics/paths/search/getTopHitsForSearch.yml @@ -23,10 +23,10 @@ get: - $ref: '../common/schemas/getTopHits.yml#/getTopHitsResponse' - $ref: '../common/schemas/getTopHits.yml#/getTopHitsResponseWithAnalytics' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/search/getTopSearches.yml b/specs/analytics/paths/search/getTopSearches.yml index d22c1e7d55..bbe1824576 100644 --- a/specs/analytics/paths/search/getTopSearches.yml +++ b/specs/analytics/paths/search/getTopSearches.yml @@ -24,10 +24,10 @@ get: - $ref: '../common/schemas/getTopSearches.yml#/getTopSearchesResponse' - $ref: '../common/schemas/getTopSearches.yml#/getTopSearchesResponseWithAnalytics' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/search/getUsersCount.yml b/specs/analytics/paths/search/getUsersCount.yml index 95872f055f..660a9e327f 100644 --- a/specs/analytics/paths/search/getUsersCount.yml +++ b/specs/analytics/paths/search/getUsersCount.yml @@ -39,10 +39,10 @@ get: count: $ref: '../common/parameters.yml#/count' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/paths/status/getStatus.yml b/specs/analytics/paths/status/getStatus.yml index e14b9b34cf..5430138643 100644 --- a/specs/analytics/paths/status/getStatus.yml +++ b/specs/analytics/paths/status/getStatus.yml @@ -21,10 +21,10 @@ get: updatedAt: $ref: '../common/parameters.yml#/updatedAt' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/analytics/spec.yml b/specs/analytics/spec.yml index 84997696c3..08bf1f40b0 100644 --- a/specs/analytics/spec.yml +++ b/specs/analytics/spec.yml @@ -17,52 +17,52 @@ paths: # ### Search Analytics Endpoints ### # ################################## /2/searches: - $ref: './paths/search/getTopSearches.yml' + $ref: paths/search/getTopSearches.yml /2/searches/count: - $ref: './paths/search/getSearchesCount.yml' + $ref: paths/search/getSearchesCount.yml /2/searches/noResults: - $ref: './paths/search/getSearchesNoResults.yml' + $ref: paths/search/getSearchesNoResults.yml /2/searches/noClicks: - $ref: './paths/search/getSearchesNoClicks.yml' + $ref: paths/search/getSearchesNoClicks.yml /2/searches/noResultRate: - $ref: './paths/search/getNoResultsRate.yml' + $ref: paths/search/getNoResultsRate.yml /2/searches/noClickRate: - $ref: './paths/search/getNoClickRate.yml' + $ref: paths/search/getNoClickRate.yml /2/hits: - $ref: './paths/search/getTopHits.yml' + $ref: paths/search/getTopHits.yml /2/hits?search={search}: - $ref: './paths/search/getTopHitsForSearch.yml' + $ref: paths/search/getTopHitsForSearch.yml /2/users/count: - $ref: './paths/search/getUsersCount.yml' + $ref: paths/search/getUsersCount.yml /2/filters: - $ref: './paths/search/getTopFilterAttributes.yml' + $ref: paths/search/getTopFilterAttributes.yml /2/filters/{attribute}: - $ref: './paths/search/getTopFilterForAttribute.yml' + $ref: paths/search/getTopFilterForAttribute.yml /2/filters?search={search}: - $ref: './paths/search/getTopFilterAttributesForSearch.yml' + $ref: paths/search/getTopFilterAttributesForSearch.yml /2/filters/noResults: - $ref: './paths/search/getTopFiltersNoResults.yml' + $ref: paths/search/getTopFiltersNoResults.yml /2/filters/noResults?search={search}: - $ref: './paths/search/getTopFiltersNoResultsForSearch.yml' + $ref: paths/search/getTopFiltersNoResultsForSearch.yml /2/filters/{attributes}?search={search}: - $ref: './paths/search/getTopFiltersForAttributesSearch.yml' + $ref: paths/search/getTopFiltersForAttributesSearch.yml /2/countries: - $ref: './paths/search/getTopCountries.yml' + $ref: paths/search/getTopCountries.yml # ################################# # ### Click Analytics Endpoints ### # ################################# /2/clicks/averageClickPosition: - $ref: './paths/click/getAverageClickPosition.yml' + $ref: paths/click/getAverageClickPosition.yml /2/clicks/positions: - $ref: './paths/click/getClickPositions.yml' + $ref: paths/click/getClickPositions.yml /2/clicks/clickThroughRate: - $ref: './paths/click/getClickThroughRate.yml' + $ref: paths/click/getClickThroughRate.yml /2/conversions/conversionRate: - $ref: './paths/click/getConversionRate.yml' + $ref: paths/click/getConversionRate.yml # ######################## # ### Status Endpoints ### # ######################## /2/status: - $ref: './paths/status/getStatus.yml' + $ref: paths/status/getStatus.yml diff --git a/specs/common/parameters.yml b/specs/common/parameters.yml index 1ff4c59264..4b4fc9721c 100644 --- a/specs/common/parameters.yml +++ b/specs/common/parameters.yml @@ -6,7 +6,7 @@ IndexName: required: true schema: type: string - example: 'myIndexName' + example: myIndexName ObjectID: name: objectID diff --git a/specs/common/responses/BadRequest.yml b/specs/common/responses/BadRequest.yml index 967c45cf2b..c5834771f7 100644 --- a/specs/common/responses/BadRequest.yml +++ b/specs/common/responses/BadRequest.yml @@ -2,4 +2,4 @@ description: Bad request or request arguments. content: application/json: schema: - $ref: '../schemas/ErrorBase.yml' + $ref: ../schemas/ErrorBase.yml diff --git a/specs/common/responses/CreatedAt.yml b/specs/common/responses/CreatedAt.yml new file mode 100644 index 0000000000..a22546d6fe --- /dev/null +++ b/specs/common/responses/CreatedAt.yml @@ -0,0 +1,13 @@ +description: OK +content: + application/json: + schema: + title: createdAtResponse + description: The response with a createdAt timestamp. + additionalProperties: false + type: object + required: + - createdAt + properties: + createdAt: + $ref: '../parameters.yml#/createdAt' diff --git a/specs/common/responses/DeletedAt.yml b/specs/common/responses/DeletedAt.yml new file mode 100644 index 0000000000..84da4c2a88 --- /dev/null +++ b/specs/common/responses/DeletedAt.yml @@ -0,0 +1,16 @@ +description: OK +content: + application/json: + schema: + title: deletedAtResponse + description: The response with a taskID and a deletedAt timestamp. + additionalProperties: false + type: object + required: + - taskID + - deletedAt + properties: + taskID: + $ref: '../parameters.yml#/taskID' + deletedAt: + $ref: '../parameters.yml#/deletedAt' diff --git a/specs/common/responses/FeatureNotEnabled.yml b/specs/common/responses/FeatureNotEnabled.yml index e71a76794b..a3b9dcf296 100644 --- a/specs/common/responses/FeatureNotEnabled.yml +++ b/specs/common/responses/FeatureNotEnabled.yml @@ -2,4 +2,4 @@ description: This feature is not enabled on your Algolia account. content: application/json: schema: - $ref: '../schemas/ErrorBase.yml' + $ref: ../schemas/ErrorBase.yml diff --git a/specs/common/responses/IndexNotFound.yml b/specs/common/responses/IndexNotFound.yml index 8071b9d086..9f85d072eb 100644 --- a/specs/common/responses/IndexNotFound.yml +++ b/specs/common/responses/IndexNotFound.yml @@ -2,4 +2,4 @@ description: Index not found. content: application/json: schema: - $ref: '../schemas/ErrorBase.yml' + $ref: ../schemas/ErrorBase.yml diff --git a/specs/common/responses/MethodNotAllowed.yml b/specs/common/responses/MethodNotAllowed.yml index 2515ad2f0c..4ece611047 100644 --- a/specs/common/responses/MethodNotAllowed.yml +++ b/specs/common/responses/MethodNotAllowed.yml @@ -2,4 +2,4 @@ description: Method not allowed with this API key. content: application/json: schema: - $ref: '../schemas/ErrorBase.yml' + $ref: ../schemas/ErrorBase.yml diff --git a/specs/common/responses/UpdatedAt.yml b/specs/common/responses/UpdatedAt.yml new file mode 100644 index 0000000000..2331f06aaa --- /dev/null +++ b/specs/common/responses/UpdatedAt.yml @@ -0,0 +1,16 @@ +description: OK +content: + application/json: + schema: + title: updatedAtResponse + description: The response with a taskID and an updatedAt timestamp. + additionalProperties: false + type: object + required: + - taskID + - updatedAt + properties: + taskID: + $ref: '../parameters.yml#/taskID' + updatedAt: + $ref: '../parameters.yml#/updatedAt' diff --git a/specs/common/schemas/ErrorBase.yml b/specs/common/schemas/ErrorBase.yml index 7ddaf15960..7fa8e49656 100644 --- a/specs/common/schemas/ErrorBase.yml +++ b/specs/common/schemas/ErrorBase.yml @@ -4,4 +4,4 @@ additionalProperties: true properties: message: type: string - example: 'Invalid Application-Id or API-Key' + example: Invalid Application-Id or API-Key diff --git a/specs/insights/paths/pushEvents.yml b/specs/insights/paths/pushEvents.yml index 6adb517bf4..bf62725b88 100644 --- a/specs/insights/paths/pushEvents.yml +++ b/specs/insights/paths/pushEvents.yml @@ -1 +1 @@ -post: +# post: diff --git a/specs/insights/spec.yml b/specs/insights/spec.yml index 93735e369d..4b362a7eb1 100644 --- a/specs/insights/spec.yml +++ b/specs/insights/spec.yml @@ -1,17 +1,17 @@ -openapi: 3.0.2 -info: - title: Insights API - description: API powering the Insights feature of Algolia. - version: 0.0.1 -components: - securitySchemes: - appId: - $ref: '../common/securitySchemes.yml#/appId' - apiKey: - $ref: '../common/securitySchemes.yml#/apiKey' -security: - - appId: [] - apiKey: [] -paths: - /1/events: - $ref: './paths/pushEvents.yml' +# openapi: 3.0.2 +# info: +# title: Insights API +# description: API powering the Insights feature of Algolia. +# version: 0.0.1 +# components: +# securitySchemes: +# appId: +# $ref: '../common/securitySchemes.yml#/appId' +# apiKey: +# $ref: '../common/securitySchemes.yml#/apiKey' +# security: +# - appId: [] +# apiKey: [] +# paths: +# /1/events: +# $ref: paths/pushEvents.yml diff --git a/specs/personalization/paths/deleteUserProfile.yml b/specs/personalization/paths/deleteUserProfile.yml index b284bb552f..c4067a0422 100644 --- a/specs/personalization/paths/deleteUserProfile.yml +++ b/specs/personalization/paths/deleteUserProfile.yml @@ -26,10 +26,10 @@ delete: format: date-time description: A date until which the data can safely be considered as deleted for the given user. Any data received after the deletedUntil date will start building a new user profile. '400': - $ref: '../../common/responses/BadRequest.yml' + $ref: ../../common/responses/BadRequest.yml '402': - $ref: '../../common/responses/FeatureNotEnabled.yml' + $ref: ../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../common/responses/MethodNotAllowed.yml' + $ref: ../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../common/responses/IndexNotFound.yml' + $ref: ../../common/responses/IndexNotFound.yml diff --git a/specs/personalization/paths/getUserTokenProfile.yml b/specs/personalization/paths/getUserTokenProfile.yml index aebad2a565..689401b2e4 100644 --- a/specs/personalization/paths/getUserTokenProfile.yml +++ b/specs/personalization/paths/getUserTokenProfile.yml @@ -31,10 +31,10 @@ get: additionalProperties: true description: The userToken scores. '400': - $ref: '../../common/responses/BadRequest.yml' + $ref: ../../common/responses/BadRequest.yml '402': - $ref: '../../common/responses/FeatureNotEnabled.yml' + $ref: ../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../common/responses/MethodNotAllowed.yml' + $ref: ../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../common/responses/IndexNotFound.yml' + $ref: ../../common/responses/IndexNotFound.yml diff --git a/specs/personalization/paths/personalizationStrategy.yml b/specs/personalization/paths/personalizationStrategy.yml index d158cdb674..f41b66e22d 100644 --- a/specs/personalization/paths/personalizationStrategy.yml +++ b/specs/personalization/paths/personalizationStrategy.yml @@ -26,13 +26,13 @@ post: type: string description: A message confirming the strategy update. '400': - $ref: '../../common/responses/BadRequest.yml' + $ref: ../../common/responses/BadRequest.yml '402': - $ref: '../../common/responses/FeatureNotEnabled.yml' + $ref: ../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../common/responses/MethodNotAllowed.yml' + $ref: ../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../common/responses/IndexNotFound.yml' + $ref: ../../common/responses/IndexNotFound.yml get: tags: - personalization @@ -47,10 +47,10 @@ get: schema: $ref: '../common/schemas/personalizationStrategy.yml#/personalizationStrategyObject' '400': - $ref: '../../common/responses/BadRequest.yml' + $ref: ../../common/responses/BadRequest.yml '402': - $ref: '../../common/responses/FeatureNotEnabled.yml' + $ref: ../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../common/responses/MethodNotAllowed.yml' + $ref: ../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../common/responses/IndexNotFound.yml' + $ref: ../../common/responses/IndexNotFound.yml diff --git a/specs/personalization/spec.yml b/specs/personalization/spec.yml index 0459865f2f..dabc47b59f 100644 --- a/specs/personalization/spec.yml +++ b/specs/personalization/spec.yml @@ -14,8 +14,8 @@ security: apiKey: [] paths: /1/profiles/personalization/{userToken}: - $ref: './paths/getUserTokenProfile.yml' + $ref: paths/getUserTokenProfile.yml /1/profiles/{userToken}: - $ref: './paths/deleteUserProfile.yml' + $ref: paths/deleteUserProfile.yml /1/strategies/personalization: - $ref: './paths/personalizationStrategy.yml' + $ref: paths/personalizationStrategy.yml diff --git a/specs/query_suggestions/paths/getConfigurationStatus.yml b/specs/query_suggestions/paths/getConfigurationStatus.yml index 3ddb9d7f54..01e867a0c4 100644 --- a/specs/query_suggestions/paths/getConfigurationStatus.yml +++ b/specs/query_suggestions/paths/getConfigurationStatus.yml @@ -1 +1 @@ -get: +# get: diff --git a/specs/query_suggestions/paths/getLogFile.yml b/specs/query_suggestions/paths/getLogFile.yml index 3ddb9d7f54..01e867a0c4 100644 --- a/specs/query_suggestions/paths/getLogFile.yml +++ b/specs/query_suggestions/paths/getLogFile.yml @@ -1 +1 @@ -get: +# get: diff --git a/specs/query_suggestions/paths/qsConfig.yml b/specs/query_suggestions/paths/qsConfig.yml index 4428e7d0ea..9c17774007 100644 --- a/specs/query_suggestions/paths/qsConfig.yml +++ b/specs/query_suggestions/paths/qsConfig.yml @@ -1,3 +1,3 @@ -put: -delete: -get: +# put: +# delete: +# get: diff --git a/specs/query_suggestions/paths/qsConfigs.yml b/specs/query_suggestions/paths/qsConfigs.yml index 9791372547..f687ddeb1f 100644 --- a/specs/query_suggestions/paths/qsConfigs.yml +++ b/specs/query_suggestions/paths/qsConfigs.yml @@ -1,2 +1,2 @@ -post: -get: +# post: +# get: diff --git a/specs/query_suggestions/spec.yml b/specs/query_suggestions/spec.yml index 5aaa34a1c8..5afa2da29c 100644 --- a/specs/query_suggestions/spec.yml +++ b/specs/query_suggestions/spec.yml @@ -1,23 +1,23 @@ -openapi: 3.0.2 -info: - title: Query Suggestions API - description: API powering the Query Suggestions feature of Algolia. - version: 0.0.1 -components: - securitySchemes: - appId: - $ref: '../common/securitySchemes.yml#/appId' - apiKey: - $ref: '../common/securitySchemes.yml#/apiKey' -security: - - appId: [] - apiKey: [] -paths: - /1/configs: - $ref: './paths/qsConfigs.yml' +# openapi: 3.0.2 +# info: +# title: Query Suggestions API +# description: API powering the Query Suggestions feature of Algolia. +# version: 0.0.1 +# components: +# securitySchemes: +# appId: +# $ref: '../common/securitySchemes.yml#/appId' +# apiKey: +# $ref: '../common/securitySchemes.yml#/apiKey' +# security: +# - appId: [] +# apiKey: [] +# paths: +# /1/configs: +# $ref: paths/qsConfigs.yml # /1/configs/{indexName}: -# $ref: './paths/qsConfig.yml' +# $ref: 'paths/qsConfig.yml' # /1/configs/{indexName}/status: -# $ref: './paths/getConfigurationStatus.yml' +# $ref: 'paths/getConfigurationStatus.yml' # /1/logs/{indexName}: -# $ref: './paths/getLogFile.yml' +# $ref: 'paths/getLogFile.yml' diff --git a/specs/recommend/paths/getRecommendations.yml b/specs/recommend/paths/getRecommendations.yml index 5670341a83..5c006603cf 100644 --- a/specs/recommend/paths/getRecommendations.yml +++ b/specs/recommend/paths/getRecommendations.yml @@ -27,7 +27,7 @@ post: model: description: The recommendation model to use. type: string - enum: ['related-products', 'bought-together'] + enum: [related-products, bought-together] threshold: type: integer minimum: 0 @@ -69,10 +69,10 @@ post: items: $ref: '../common/schemas/RecommendationsResponse.yml#/recommendationsResponse' '400': - $ref: '../../common/responses/BadRequest.yml' + $ref: ../../common/responses/BadRequest.yml '402': - $ref: '../../common/responses/FeatureNotEnabled.yml' + $ref: ../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../common/responses/MethodNotAllowed.yml' + $ref: ../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../common/responses/IndexNotFound.yml' + $ref: ../../common/responses/IndexNotFound.yml diff --git a/specs/recommend/spec.yml b/specs/recommend/spec.yml index 2bd22fc63f..3200a16c9e 100644 --- a/specs/recommend/spec.yml +++ b/specs/recommend/spec.yml @@ -14,4 +14,4 @@ security: apiKey: [] paths: /1/indexes/*/recommendations: - $ref: './paths/getRecommendations.yml' + $ref: paths/getRecommendations.yml diff --git a/specs/search/common/schemas/Cluster.yml b/specs/search/common/schemas/Cluster.yml index c3e2c0ca10..6bdb706098 100644 --- a/specs/search/common/schemas/Cluster.yml +++ b/specs/search/common/schemas/Cluster.yml @@ -31,4 +31,4 @@ dataSize: clusterName: type: string description: Name of the cluster. - example: 'c11-test' + example: c11-test diff --git a/specs/search/common/schemas/IndexSettings.yml b/specs/search/common/schemas/IndexSettings.yml index 58843183da..c0065735fa 100644 --- a/specs/search/common/schemas/IndexSettings.yml +++ b/specs/search/common/schemas/IndexSettings.yml @@ -112,14 +112,14 @@ indexSettingsAsSearchParams: type: string description: Controls how Algolia should sort your results. default: - - 'typo' - - 'geo' - - 'words' - - 'filters' - - 'proximity' - - 'attribute' - - 'exact' - - 'custom' + - typo + - geo + - words + - filters + - proximity + - attribute + - exact + - custom customRanking: type: array items: @@ -144,15 +144,15 @@ indexSettingsAsSearchParams: highlightPreTag: type: string description: The HTML string to insert before the highlighted parts in all highlight and snippet results. - default: '' + default: highlightPostTag: type: string description: The HTML string to insert after the highlighted parts in all highlight and snippet results. - default: '' + default: snippetEllipsisText: type: string description: String used as an ellipsis indicator when a snippet is truncated. - default: '…' + default: … restrictHighlightAndSnippetArrays: type: boolean description: Restrict highlighting and snippeting to items that matched the query. @@ -169,7 +169,7 @@ indexSettingsAsSearchParams: default: 8 typoTolerance: type: string - enum: [true, false, 'min', 'strict'] + enum: [true, false, min, strict] description: Controls whether typo tolerance is enabled and how it is applied. default: true allowTyposOnNumericTokens: @@ -218,14 +218,14 @@ indexSettingsAsSearchParams: default: false queryType: type: string - enum: ['prefixLast', 'prefixAll', 'prefixNone'] + enum: [prefixLast, prefixAll, prefixNone] description: Controls if and how query words are interpreted as prefixes. - default: 'prefixLast' + default: prefixLast removeWordsIfNoResults: type: string - enum: ['none', 'lastWords', 'firstWords', 'allOptional'] + enum: [none, lastWords, firstWords, allOptional] description: Selects a strategy to remove words from the query when it doesn't match any hits. - default: 'none' + default: none advancedSyntax: type: boolean description: Enables the advanced query syntax. @@ -244,23 +244,23 @@ indexSettingsAsSearchParams: default: [] exactOnSingleWordQuery: type: string - enum: ['attribute', 'none', 'word'] + enum: [attribute, none, word] description: Controls how the exact ranking criterion is computed when the query contains only one word. - default: 'attribute' + default: attribute alternativesAsExact: type: array items: type: string - enum: ['ignorePlurals', 'singleWordSynonym', 'multiWordsSynonym'] + enum: [ignorePlurals, singleWordSynonym, multiWordsSynonym] description: List of alternatives that should be considered an exact match by the exact ranking criterion. - default: ['ignorePlurals', 'singleWordSynonym'] + default: [ignorePlurals, singleWordSynonym] advancedSyntaxFeatures: type: array items: type: string - enum: ['exactPhrase', 'excludeWords'] + enum: [exactPhrase, excludeWords] description: Allows you to specify which advanced syntax features are active when ‘advancedSyntax' is enabled. - default: ['exactPhrase', 'excludeWords'] + default: [exactPhrase, excludeWords] distinct: type: integer minimum: 0 diff --git a/specs/search/common/schemas/Record.yml b/specs/search/common/schemas/Record.yml index 7c6cf6d953..022da56133 100644 --- a/specs/search/common/schemas/Record.yml +++ b/specs/search/common/schemas/Record.yml @@ -103,4 +103,4 @@ rankingInfo: highlightedValue: type: string description: Markup text with occurrences highlighted. - example: 'George Clooney' + example: George Clooney diff --git a/specs/search/common/schemas/RequestOptions.yml b/specs/search/common/schemas/RequestOptions.yml index 69762ce3bf..c47a3accd3 100644 --- a/specs/search/common/schemas/RequestOptions.yml +++ b/specs/search/common/schemas/RequestOptions.yml @@ -1,20 +1,18 @@ -# Not used yet - # timeouts: # type: object # additionalProperties: false # properties: # connect: # type: integer -# description: 'Connection timeout in seconds.' +# description: Connection timeout in seconds. # example: 2 # read: # type: integer -# description: 'Read timeout in seconds.' +# description: Read timeout in seconds. # example: 5 # write: # type: integer -# description: 'Write timeout in seconds.' +# description: Write timeout in seconds. # example: 30 # X-Algolia-UserToken: diff --git a/specs/search/common/schemas/SearchParams.yml b/specs/search/common/schemas/SearchParams.yml index 8f283e9505..607370f7fb 100644 --- a/specs/search/common/schemas/SearchParams.yml +++ b/specs/search/common/schemas/SearchParams.yml @@ -65,7 +65,7 @@ baseSearchParams: sortFacetValuesBy: type: string description: Controls how facet values are fetched. - default: 'count' + default: count page: $ref: '#/page' offset: @@ -184,4 +184,4 @@ page: cursor: type: string description: Cursor indicating the location to resume browsing from. Must match the value returned by the previous call. - example: 'jMDY3M2MwM2QwMWUxMmQwYWI0ZTN' + example: jMDY3M2MwM2QwMWUxMmQwYWI0ZTN diff --git a/specs/search/common/schemas/UserId.yml b/specs/search/common/schemas/UserId.yml index e8bae554d7..ab9e8e2442 100644 --- a/specs/search/common/schemas/UserId.yml +++ b/specs/search/common/schemas/UserId.yml @@ -6,11 +6,11 @@ userId: userID: type: string description: userID of the user. - example: 'user1' + example: user1 clusterName: type: string description: Cluster on which the user is assigned. - example: 'c1-test' + example: c1-test nbRecords: type: integer description: Number of records belonging to the user. diff --git a/specs/search/paths/advanced/getLogs.yml b/specs/search/paths/advanced/getLogs.yml index 1c63c0a68b..9e141f26b2 100644 --- a/specs/search/paths/advanced/getLogs.yml +++ b/specs/search/paths/advanced/getLogs.yml @@ -118,10 +118,10 @@ get: - nb_api_calls - processing_time_ms '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/advanced/getTask.yml b/specs/search/paths/advanced/getTask.yml index 66fa348d39..150b07c081 100644 --- a/specs/search/paths/advanced/getTask.yml +++ b/specs/search/paths/advanced/getTask.yml @@ -28,10 +28,10 @@ get: required: - status '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/dictionaries/batchDictionaryEntries.yml b/specs/search/paths/dictionaries/batchDictionaryEntries.yml index bfb95c1fb8..d6b6fa8b42 100644 --- a/specs/search/paths/dictionaries/batchDictionaryEntries.yml +++ b/specs/search/paths/dictionaries/batchDictionaryEntries.yml @@ -36,21 +36,17 @@ post: action: description: Actions to perform. type: string - enum: ['addEntry', 'deleteEntry'] + enum: [addEntry, deleteEntry] body: - $ref: './common/schemas/SearchDictionaryEntriesResponse.yml#/dictionaryEntry' + $ref: 'common/schemas/SearchDictionaryEntriesResponse.yml#/dictionaryEntry' responses: '200': - description: OK - content: - application/json: - schema: - $ref: './common/schemas/DictionaryEntriesResponse.yml#/dictionaryEntriesResponse' + $ref: ../../../common/responses/UpdatedAt.yml '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/dictionaries/common/parameters.yml b/specs/search/paths/dictionaries/common/parameters.yml index 0202337708..626febc030 100644 --- a/specs/search/paths/dictionaries/common/parameters.yml +++ b/specs/search/paths/dictionaries/common/parameters.yml @@ -5,7 +5,7 @@ DictionaryName: description: The dictionary to search in. required: true schema: - enum: ['plurals', 'stopwords', 'compounds'] + enum: [plurals, stopwords, compounds] type: string # misc diff --git a/specs/search/paths/dictionaries/common/schemas/DictionaryEntriesResponse.yml b/specs/search/paths/dictionaries/common/schemas/DictionaryEntriesResponse.yml deleted file mode 100644 index 4027ef57e9..0000000000 --- a/specs/search/paths/dictionaries/common/schemas/DictionaryEntriesResponse.yml +++ /dev/null @@ -1,12 +0,0 @@ -dictionaryEntriesResponse: - description: The dictionary entry reponse. - additionalProperties: false - type: object - required: - - updatedAt - - taskId - properties: - taskId: - $ref: '../../../../../common/parameters.yml#/taskID' - updatedAt: - $ref: '../../../../../common/parameters.yml#/updatedAt' diff --git a/specs/search/paths/dictionaries/common/schemas/SearchDictionaryEntriesResponse.yml b/specs/search/paths/dictionaries/common/schemas/SearchDictionaryEntriesResponse.yml index df2d133121..682e13a1ba 100644 --- a/specs/search/paths/dictionaries/common/schemas/SearchDictionaryEntriesResponse.yml +++ b/specs/search/paths/dictionaries/common/schemas/SearchDictionaryEntriesResponse.yml @@ -43,5 +43,5 @@ dictionaryEntry: state: description: The state of the dictionary entry. type: string - enum: ['enabled', 'disabled'] + enum: [enabled, disabled] default: enabled diff --git a/specs/search/paths/dictionaries/dictionarySettings.yml b/specs/search/paths/dictionaries/dictionarySettings.yml index 934dfa1c0b..60dcd1ea0b 100644 --- a/specs/search/paths/dictionaries/dictionarySettings.yml +++ b/specs/search/paths/dictionaries/dictionarySettings.yml @@ -3,7 +3,7 @@ put: - search operationId: setDictionarySettings description: Set dictionary settings. - summary: 'Set dictionary settings.' + summary: Set dictionary settings. requestBody: required: true content: @@ -20,26 +20,22 @@ put: $ref: 'common/parameters.yml#/standardEntries' responses: '200': - description: OK - content: - application/json: - schema: - $ref: './common/schemas/DictionaryEntriesResponse.yml#/dictionaryEntriesResponse' + $ref: ../../../common/responses/UpdatedAt.yml '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml get: tags: - search operationId: getDictionarySettings description: Retrieve dictionaries settings. - summary: 'Retrieve dictionaries settings. The API stores languages whose standard entries are disabled. Fetch settings does not return false values.' + summary: Retrieve dictionaries settings. The API stores languages whose standard entries are disabled. Fetch settings does not return false values. responses: '200': description: OK @@ -55,10 +51,10 @@ get: disableStandardEntries: $ref: 'common/parameters.yml#/standardEntries' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/dictionaries/getDictionaryLanguages.yml b/specs/search/paths/dictionaries/getDictionaryLanguages.yml index df18e1ac7b..f480dbcc90 100644 --- a/specs/search/paths/dictionaries/getDictionaryLanguages.yml +++ b/specs/search/paths/dictionaries/getDictionaryLanguages.yml @@ -13,12 +13,12 @@ get: title: getDictionaryLanguagesResponse type: object additionalProperties: - $ref: './common/schemas/Languages.yml#/languages' + $ref: 'common/schemas/Languages.yml#/languages' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/dictionaries/searchDictionaryEntries.yml b/specs/search/paths/dictionaries/searchDictionaryEntries.yml index 7d17e1c530..82c2872bec 100644 --- a/specs/search/paths/dictionaries/searchDictionaryEntries.yml +++ b/specs/search/paths/dictionaries/searchDictionaryEntries.yml @@ -26,19 +26,14 @@ post: $ref: '../../common/schemas/IndexSettings.yml#/hitsPerPage' language: $ref: 'common/parameters.yml#/language' - responses: '200': - description: OK - content: - application/json: - schema: - $ref: './common/schemas/DictionaryEntriesResponse.yml#/dictionaryEntriesResponse' + $ref: ../../../common/responses/UpdatedAt.yml '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/keys/common/parameters.yml b/specs/search/paths/keys/common/parameters.yml index c74e1f51ca..be5505567e 100644 --- a/specs/search/paths/keys/common/parameters.yml +++ b/specs/search/paths/keys/common/parameters.yml @@ -4,5 +4,5 @@ KeyString: required: true schema: type: string - example: 'myAPIKey' + example: myAPIKey description: API Key string. diff --git a/specs/search/paths/keys/common/schemas.yml b/specs/search/paths/keys/common/schemas.yml index 6c06e41a4b..db5070043a 100644 --- a/specs/search/paths/keys/common/schemas.yml +++ b/specs/search/paths/keys/common/schemas.yml @@ -10,22 +10,21 @@ apiKey: items: type: string enum: - [ - 'addObject', - 'analytics', - 'browse', - 'deleteObject', - 'deleteIndex', - 'editSettings', - 'listIndexes', - 'logs', - 'personalization', - 'recommendation', - 'search', - 'seeUnretrievableAttributes', - 'settings', - 'usage', - ] + - addObject + - analytics + - browse + - deleteObject + - deleteIndex + - editSettings + - listIndexes + - logs + - personalization + - recommendation + - search + - seeUnretrievableAttributes + - settings + - usage + description: type: string description: A comment used to identify a key more easily in the dashboard. It is not interpreted by the API. diff --git a/specs/search/paths/keys/key.yml b/specs/search/paths/keys/key.yml index d36c3968db..18679d4102 100644 --- a/specs/search/paths/keys/key.yml +++ b/specs/search/paths/keys/key.yml @@ -30,13 +30,13 @@ put: updatedAt: $ref: '../../../common/parameters.yml#/updatedAt' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml get: tags: @@ -52,15 +52,15 @@ get: content: application/json: schema: - $ref: './common/schemas.yml#/keyObject' + $ref: 'common/schemas.yml#/keyObject' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml delete: tags: @@ -85,10 +85,10 @@ delete: deletedAt: $ref: '../../../common/parameters.yml#/deletedAt' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/keys/keys.yml b/specs/search/paths/keys/keys.yml index 256e89a655..bc10b68b22 100644 --- a/specs/search/paths/keys/keys.yml +++ b/specs/search/paths/keys/keys.yml @@ -18,13 +18,13 @@ post: schema: $ref: 'common/schemas.yml#/addApiKeyResponse' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml get: tags: @@ -50,10 +50,10 @@ get: items: $ref: 'common/schemas.yml#/keyObject' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/keys/restoreApiKey.yml b/specs/search/paths/keys/restoreApiKey.yml index 4725874430..3c0b7e5644 100644 --- a/specs/search/paths/keys/restoreApiKey.yml +++ b/specs/search/paths/keys/restoreApiKey.yml @@ -12,12 +12,12 @@ post: content: application/json: schema: - $ref: './common/schemas.yml#/addApiKeyResponse' + $ref: 'common/schemas.yml#/addApiKeyResponse' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/manage_indices/listIndices.yml b/specs/search/paths/manage_indices/listIndices.yml index 82bf651070..f1b1029667 100644 --- a/specs/search/paths/manage_indices/listIndices.yml +++ b/specs/search/paths/manage_indices/listIndices.yml @@ -14,10 +14,10 @@ get: schema: $ref: '../../common/schemas/listIndicesResponse.yml#/listIndicesResponse' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/manage_indices/operationIndex.yml b/specs/search/paths/manage_indices/operationIndex.yml index e293bd1557..cf44603afa 100644 --- a/specs/search/paths/manage_indices/operationIndex.yml +++ b/specs/search/paths/manage_indices/operationIndex.yml @@ -17,7 +17,7 @@ post: properties: operation: type: string - enum: ['move', 'copy'] + enum: [move, copy] description: Type of operation to perform (move or copy). destination: $ref: '../../../common/parameters.yml#/indexName' @@ -25,30 +25,19 @@ post: type: array items: type: string - enum: ['settings', 'synonyms', 'rules'] + enum: [settings, synonyms, rules] description: Scope of the data to copy. When absent, a full copy is performed. When present, only the selected scopes are copied. required: - operation - destination responses: '200': - description: OK - content: - application/json: - schema: - title: operationIndexResponse - type: object - additionalProperties: false - properties: - taskID: - $ref: '../../../common/parameters.yml#/taskID' - updatedAt: - $ref: '../../../common/parameters.yml#/updatedAt' + $ref: ../../../common/responses/UpdatedAt.yml '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/multiclusters/batchAssignUserIds.yml b/specs/search/paths/multiclusters/batchAssignUserIds.yml index d689d1c2d5..68620b8296 100644 --- a/specs/search/paths/multiclusters/batchAssignUserIds.yml +++ b/specs/search/paths/multiclusters/batchAssignUserIds.yml @@ -33,23 +33,12 @@ post: - users responses: '200': - description: OK - content: - application/json: - schema: - title: batchAssignUserIdsResponse - type: object - additionalProperties: false - properties: - createdAt: - $ref: '../../../common/parameters.yml#/createdAt' - required: - - createdAt + $ref: ../../../common/responses/CreatedAt.yml '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/multiclusters/getTopUserIds.yml b/specs/search/paths/multiclusters/getTopUserIds.yml index cfa1385257..ec082f1d7f 100644 --- a/specs/search/paths/multiclusters/getTopUserIds.yml +++ b/specs/search/paths/multiclusters/getTopUserIds.yml @@ -31,10 +31,10 @@ get: required: - topUsers '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/multiclusters/hasPendingMappings.yml b/specs/search/paths/multiclusters/hasPendingMappings.yml index 40e1148eb6..b073c8e80c 100644 --- a/specs/search/paths/multiclusters/hasPendingMappings.yml +++ b/specs/search/paths/multiclusters/hasPendingMappings.yml @@ -18,23 +18,12 @@ get: type: boolean responses: '200': - description: OK - content: - application/json: - schema: - title: hasPendingMappingsResponse - type: object - additionalProperties: false - properties: - createdAt: - $ref: '../../../common/parameters.yml#/createdAt' - required: - - createdAt + $ref: ../../../common/responses/CreatedAt.yml '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/multiclusters/listClusters.yml b/specs/search/paths/multiclusters/listClusters.yml index 15ac3659c9..1c935bbddc 100644 --- a/specs/search/paths/multiclusters/listClusters.yml +++ b/specs/search/paths/multiclusters/listClusters.yml @@ -25,10 +25,10 @@ get: required: - topUsers '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/multiclusters/searchUserIds.yml b/specs/search/paths/multiclusters/searchUserIds.yml index b3691484ef..57b9bbdcf2 100644 --- a/specs/search/paths/multiclusters/searchUserIds.yml +++ b/specs/search/paths/multiclusters/searchUserIds.yml @@ -91,10 +91,10 @@ post: - hitsPerPage - updatedAt '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/multiclusters/userId.yml b/specs/search/paths/multiclusters/userId.yml index 0decb9d217..2829a3799e 100644 --- a/specs/search/paths/multiclusters/userId.yml +++ b/specs/search/paths/multiclusters/userId.yml @@ -19,13 +19,13 @@ get: schema: $ref: '../../common/schemas/UserId.yml#/userId' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml delete: tags: @@ -53,10 +53,10 @@ delete: required: - deletedAt '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/multiclusters/userIds.yml b/specs/search/paths/multiclusters/userIds.yml index 8051935040..6cf1388a91 100644 --- a/specs/search/paths/multiclusters/userIds.yml +++ b/specs/search/paths/multiclusters/userIds.yml @@ -29,26 +29,15 @@ post: - cluster responses: '200': - description: OK - content: - application/json: - schema: - title: assignUserIdResponse - type: object - additionalProperties: false - properties: - createdAt: - $ref: '../../../common/parameters.yml#/createdAt' - required: - - createdAt + $ref: ../../../common/responses/CreatedAt.yml '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml get: tags: @@ -82,10 +71,10 @@ get: required: - userIDs '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/objects/batch.yml b/specs/search/paths/objects/batch.yml index 5ae3148e0f..60960f5c8d 100644 --- a/specs/search/paths/objects/batch.yml +++ b/specs/search/paths/objects/batch.yml @@ -25,13 +25,13 @@ post: action: type: string enum: - - 'addObject' - - 'updateObject' - - 'partialUpdateObject' - - 'partialUpdateObjectNoCreate' - - 'deleteObject' - - 'delete' - - 'clear' + - addObject + - updateObject + - partialUpdateObject + - partialUpdateObjectNoCreate + - deleteObject + - delete + - clear description: type of operation. body: type: object @@ -53,10 +53,10 @@ post: objectIDs: $ref: '../../../common/parameters.yml#/objectIDs' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/objects/clearObjects.yml b/specs/search/paths/objects/clearObjects.yml index 6adb517bf4..bf62725b88 100644 --- a/specs/search/paths/objects/clearObjects.yml +++ b/specs/search/paths/objects/clearObjects.yml @@ -1 +1 @@ -post: +# post: diff --git a/specs/search/paths/objects/deleteBy.yml b/specs/search/paths/objects/deleteBy.yml index 6adb517bf4..bf62725b88 100644 --- a/specs/search/paths/objects/deleteBy.yml +++ b/specs/search/paths/objects/deleteBy.yml @@ -1 +1 @@ -post: +# post: diff --git a/specs/search/paths/objects/getObject.yml b/specs/search/paths/objects/getObject.yml index 3ddb9d7f54..01e867a0c4 100644 --- a/specs/search/paths/objects/getObject.yml +++ b/specs/search/paths/objects/getObject.yml @@ -1 +1 @@ -get: +# get: diff --git a/specs/search/paths/objects/multipleBatch.yml b/specs/search/paths/objects/multipleBatch.yml index 6adb517bf4..bf62725b88 100644 --- a/specs/search/paths/objects/multipleBatch.yml +++ b/specs/search/paths/objects/multipleBatch.yml @@ -1 +1 @@ -post: +# post: diff --git a/specs/search/paths/objects/multipleGetObjects.yml b/specs/search/paths/objects/multipleGetObjects.yml index 6adb517bf4..bf62725b88 100644 --- a/specs/search/paths/objects/multipleGetObjects.yml +++ b/specs/search/paths/objects/multipleGetObjects.yml @@ -1 +1 @@ -post: +# post: diff --git a/specs/search/paths/objects/object.yml b/specs/search/paths/objects/object.yml index 240422df80..7812deaf57 100644 --- a/specs/search/paths/objects/object.yml +++ b/specs/search/paths/objects/object.yml @@ -1,2 +1,2 @@ -put: -delete: +# put: +# delete: diff --git a/specs/search/paths/objects/objects.yml b/specs/search/paths/objects/objects.yml index 95f5cacd19..009c65bdfa 100644 --- a/specs/search/paths/objects/objects.yml +++ b/specs/search/paths/objects/objects.yml @@ -30,13 +30,13 @@ post: objectID: $ref: '../../../common/parameters.yml#/objectID' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml # delete index delete: tags: @@ -48,23 +48,12 @@ delete: - $ref: '../../../common/parameters.yml#/IndexName' responses: '200': - description: OK - content: - application/json: - schema: - title: deleteIndexResponse - type: object - additionalProperties: false - properties: - taskID: - $ref: '../../../common/parameters.yml#/taskID' - deletedAt: - $ref: '../../../common/parameters.yml#/deletedAt' + $ref: ../../../common/responses/DeletedAt.yml '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/objects/partialUpdate.yml b/specs/search/paths/objects/partialUpdate.yml index 6adb517bf4..bf62725b88 100644 --- a/specs/search/paths/objects/partialUpdate.yml +++ b/specs/search/paths/objects/partialUpdate.yml @@ -1 +1 @@ -post: +# post: diff --git a/specs/search/paths/rules/batchRules.yml b/specs/search/paths/rules/batchRules.yml index 3e66e882ce..1802d5b880 100644 --- a/specs/search/paths/rules/batchRules.yml +++ b/specs/search/paths/rules/batchRules.yml @@ -19,16 +19,12 @@ post: $ref: 'common/schemas.yml#/rule' responses: '200': - description: OK - content: - application/json: - schema: - $ref: './common/schemas.yml#/updatedRuleResponseWithoutObjectID' + $ref: ../../../common/responses/UpdatedAt.yml '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/rules/clearRules.yml b/specs/search/paths/rules/clearRules.yml index a6b1d3255c..519c7a8e9f 100644 --- a/specs/search/paths/rules/clearRules.yml +++ b/specs/search/paths/rules/clearRules.yml @@ -9,16 +9,12 @@ post: - $ref: '../../../common/parameters.yml#/ForwardToReplicas' responses: '200': - description: OK - content: - application/json: - schema: - $ref: './common/schemas.yml#/updatedRuleResponseWithoutObjectID' + $ref: ../../../common/responses/UpdatedAt.yml '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/rules/common/schemas.yml b/specs/search/paths/rules/common/schemas.yml index 3b35a384d0..215fc635fa 100644 --- a/specs/search/paths/rules/common/schemas.yml +++ b/specs/search/paths/rules/common/schemas.yml @@ -48,7 +48,7 @@ condition: anchoring: type: string description: Whether the pattern parameter must match the beginning or the end of the query string, or both, or none. - enum: ['is', 'startsWith', 'endsWith', 'contains'] + enum: [is, startsWith, endsWith, contains] consequence: type: object @@ -168,15 +168,3 @@ updatedRuleResponse: - objectID - updatedAt - taskID - -updatedRuleResponseWithoutObjectID: - type: object - additionalProperties: false - properties: - updatedAt: - $ref: '../../../../common/parameters.yml#/updatedAt' - taskID: - $ref: '../../../../common/parameters.yml#/taskID' - required: - - updatedAt - - taskID diff --git a/specs/search/paths/rules/rule.yml b/specs/search/paths/rules/rule.yml index 6060e1a22c..dfd0388e3f 100644 --- a/specs/search/paths/rules/rule.yml +++ b/specs/search/paths/rules/rule.yml @@ -20,15 +20,15 @@ put: content: application/json: schema: - $ref: './common/schemas.yml#/updatedRuleResponse' + $ref: 'common/schemas.yml#/updatedRuleResponse' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml get: tags: @@ -45,15 +45,15 @@ get: content: application/json: schema: - $ref: './common/schemas.yml#/rule' + $ref: 'common/schemas.yml#/rule' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml delete: tags: @@ -67,16 +67,12 @@ delete: - $ref: '../../../common/parameters.yml#/ForwardToReplicas' responses: '200': - description: OK - content: - application/json: - schema: - $ref: './common/schemas.yml#/updatedRuleResponseWithoutObjectID' + $ref: ../../../common/responses/UpdatedAt.yml '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/rules/searchRules.yml b/specs/search/paths/rules/searchRules.yml index 25654a99fe..510ba59a54 100644 --- a/specs/search/paths/rules/searchRules.yml +++ b/specs/search/paths/rules/searchRules.yml @@ -19,7 +19,7 @@ post: query: $ref: '../../../common/parameters.yml#/query' anchoring: - $ref: './common/schemas.yml#/anchoring' + $ref: 'common/schemas.yml#/anchoring' context: type: string description: Restricts matches to contextual rules with a specific context (exact match). @@ -68,10 +68,10 @@ post: type: integer description: Number of pages. '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/search/browse.yml b/specs/search/paths/search/browse.yml index b6672fbcd1..c36d824f51 100644 --- a/specs/search/paths/search/browse.yml +++ b/specs/search/paths/search/browse.yml @@ -32,10 +32,10 @@ post: schema: $ref: '../../common/schemas/SearchResponse.yml#/browseResponse' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/search/multipleQueries.yml b/specs/search/paths/search/multipleQueries.yml index 9f8848b874..fb0b6e437f 100644 --- a/specs/search/paths/search/multipleQueries.yml +++ b/specs/search/paths/search/multipleQueries.yml @@ -39,7 +39,7 @@ post: - indexName strategy: type: string - enum: ['none', 'stopIfEnoughMatches'] + enum: [none, stopIfEnoughMatches] required: - requests responses: @@ -57,10 +57,10 @@ post: items: $ref: '../../common/schemas/SearchResponse.yml#/searchResponse' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/search/search.yml b/specs/search/paths/search/search.yml index ac73618d83..5d445dbdb4 100644 --- a/specs/search/paths/search/search.yml +++ b/specs/search/paths/search/search.yml @@ -21,10 +21,10 @@ post: schema: $ref: '../../common/schemas/SearchResponse.yml#/searchResponse' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/search/searchForFacetValues.yml b/specs/search/paths/search/searchForFacetValues.yml index 4ef701b33c..74863b7c95 100644 --- a/specs/search/paths/search/searchForFacetValues.yml +++ b/specs/search/paths/search/searchForFacetValues.yml @@ -60,10 +60,10 @@ post: description: How many objects contain this facet value. This takes into account the extra search parameters specified in the query. Like for a regular search query, the counts may not be exhaustive. type: integer '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/settings/settings.yml b/specs/search/paths/settings/settings.yml index 6d252c1785..18564e4048 100644 --- a/specs/search/paths/settings/settings.yml +++ b/specs/search/paths/settings/settings.yml @@ -13,13 +13,13 @@ get: schema: $ref: '../../common/schemas/IndexSettings.yml#/indexSettings' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml put: tags: @@ -37,23 +37,12 @@ put: $ref: '../../common/schemas/IndexSettings.yml#/indexSettings' responses: '200': - description: OK - content: - application/json: - schema: - title: setSettingsResponse - type: object - additionalProperties: false - properties: - taskID: - $ref: '../../../common/parameters.yml#/taskID' - updatedAt: - $ref: '../../../common/parameters.yml#/updatedAt' + $ref: ../../../common/responses/UpdatedAt.yml '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/synonyms/batchSynonyms.yml b/specs/search/paths/synonyms/batchSynonyms.yml index b26c6acaac..86ea49be60 100644 --- a/specs/search/paths/synonyms/batchSynonyms.yml +++ b/specs/search/paths/synonyms/batchSynonyms.yml @@ -16,26 +16,12 @@ post: $ref: 'common/schemas.yml#/synonymHits' responses: '200': - description: OK - content: - application/json: - schema: - title: saveSynonymsResponse - type: object - additionalProperties: false - properties: - taskID: - $ref: '../../../common/parameters.yml#/taskID' - updatedAt: - $ref: '../../../common/parameters.yml#/updatedAt' - required: - - taskID - - updatedAt + $ref: ../../../common/responses/UpdatedAt.yml '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/synonyms/clearAllSynonyms.yml b/specs/search/paths/synonyms/clearAllSynonyms.yml index 9a992969f8..46aeead520 100644 --- a/specs/search/paths/synonyms/clearAllSynonyms.yml +++ b/specs/search/paths/synonyms/clearAllSynonyms.yml @@ -9,26 +9,12 @@ post: - $ref: '../../../common/parameters.yml#/ForwardToReplicas' responses: '200': - description: OK - content: - application/json: - schema: - title: clearAllSynonymsResponse - type: object - additionalProperties: false - properties: - taskID: - $ref: '../../../common/parameters.yml#/taskID' - updatedAt: - $ref: '../../../common/parameters.yml#/updatedAt' - required: - - taskID - - updatedAt + $ref: ../../../common/responses/UpdatedAt.yml '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/synonyms/common/parameters.yml b/specs/search/paths/synonyms/common/parameters.yml index a2232c6cc6..0e93cfc677 100644 --- a/specs/search/paths/synonyms/common/parameters.yml +++ b/specs/search/paths/synonyms/common/parameters.yml @@ -20,10 +20,8 @@ Type: schema: type: string enum: - [ - 'synonym', - 'onewaysynonym', - 'altcorrection1', - 'altcorrection2', - 'placeholder', - ] + - synonym + - onewaysynonym + - altcorrection1 + - altcorrection2 + - placeholder diff --git a/specs/search/paths/synonyms/common/schemas.yml b/specs/search/paths/synonyms/common/schemas.yml index ec441a370e..ff1ce5dde5 100644 --- a/specs/search/paths/synonyms/common/schemas.yml +++ b/specs/search/paths/synonyms/common/schemas.yml @@ -16,13 +16,12 @@ synonymHit: type: string description: Type of the synonym object. enum: - [ - 'synonym', - 'onewaysynonym', - 'altcorrection1', - 'altcorrection2', - 'placeholder', - ] + - synonym + - onewaysynonym + - altcorrection1 + - altcorrection2 + - placeholder + synonyms: type: array items: diff --git a/specs/search/paths/synonyms/searchSynonyms.yml b/specs/search/paths/synonyms/searchSynonyms.yml index 2cd0ffaf89..65d18ba563 100644 --- a/specs/search/paths/synonyms/searchSynonyms.yml +++ b/specs/search/paths/synonyms/searchSynonyms.yml @@ -18,10 +18,10 @@ post: schema: $ref: 'common/schemas.yml#/searchSynonymsResponse' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/synonyms/synonym.yml b/specs/search/paths/synonyms/synonym.yml index bd5a48fd07..9d2b6a2a78 100644 --- a/specs/search/paths/synonyms/synonym.yml +++ b/specs/search/paths/synonyms/synonym.yml @@ -35,13 +35,13 @@ put: - updatedAt - id '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml get: tags: @@ -58,15 +58,15 @@ get: content: application/json: schema: - $ref: './common/schemas.yml#/synonymHit' + $ref: 'common/schemas.yml#/synonymHit' '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml delete: tags: @@ -80,26 +80,12 @@ delete: - $ref: '../../../common/parameters.yml#/ForwardToReplicas' responses: '200': - description: OK - content: - application/json: - schema: - title: deleteSynonymResponse - type: object - additionalProperties: false - properties: - taskID: - $ref: '../../../common/parameters.yml#/taskID' - deletedAt: - $ref: '../../../common/parameters.yml#/deletedAt' - required: - - taskID - - deletedAt + $ref: ../../../common/responses/DeletedAt.yml '400': - $ref: '../../../common/responses/BadRequest.yml' + $ref: ../../../common/responses/BadRequest.yml '402': - $ref: '../../../common/responses/FeatureNotEnabled.yml' + $ref: ../../../common/responses/FeatureNotEnabled.yml '403': - $ref: '../../../common/responses/MethodNotAllowed.yml' + $ref: ../../../common/responses/MethodNotAllowed.yml '404': - $ref: '../../../common/responses/IndexNotFound.yml' + $ref: ../../../common/responses/IndexNotFound.yml diff --git a/specs/search/paths/vault/appendSource.yml b/specs/search/paths/vault/appendSource.yml index 8c439bc1cc..68586783af 100644 --- a/specs/search/paths/vault/appendSource.yml +++ b/specs/search/paths/vault/appendSource.yml @@ -12,15 +12,4 @@ post: $ref: 'common/schemas.yml#/source' responses: '200': - description: OK - content: - application/json: - schema: - title: appendSourceResponse - type: object - additionalProperties: false - required: - - createdAt - properties: - createdAt: - $ref: '../../../common/parameters.yml#/createdAt' + $ref: ../../../common/responses/CreatedAt.yml diff --git a/specs/search/paths/vault/common/schemas.yml b/specs/search/paths/vault/common/schemas.yml index 88aaae8826..39fa7754a5 100644 --- a/specs/search/paths/vault/common/schemas.yml +++ b/specs/search/paths/vault/common/schemas.yml @@ -11,7 +11,7 @@ source: source: description: The IP range of the source. type: string - example: '10.0.0.1/32' + example: 10.0.0.1/32 description: description: The description of the source. type: string diff --git a/specs/search/paths/vault/deleteSource.yml b/specs/search/paths/vault/deleteSource.yml index 1d003d263f..d5e0d0d554 100644 --- a/specs/search/paths/vault/deleteSource.yml +++ b/specs/search/paths/vault/deleteSource.yml @@ -10,7 +10,7 @@ delete: description: The IP range of the source. schema: type: string - example: '10.0.0.1/32' + example: 10.0.0.1/32 responses: '200': description: OK diff --git a/specs/search/paths/vault/vaultSources.yml b/specs/search/paths/vault/vaultSources.yml index 48cf7fdf25..784b060317 100644 --- a/specs/search/paths/vault/vaultSources.yml +++ b/specs/search/paths/vault/vaultSources.yml @@ -9,7 +9,7 @@ get: content: application/json: schema: - $ref: './common/schemas.yml#/sources' + $ref: 'common/schemas.yml#/sources' put: tags: @@ -22,7 +22,7 @@ put: content: application/json: schema: - $ref: './common/schemas.yml#/sources' + $ref: 'common/schemas.yml#/sources' responses: '200': description: OK diff --git a/specs/search/spec.yml b/specs/search/spec.yml index 2a88f06c14..1a899e7ac8 100644 --- a/specs/search/spec.yml +++ b/specs/search/spec.yml @@ -17,128 +17,128 @@ paths: # ### Search Endpoints ### # ######################## /1/indexes/{indexName}/query: - $ref: './paths/search/search.yml' + $ref: paths/search/search.yml /1/indexes/*/queries: - $ref: './paths/search/multipleQueries.yml' + $ref: paths/search/multipleQueries.yml /1/indexes/{indexName}/facets/{facetName}/query: - $ref: './paths/search/searchForFacetValues.yml' + $ref: paths/search/searchForFacetValues.yml /1/indexes/{indexName}/browse: - $ref: './paths/search/browse.yml' + $ref: paths/search/browse.yml # ######################### # ### Objects Endpoints ### # ######################### /1/indexes/{indexName}: - $ref: './paths/objects/objects.yml' + $ref: paths/objects/objects.yml # /1/indexes/{indexName}/{objectID}: - # $ref: './paths/objects/object.yml' + # $ref: 'paths/objects/object.yml' # /1/indexes/{indexName}/deleteByQuery: - # $ref: './paths/objects/deleteBy.yml' + # $ref: 'paths/objects/deleteBy.yml' # /1/indexes/{indexName}/clear: - # $ref: './paths/objects/clearObjects.yml' + # $ref: 'paths/objects/clearObjects.yml' # /1/indexes/{indexName}/{objectID}/partial: - # $ref: './paths/objects/partialUpdate.yml' + # $ref: 'paths/objects/partialUpdate.yml' /1/indexes/{indexName}/batch: - $ref: './paths/objects/batch.yml' + $ref: paths/objects/batch.yml # /1/indexes/*/batch: - # $ref: './paths/objects/multipleBatch.yml' + # $ref: 'paths/objects/multipleBatch.yml' # /1/indexes/*/objects: - # $ref: './paths/objects/multipleGetObjects.yml' + # $ref: 'paths/objects/multipleGetObjects.yml' # /1/indexes/{indexName}/{objectID}: - # $ref: './paths/objects/getObject.yml' + # $ref: 'paths/objects/getObject.yml' # ########################## # ### Settings Endpoints ### # ########################## /1/indexes/{indexName}/settings: - $ref: './paths/settings/settings.yml' + $ref: paths/settings/settings.yml # ########################## # ### Synonyms Endpoints ### # ########################## /1/indexes/{indexName}/synonyms/{objectID}: - $ref: './paths/synonyms/synonym.yml' + $ref: paths/synonyms/synonym.yml /1/indexes/{indexName}/synonyms/batch: - $ref: './paths/synonyms/batchSynonyms.yml' + $ref: paths/synonyms/batchSynonyms.yml /1/indexes/{indexName}/synonyms/clear: - $ref: './paths/synonyms/clearAllSynonyms.yml' + $ref: paths/synonyms/clearAllSynonyms.yml /1/indexes/{indexName}/synonyms/search: - $ref: './paths/synonyms/searchSynonyms.yml' + $ref: paths/synonyms/searchSynonyms.yml # ###################### # ### Keys Endpoints ### # ###################### /1/keys: - $ref: './paths/keys/keys.yml' + $ref: paths/keys/keys.yml /1/keys/{key}: - $ref: './paths/keys/key.yml' + $ref: paths/keys/key.yml /1/keys/{key}/restore: - $ref: './paths/keys/restoreApiKey.yml' + $ref: paths/keys/restoreApiKey.yml # ####################### # ### Rules Endpoints ### # ####################### /1/indexes/{indexName}/rules/{objectID}: - $ref: './paths/rules/rule.yml' + $ref: paths/rules/rule.yml /1/indexes/{indexName}/rules/batch: - $ref: './paths/rules/batchRules.yml' + $ref: paths/rules/batchRules.yml /1/indexes/{indexName}/rules/clear: - $ref: './paths/rules/clearRules.yml' + $ref: paths/rules/clearRules.yml /1/indexes/{indexName}/rules/search: - $ref: './paths/rules/searchRules.yml' + $ref: paths/rules/searchRules.yml # ############################## # ### Dictionaries Endpoints ### # ############################## /1/dictionaries/{dictionaryName}/batch: - $ref: './paths/dictionaries/batchDictionaryEntries.yml' + $ref: paths/dictionaries/batchDictionaryEntries.yml /1/dictionaries/{dictionaryName}/search: - $ref: './paths/dictionaries/searchDictionaryEntries.yml' + $ref: paths/dictionaries/searchDictionaryEntries.yml /1/dictionaries/*/settings: - $ref: './paths/dictionaries/dictionarySettings.yml' + $ref: paths/dictionaries/dictionarySettings.yml /1/dictionaries/*/languages: - $ref: './paths/dictionaries/getDictionaryLanguages.yml' + $ref: paths/dictionaries/getDictionaryLanguages.yml # ############################### # ### MultiClusters Endpoints ### # ############################### /1/clusters/mapping: - $ref: './paths/multiclusters/userIds.yml' + $ref: paths/multiclusters/userIds.yml /1/clusters/mapping/batch: - $ref: './paths/multiclusters/batchAssignUserIds.yml' + $ref: paths/multiclusters/batchAssignUserIds.yml /1/clusters/mapping/top: - $ref: './paths/multiclusters/getTopUserIds.yml' + $ref: paths/multiclusters/getTopUserIds.yml /1/clusters/mapping/{userID}: - $ref: './paths/multiclusters/userId.yml' + $ref: paths/multiclusters/userId.yml /1/clusters: - $ref: './paths/multiclusters/listClusters.yml' + $ref: paths/multiclusters/listClusters.yml /1/clusters/mapping/search: - $ref: './paths/multiclusters/searchUserIds.yml' + $ref: paths/multiclusters/searchUserIds.yml /1/clusters/mapping/pending: - $ref: './paths/multiclusters/hasPendingMappings.yml' + $ref: paths/multiclusters/hasPendingMappings.yml # ####################### # ### Vault Endpoints ### # ####################### /1/security/sources: - $ref: './paths/vault/vaultSources.yml' + $ref: paths/vault/vaultSources.yml /1/security/sources/append: - $ref: './paths/vault/appendSource.yml' + $ref: paths/vault/appendSource.yml /1/security/sources/{source}: - $ref: './paths/vault/deleteSource.yml' + $ref: paths/vault/deleteSource.yml # ########################## # ### Advanced Endpoints ### # ########################## /1/logs: - $ref: './paths/advanced/getLogs.yml' + $ref: paths/advanced/getLogs.yml /1/indexes/{indexName}/task/{taskID}: - $ref: './paths/advanced/getTask.yml' + $ref: paths/advanced/getTask.yml # ################################ # ### Manage Indices Endpoints ### # ################################ /1/indexes/{indexName}/operation: - $ref: './paths/manage_indices/operationIndex.yml' + $ref: paths/manage_indices/operationIndex.yml /1/indexes: - $ref: './paths/manage_indices/listIndices.yml' + $ref: paths/manage_indices/listIndices.yml diff --git a/yarn.lock b/yarn.lock index 45b753811d..d640cc521c 100644 --- a/yarn.lock +++ b/yarn.lock @@ -22,6 +22,7 @@ __metadata: eslint-plugin-jsdoc: 37.1.0 eslint-plugin-prettier: 4.0.0 eslint-plugin-unused-imports: 2.0.0 + eslint-plugin-yml: 0.12.0 json: 11.0.0 prettier: 2.5.0 prettier-plugin-java: 1.6.0 @@ -2568,6 +2569,20 @@ __metadata: languageName: node linkType: hard +"eslint-plugin-yml@npm:0.12.0": + version: 0.12.0 + resolution: "eslint-plugin-yml@npm:0.12.0" + dependencies: + debug: ^4.3.2 + lodash: ^4.17.21 + natural-compare: ^1.4.0 + yaml-eslint-parser: ^0.5.0 + peerDependencies: + eslint: ">=6.0.0" + checksum: 67432347b49dd0c1dff6243a8ae13fb5db4048fda2404becd8c5205ad0286eea3b5bc59ea59532794e226c54591838fe20775298e1ce7aba072da8e43e7a3a4d + languageName: node + linkType: hard + "eslint-rule-composer@npm:^0.3.0": version: 0.3.0 resolution: "eslint-rule-composer@npm:0.3.0" @@ -6375,6 +6390,24 @@ typescript@4.5.2: languageName: node linkType: hard +"yaml-eslint-parser@npm:^0.5.0": + version: 0.5.0 + resolution: "yaml-eslint-parser@npm:0.5.0" + dependencies: + eslint-visitor-keys: ^3.0.0 + lodash: ^4.17.21 + yaml: ^1.10.2 + checksum: f4b316407fa3a98e35808c3321617be8d01333df23e5ac5c00b1bd2c497845aeebab4bd506209f38b1e48c3d0483ade8b2c2f0251d131924435ed718d88b2c26 + languageName: node + linkType: hard + +"yaml@npm:^1.10.2": + version: 1.10.2 + resolution: "yaml@npm:1.10.2" + checksum: ce4ada136e8a78a0b08dc10b4b900936912d15de59905b2bf415b4d33c63df1d555d23acb2a41b23cf9fb5da41c256441afca3d6509de7247daa062fd2c5ea5f + languageName: node + linkType: hard + "yargs-parser@npm:20.x, yargs-parser@npm:^20.2.2": version: 20.2.9 resolution: "yargs-parser@npm:20.2.9"