diff --git a/specs/search/paths/multiclusters/batchAssignUserIds.yml b/specs/search/paths/multiclusters/batchAssignUserIds.yml index 8accd03183..b5ed344c83 100644 --- a/specs/search/paths/multiclusters/batchAssignUserIds.yml +++ b/specs/search/paths/multiclusters/batchAssignUserIds.yml @@ -2,6 +2,7 @@ post: tags: - Clusters operationId: batchAssignUserIds + deprecated: true x-acl: - admin summary: Assign multiple userIDs diff --git a/specs/search/paths/multiclusters/getTopUserIds.yml b/specs/search/paths/multiclusters/getTopUserIds.yml index 3b59a7d25f..db896ac53a 100644 --- a/specs/search/paths/multiclusters/getTopUserIds.yml +++ b/specs/search/paths/multiclusters/getTopUserIds.yml @@ -2,6 +2,7 @@ get: tags: - Clusters operationId: getTopUserIds + deprecated: true x-acl: - admin summary: Get top user IDs diff --git a/specs/search/paths/multiclusters/hasPendingMappings.yml b/specs/search/paths/multiclusters/hasPendingMappings.yml index fa3ec5e7f2..7a243c9387 100644 --- a/specs/search/paths/multiclusters/hasPendingMappings.yml +++ b/specs/search/paths/multiclusters/hasPendingMappings.yml @@ -2,6 +2,7 @@ get: tags: - Clusters operationId: hasPendingMappings + deprecated: true x-acl: - admin summary: Get migration and user mapping status diff --git a/specs/search/paths/multiclusters/listClusters.yml b/specs/search/paths/multiclusters/listClusters.yml index f25f8de799..654ebaf809 100644 --- a/specs/search/paths/multiclusters/listClusters.yml +++ b/specs/search/paths/multiclusters/listClusters.yml @@ -2,6 +2,7 @@ get: tags: - Clusters operationId: listClusters + deprecated: true x-acl: - admin summary: List clusters diff --git a/specs/search/paths/multiclusters/searchUserIds.yml b/specs/search/paths/multiclusters/searchUserIds.yml index 0fbf6cd48f..91f7bc6205 100644 --- a/specs/search/paths/multiclusters/searchUserIds.yml +++ b/specs/search/paths/multiclusters/searchUserIds.yml @@ -2,6 +2,7 @@ post: tags: - Clusters operationId: searchUserIds + deprecated: true x-use-read-transporter: true x-cacheable: true x-acl: diff --git a/specs/search/paths/multiclusters/userId.yml b/specs/search/paths/multiclusters/userId.yml index e0b3f7bdcb..55f6af67b7 100644 --- a/specs/search/paths/multiclusters/userId.yml +++ b/specs/search/paths/multiclusters/userId.yml @@ -2,6 +2,7 @@ get: tags: - Clusters operationId: getUserId + deprecated: true x-acl: - admin summary: Retrieve user ID @@ -32,6 +33,7 @@ delete: tags: - Clusters operationId: removeUserId + deprecated: true x-acl: - admin summary: Delete user ID diff --git a/specs/search/paths/multiclusters/userIds.yml b/specs/search/paths/multiclusters/userIds.yml index 9d07784007..1c16b986f3 100644 --- a/specs/search/paths/multiclusters/userIds.yml +++ b/specs/search/paths/multiclusters/userIds.yml @@ -2,6 +2,7 @@ post: tags: - Clusters operationId: assignUserId + deprecated: true x-acl: - admin summary: Assign or move a user ID @@ -41,6 +42,7 @@ get: tags: - Clusters operationId: listUserIds + deprecated: true x-acl: - admin summary: List user IDs diff --git a/specs/search/spec.yml b/specs/search/spec.yml index 2ade6042d2..a3f61e1ac8 100644 --- a/specs/search/spec.yml +++ b/specs/search/spec.yml @@ -128,11 +128,9 @@ tags: description: | Multi-cluster operations. - Algolia no longer offers multi-cluster management. - externalDocs: - url: https://www.algolia.com/doc/guides/scaling/managing-multiple-clusters-mcm/ - description: | - Related guide: Multi-cluster management. + Multi-cluster operations are **deprecated**. + If you have issues with your Algolia infrastructure + due to large volumes of data, contact the Algolia support team. - name: Dictionaries description: | Manage your dictionaries. diff --git a/templates/javascript/clients/client/api/operation/jsdoc.mustache b/templates/javascript/clients/client/api/operation/jsdoc.mustache index f54b90130f..3cbe26fd15 100644 --- a/templates/javascript/clients/client/api/operation/jsdoc.mustache +++ b/templates/javascript/clients/client/api/operation/jsdoc.mustache @@ -6,6 +6,10 @@ {{#x-acl}} * - {{.}} {{/x-acl}} + {{#isDeprecated}} + * + * @deprecated + {{/isDeprecated}} {{#x-create-wrapping-object}} * @param {{nickname}} - The {{nickname}} object. {{#allParams}} diff --git a/templates/kotlin/api.mustache b/templates/kotlin/api.mustache index 50bdde51e0..568552bb0d 100644 --- a/templates/kotlin/api.mustache +++ b/templates/kotlin/api.mustache @@ -49,7 +49,7 @@ public class {{classname}}( require(region == null || region in allowedRegions) { "`region` must be one of the following: ${allowedRegions.joinToString()}" } {{/fallbackToAliasHost}} val url = {{#fallbackToAliasHost}}if (region == null) "{{{hostWithFallback}}}" else {{/fallbackToAliasHost}} "{{{hostForKotlin}}}" - listOf(Host(url)) + listOf(Host(url)) {{/hasRegionalHost}} {{#hostsWithoutVariables.size}} listOf( @@ -70,6 +70,9 @@ public class {{classname}}( * - {{.}} {{/x-acl}} {{/vendorExtensions}} + {{#isDeprecated}} + * @deprecated + {{/isDeprecated}} {{#allParams}} * @param {{{paramName}}} {{{description}}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} {{/allParams}} diff --git a/templates/ruby/api.mustache b/templates/ruby/api.mustache index 68436ae0da..f3f7948223 100644 --- a/templates/ruby/api.mustache +++ b/templates/ruby/api.mustache @@ -101,6 +101,9 @@ module {{moduleName}} # - {{.}} {{/x-acl}} {{/vendorExtensions}} + {{#isDeprecated}} + # THIS OPERATION IS DEPRECATED + {{/isDeprecated}} {{#allParams}} {{#required}} # @param {{paramName}} [{{{dataType}}}] {{{description}}} (required) diff --git a/templates/scala/api.mustache b/templates/scala/api.mustache index 912ff511de..7aa2af9a4a 100644 --- a/templates/scala/api.mustache +++ b/templates/scala/api.mustache @@ -30,7 +30,7 @@ object {{classname}} { * @param apiKey * api key {{#hasRegionalHost}} * @param region - * region{{/hasRegionalHost}} + * region{{/hasRegionalHost}} * @param clientOptions * client options */ @@ -44,7 +44,7 @@ object {{classname}} { ) = new {{classname}}( appId = appId, apiKey = apiKey, - {{#hasRegionalHost}}region = region,{{/hasRegionalHost}} + {{#hasRegionalHost}}region = region,{{/hasRegionalHost}} clientOptions = clientOptions ) @@ -119,7 +119,7 @@ class {{classname}}( formats = JsonSupport.format, options = clientOptions ) { - + {{#operation}} /** {{{notes}}} {{#vendorExtensions}} @@ -130,10 +130,14 @@ class {{classname}}( * - {{.}} {{/x-acl}} {{/vendorExtensions}} +{{#isDeprecated}} +* +* @deprecated +{{/isDeprecated}} * {{#allParams}} {{#description}} -* @param {{{paramName}}} +* @param {{{paramName}}} * {{{.}}} {{/description}} {{/allParams}} @@ -145,9 +149,9 @@ class {{classname}}( val request = HttpRequest.builder() .withMethod("{{httpMethod}}") - .withPath({{#vendorExtensions}}{{#x-is-custom-request}}s"{{{path}}}"{{/x-is-custom-request}}{{^x-is-custom-request}}s"{{#lambda.escape-path}}{{{path}}}{{/lambda.escape-path}}"{{/x-is-custom-request}}{{/vendorExtensions}}) + .withPath({{#vendorExtensions}}{{#x-is-custom-request}}s"{{{path}}}"{{/x-is-custom-request}}{{^x-is-custom-request}}s"{{#lambda.escape-path}}{{{path}}}{{/lambda.escape-path}}"{{/x-is-custom-request}}{{/vendorExtensions}}) {{#bodyParam}}.withBody({{paramName}}){{/bodyParam}} - {{#headerParams}}.withHeader("{{baseName}}", {{paramName}}){{/headerParams}} + {{#headerParams}}.withHeader("{{baseName}}", {{paramName}}){{/headerParams}} {{#vendorExtensions.x-use-read-transporter}}.withRead(true){{/vendorExtensions.x-use-read-transporter}} {{#vendorExtensions}}{{#queryParams}}{{^x-is-custom-request}}.withQueryParameter("{{baseName}}", {{paramName}}){{/x-is-custom-request}}{{#x-is-custom-request}}.withQueryParameters(parameters){{/x-is-custom-request}}{{/queryParams}}{{/vendorExtensions}} .build()