fix(specs): provide non clashing names for custom methods (#2369)

.github/.cache_version

@@ -1 +1 @@
-0.0.105
+0.0.108

clients/algoliasearch-client-javascript/packages/algoliasearch/__tests__/algoliasearch.test.ts

@@ -23,7 +23,7 @@ describe('api', () => {
   });
 
   it('sets the user agent', async () => {
-    const req = (await client.post({
+    const req = (await client.customPost({
       path: '/test',
     })) as unknown as EchoResponse;
 
@@ -166,13 +166,13 @@ describe('api', () => {
         region: 'eu',
       });
 
-      const res1 = (await abtestingClient.get({
+      const res1 = (await abtestingClient.customGet({
         path: 'abtestingClient',
       })) as unknown as EchoResponse;
-      const res2 = (await analyticsClient.get({
+      const res2 = (await analyticsClient.customGet({
         path: 'analyticsClient',
       })) as unknown as EchoResponse;
-      const res3 = (await personalizationClient.get({
+      const res3 = (await personalizationClient.customGet({
         path: 'personalizationClient',
       })) as unknown as EchoResponse;
 
@@ -211,13 +211,13 @@ describe('api', () => {
         region: 'eu',
       });
 
-      const res1 = (await abtestingClient.get({
+      const res1 = (await abtestingClient.customGet({
         path: 'abtestingClient',
       })) as unknown as EchoResponse;
-      const res2 = (await analyticsClient.get({
+      const res2 = (await analyticsClient.customGet({
         path: 'analyticsClient',
       })) as unknown as EchoResponse;
-      const res3 = (await personalizationClient.get({
+      const res3 = (await personalizationClient.customGet({
         path: 'personalizationClient',
       })) as unknown as EchoResponse;
 

generators/src/main/java/com/algolia/codegen/utils/Helpers.java

@@ -17,7 +17,7 @@ public class Helpers {
   /** The suffix of our client names. */
   public static final String API_SUFFIX = "Client";
 
-  public static final Set<String> CUSTOM_METHODS = Set.of("del", "get", "post", "put");
+  public static final Set<String> CUSTOM_METHODS = Set.of("customDelete", "customGet", "customPost", "customPut");
 
   private static JsonNode cacheConfig;
   private static JsonNode cacheOpenApiToolsConfig;

scripts/buildSpecs.ts

@@ -6,7 +6,7 @@ import { checkForCache, exists, run, toAbsolutePath } from './common.js';
 import { createSpinner } from './spinners.js';
 import type { Spec } from './types.js';
 
-const ALGOLIASEARCH_LITE_OPERATIONS = ['search', 'post'];
+const ALGOLIASEARCH_LITE_OPERATIONS = ['search', 'customPost'];
 
 /**
  * This function will transform properties in the bundle depending on the context.
@@ -142,8 +142,8 @@ async function buildLiteSpec({
   // Filter methods.
   parsed.paths = Object.entries(parsed.paths).reduce(
     (acc, [path, operations]) => {
-      for (const [method, operation] of Object.entries(operations)) {
-        if (method === 'post' && ALGOLIASEARCH_LITE_OPERATIONS.includes(operation.operationId)) {
+      for (const [, operation] of Object.entries(operations)) {
+        if (ALGOLIASEARCH_LITE_OPERATIONS.includes(operation.operationId)) {
           return { ...acc, [path]: { post: operation } };
         }
       }

specs/common/paths/customRequest.yml

@@ -1,9 +1,9 @@
 get:
-  operationId: get
+  operationId: customGet
   $ref: '../schemas/CustomRequest.yml#/customRequest'
 
 post:
-  operationId: post
+  operationId: customPost
   requestBody:
     description: Parameters to send with the custom request.
     content:
@@ -13,7 +13,7 @@ post:
   $ref: '../schemas/CustomRequest.yml#/customRequest'
 
 put:
-  operationId: put
+  operationId: customPut
   requestBody:
     description: Parameters to send with the custom request.
     content:
@@ -23,5 +23,5 @@ put:
   $ref: '../schemas/CustomRequest.yml#/customRequest'
 
 delete:
-  operationId: del
+  operationId: customDelete
   $ref: '../schemas/CustomRequest.yml#/customRequest'

templates/dart/api.mustache

@@ -157,7 +157,45 @@ final class {{classname}} implements ApiClient {
   }  
   {{/operation}}
 
+  @Deprecated('This operation has been deprecated, use `customPost` instead')
+  Future<Object> post({
+    required  String path,
+    Map<String, Object>? parameters, Object? body,
+    RequestOptions? requestOptions,
+  }) async {
+    return this.customPost(path: path, parameters: parameters, requestOptions: requestOptions);
+  }
+
+  {{^isAlgoliasearchClient}}
+  @Deprecated('This operation has been deprecated, use `customPut` instead')
+  Future<Object> put({
+    required  String path,
+    Map<String, Object>? parameters, Object? body,
+    RequestOptions? requestOptions,
+  }) async {
+    return customPut(path: path, parameters: parameters, requestOptions: requestOptions);
+  }
+
+  @Deprecated('This operation has been deprecated, use `customGet` instead')
+  Future<Object> get({
+    required  String path,
+    Map<String, Object>? parameters, Object? body,
+    RequestOptions? requestOptions,
+  }) async {
+    return this.customGet(path: path, parameters: parameters, requestOptions: requestOptions);
+  }
+
+  @Deprecated('This operation has been deprecated, use `customDelete` instead')
+  Future<Object> del({
+    required  String path,
+    Map<String, Object>? parameters, Object? body,
+    RequestOptions? requestOptions,
+  }) async {
+    return this.customDelete(path: path, parameters: parameters, requestOptions: requestOptions);
+  }
+  {{/isAlgoliasearchClient}}
+
   @override
   void dispose() => _retryStrategy.dispose(); 
 }
-{{/operations}}
+{{/operations}}

templates/javascript/clients/algoliasearch/builds/models.mustache

@@ -7,10 +7,10 @@ import type {
 } from '{{{npmNamespace}}}/client-common';
 import {
   ErrorBase,
-  PutProps,
-  PostProps,
-  DelProps,
-  GetProps,
+  CustomPutProps,
+  CustomPostProps,
+  CustomDeleteProps,
+  CustomGetProps,
 } from '{{{npmNamespace}}}/client-search/model';
 
 export * from '{{{npmNamespace}}}/client-search/model';
@@ -23,7 +23,13 @@ export { PersonalizationClient } from '{{{npmNamespace}}}/client-personalization
 export { AnalyticsClient } from '{{{npmNamespace}}}/client-analytics';
 export { AbtestingClient } from '{{{npmNamespace}}}/client-abtesting';
 
-export { ErrorBase, PutProps, PostProps, DelProps, GetProps };
+export {
+  ErrorBase,
+  CustomPutProps,
+  CustomPostProps,
+  CustomDeleteProps,
+  CustomGetProps,
+};
 
 /**
  * Options forwarded to the client initialized via the `init` method.
@@ -45,4 +51,4 @@ export type InitClientRegion<TRegion> = Partial<{
    * Available regions of the initialized client.
    */
   region: TRegion;
-}>;
+}>;

tests/CTS/client/analytics/parameters.json

@@ -41,7 +41,7 @@
       {
         "type": "method",
         "object": "$client",
-        "path": "post",
+        "path": "customPost",
         "parameters": {
           "path": "/test"
         },

tests/CTS/client/common/commonApi.json

@@ -5,7 +5,7 @@
       {
         "type": "method",
         "object": "$client",
-        "path": "post",
+        "path": "customPost",
         "parameters": {
           "path": "/test"
         },
@@ -22,7 +22,7 @@
       {
         "type": "method",
         "object": "$client",
-        "path": "get",
+        "path": "customGet",
         "parameters": {
           "path": "/test"
         },
@@ -42,7 +42,7 @@
       {
         "type": "method",
         "object": "$client",
-        "path": "post",
+        "path": "customPost",
         "parameters": {
           "path": "/test"
         },

tests/CTS/client/insights/parameters.json

@@ -41,7 +41,7 @@
       {
         "type": "method",
         "object": "$client",
-        "path": "del",
+        "path": "customDelete",
         "parameters": {
           "path": "/test"
         },

tests/CTS/client/recommend/api.json

@@ -14,7 +14,7 @@
       {
         "type": "method",
         "object": "$client",
-        "path": "get",
+        "path": "customGet",
         "parameters": {
           "path": "/test"
         },
@@ -40,7 +40,7 @@
       {
         "type": "method",
         "object": "$client",
-        "path": "post",
+        "path": "customPost",
         "parameters": {
           "path": "/test"
         },

tests/CTS/client/search/api.json

@@ -14,7 +14,7 @@
       {
         "type": "method",
         "object": "$client",
-        "path": "get",
+        "path": "customGet",
         "parameters": {
           "path": "/test"
         },
@@ -40,7 +40,7 @@
       {
         "type": "method",
         "object": "$client",
-        "path": "post",
+        "path": "customPost",
         "parameters": {
           "path": "/test"
         },