chore(specs): breaking change method names mapping table (#3568)

algolia · Aug 21, 2024 · f38a9ef · f38a9ef
1 parent d67974e
commit f38a9ef
Show file tree

Hide file tree

Showing 3 changed files with 90 additions and 1 deletion.
diff --git a/scripts/ci/codegen/pushToAlgoliaDoc.ts b/scripts/ci/codegen/pushToAlgoliaDoc.ts
@@ -51,6 +51,7 @@ async function pushToAlgoliaDoc(): Promise<void> {
   const pathToSpecs = toAbsolutePath(`${tempGitDir}/app_data/api/specs`);
   await run(`rm -rf ${pathToSpecs}/* || true`);
   await run(`cp ${toAbsolutePath('specs/bundled/README.md')} ${pathToSpecs}`);
+  await run(`cp ${toAbsolutePath('specs/major-breaking-changes-rename.json')} ${pathToSpecs}`);
   await run(`cp ${toAbsolutePath('specs/bundled/*.doc.yml')} ${pathToSpecs}`);
   await run(`cp ${toAbsolutePath('config/release.config.json')} ${pathToSpecs}`);
   await run(`cp ${toAbsolutePath('snippets/guides/*.json')} ${pathToSpecs}`);

diff --git a/scripts/ci/githubActions/createMatrix.ts b/scripts/ci/githubActions/createMatrix.ts
@@ -29,8 +29,8 @@ async function createClientMatrix(baseBranch: string): Promise<void> {
       // We will check if dependencies have changed for each clients of each languages:
       //   - language specific dependencies
       //   - common dependencies of every clients
-      //   - output of the client
       //   - specs that generated the client
+      //   - output of the client
       const dependenciesChanged = await isBaseChanged(baseBranch, {
         ...languageDependencies,
         output: [output],

diff --git a/specs/major-breaking-changes-rename.json b/specs/major-breaking-changes-rename.json
@@ -0,0 +1,88 @@
+{
+  "abtesting": {},
+  "analytics": {},
+  "ingestion": {},
+  "insights": {},
+  "monitoring": {},
+  "personalization": {},
+  "query-suggestions": {},
+  "recommend": {
+    "client.getFrequentlyBoughtTogether": "client.getRecommendations",
+    "client.getLookingSimilar": "client.getRecommendations",
+    "client.getRecommendations": "client.getRecommendations",
+    "client.getRecommendedForYou": "client.getRecommendations",
+    "client.getRelatedProducts": "client.getRecommendations",
+    "client.getTrendingFacets": "client.getRecommendations",
+    "client.getTrendingItems": "client.getRecommendations"
+  },
+  "search": {
+    "client.addApiKey": "client.addApiKey",
+    "client.addApiKey.wait": "client.waitForApiKey",
+    "client.assignUserID": "client.assignUserId",
+    "client.assignUserIDs": "client.batchAssignUserIds",
+    "client.clearDictionaryEntries": "client.batchDictionaryEntries",
+    "client.copyIndex": "client.operationIndex",
+    "client.copyRules": "client.operationIndex",
+    "client.copySynonyms": "client.operationIndex",
+    "client.deleteApiKey": "client.deleteApiKey",
+    "client.deleteDictionaryEntries": "client.batchDictionaryEntries",
+    "client.generateSecuredApiKey": "client.generateSecuredApiKey",
+    "client.getApiKey": "client.getApiKey",
+    "client.getSecuredApiKeyRemainingValidity": "client.getSecuredApiKeyRemainingValidity",
+    "client.getTopUserIDs": "client.getTopUserIds",
+    "client.getUserID": "client.getUserId",
+    "client.listApiKeys": "client.listApiKeys",
+    "client.listIndices": "client.listIndices",
+    "client.listUserIDs": "client.listUserIds",
+    "client.moveIndex": "client.operationIndex",
+    "client.multipleBatch": "client.multipleBatch",
+    "client.multipleQueries": "client.search",
+    "client.removeUserID": "client.removeUserId",
+    "client.replaceDictionaryEntries": "client.batchDictionaryEntries",
+    "client.restoreApiKey": "client.restoreApiKey",
+    "client.saveDictionaryEntries": "client.batchDictionaryEntries",
+    "client.searchUserIDs": "client.searchUserIds",
+    "client.updateApiKey": "client.updateApiKey",
+    "index.batch": "client.batch",
+    "index.browseObjects": "client.browseObjects",
+    "index.browseRules": "client.browseRules",
+    "index.browseSynonyms": "client.browseSynonyms",
+    "index.clearObjects": "client.clearObjects",
+    "index.clearRules": "client.clearRules",
+    "index.clearSynonyms": "client.clearAllSynonyms",
+    "index.copySettings": "client.operationIndex",
+    "index.delete": "client.deleteIndex",
+    "index.deleteBy": "client.deleteBy",
+    "index.deleteObject": "client.deleteObject",
+    "index.deleteObjects": "client.deleteObjects",
+    "index.deleteRule": "client.deleteRule",
+    "index.deleteSynonym": "client.deleteSynonym",
+    "index.exists": "client.getSettings",
+    "index.findObject": "client.searchSingleIndex",
+    "index.getObject": "client.getObject",
+    "index.getObjects": "client.getObjects",
+    "index.getRule": "client.getRule",
+    "index.getSettings": "client.getSettings",
+    "index.getSynonym": "client.getSynonym",
+    "index.getTask": "client.getTask",
+    "index.partialUpdateObject": "client.partialUpdateObject",
+    "index.partialUpdateObjects": "client.partialUpdateObjects",
+    "index.replaceAllObjects": "client.replaceAllObjects",
+    "index.replaceAllRules": "client.saveRules",
+    "index.replaceAllSynonyms": "client.saveSynonyms",
+    "index.saveObject": "client.saveObject",
+    "index.saveObjects": "client.saveObjects",
+    "index.saveRule": "client.saveRule",
+    "index.saveRules": "client.saveRules",
+    "index.saveSynonym": "client.saveSynonym",
+    "index.saveSynonyms": "client.saveSynonyms",
+    "index.search": "client.searchSingleIndex",
+    "index.searchForFacetValues": "client.searchForFacets",
+    "index.searchRules": "client.searchRules",
+    "index.searchSynonyms": "client.searchSynonyms",
+    "index.setSettings": "client.setSettings",
+    "index.{operation}.wait": "client.waitForTask"
+  },
+  "usage": {},
+  "crawler": {}
+}