feat: add full clients architecture init

README.md

@@ -6,7 +6,7 @@
 nvm use && yarn
 ```
 
-## Generate clients based on the [`spec.yml` file](./specs/spec.yml)
+## Generate clients based on the [`spec_search.yml` file](./specs/spec_search.yml)
 
 ```bash
 yarn generate

openapitools.json

@@ -9,7 +9,7 @@
         "config": "#{cwd}/openapitools.json",
         "apiPackage": "client-search",
         "output": "#{cwd}/clients/algoliasearch-client-javascript",
-        "glob": "specs/spec.yml",
+        "glob": "specs/spec_search.yml",
         "gitHost": "algolia",
         "gitUserId": "algolia",
         "gitRepoId": "algoliasearch-client-javascript",

package.json

@@ -6,8 +6,8 @@
     "playground/javascript/"
   ],
   "scripts": {
-    "build:spec": "yarn swagger-cli bundle specs/spec.yml --outfile dist/openapi.yml --type yaml",
-    "build:spec:json": "yarn swagger-cli bundle specs/spec.yml --outfile dist/openapi.json --type json",
+    "build:spec": "yarn swagger-cli bundle specs/spec_search.yml --outfile dist/openapi.yml --type yaml",
+    "build:spec:json": "yarn swagger-cli bundle specs/spec_search.yml --outfile dist/openapi.json --type json",
     "clean": "rm -rf **/dist **/build **/node_modules",
     "client:build-js": "cd clients/algoliasearch-client-javascript/ && yarn install && yarn build && cd ../../",
     "client:build": "yarn client:build-js",

specs/paths/abtesting_client/addAbTest.yml

@@ -0,0 +1 @@
+post:

specs/paths/abtesting_client/deleteAbTest.yml

@@ -0,0 +1 @@
+delete:

specs/paths/abtesting_client/getAbTest.yml

@@ -0,0 +1 @@
+get:

specs/paths/abtesting_client/listAbTests.yml

@@ -0,0 +1 @@
+get:

specs/paths/abtesting_client/stopAbTest.yml

@@ -0,0 +1 @@
+post:

specs/paths/personalization_client/deleteUserProfile.yml

@@ -0,0 +1 @@
+delete:

specs/paths/personalization_client/getPersonalizationStrategy.yml

@@ -0,0 +1 @@
+get:

specs/paths/personalization_client/getUserTokenProfile.yml

@@ -0,0 +1 @@
+get:

specs/paths/personalization_client/setPersonalizationStrategy.yml

@@ -0,0 +1 @@
+post:

specs/paths/query_suggestions_client/createConfiguration.yml

@@ -0,0 +1 @@
+post:

specs/paths/query_suggestions_client/deleteConfiguration.yml

@@ -0,0 +1 @@
+delete:

specs/paths/query_suggestions_client/getAllConfigurations.yml

@@ -0,0 +1 @@
+get:

specs/paths/query_suggestions_client/getConfiguration.yml

@@ -0,0 +1 @@
+get:

specs/paths/query_suggestions_client/getConfigurationStatus.yml

@@ -0,0 +1 @@
+get:

specs/paths/query_suggestions_client/getLogFile.yml

@@ -0,0 +1 @@
+get:

specs/paths/query_suggestions_client/updateConfiguration.yml

@@ -0,0 +1 @@
+put:

specs/paths/recommend_client/getRecommendations.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/advanced/getLogs.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/advanced/getTask.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/advanced/isAlive.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/dictionaries/batchDictionaryEntries.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/dictionaries/getDictionaryLanguages.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/dictionaries/getDictionarySettings.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/dictionaries/searchDictionaryEntries.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/dictionaries/setDictionarySettings.yml

@@ -0,0 +1 @@
+put:

specs/paths/search_client/keys/addApiKey.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/keys/deleteApiKey.yml

@@ -0,0 +1 @@
+delete:

specs/paths/search_client/keys/getApiKey.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/keys/listApiKeys.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/keys/restoreApiKey.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/keys/updateApiKey.yml

@@ -0,0 +1 @@
+put:

specs/paths/search_client/manage_indices/copyIndex.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/manage_indices/deleteIndex.yml

@@ -0,0 +1 @@
+delete:

specs/paths/search_client/manage_indices/listIndices.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/multiclusters/assignUserId.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/multiclusters/batchAssignUserIds.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/multiclusters/getTopUserIds.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/multiclusters/getUserId.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/multiclusters/hasPendingMappings.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/multiclusters/listClusters.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/multiclusters/listUserIds.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/multiclusters/removeUserId.yml

@@ -0,0 +1 @@
+delete:

specs/paths/search_client/multiclusters/searchUserIds.yml

@@ -0,0 +1 @@
+post:

specs/paths/indexes/batch.yml → specs/paths/search_client/objects/batch.yml

@@ -4,7 +4,7 @@ post:
   operationId: batch
   summary: Performs multiple write operations in a single API call
   parameters:
-    - $ref: '../../parameters.yml#/IndexName'
+    - $ref: '../../../parameters.yml#/IndexName'
   requestBody:
     required: true
     content:
@@ -48,10 +48,10 @@ post:
             additionalProperties: false
             properties:
               taskID:
-                $ref: '../../responses/common.yml#/taskID'
+                $ref: '../../../responses/common.yml#/taskID'
               objectIDs:
-                $ref: '../../responses/common.yml#/objectIDs'
+                $ref: '../../../responses/common.yml#/objectIDs'
     '400':
-      $ref: '../../responses/BadRequest.yml'
+      $ref: '../../../responses/BadRequest.yml'
     '404':
-      $ref: '../../responses/IndexNotFound.yml'
+      $ref: '../../../responses/IndexNotFound.yml'

specs/paths/search_client/objects/clearObjects.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/objects/deleteBy.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/objects/deleteObject.yml

@@ -0,0 +1 @@
+delete:

specs/paths/search_client/objects/getObject.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/objects/multipleBatch.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/objects/multipleGetObjects.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/objects/partialUpdate.yml

@@ -0,0 +1 @@
+post:

specs/paths/indexes/saveObject.yml → specs/paths/search_client/objects/saveObject.yml

@@ -5,7 +5,7 @@ post:
   summary: Save object
   description: Add an object to the index, automatically assigning it an object ID
   parameters:
-    - $ref: '../../parameters.yml#/IndexName'
+    - $ref: '../../../parameters.yml#/IndexName'
   requestBody:
     required: true
     content:
@@ -26,10 +26,10 @@ post:
               createdAt:
                 type: string
               taskID:
-                $ref: '../../responses/common.yml#/taskID'
+                $ref: '../../../responses/common.yml#/taskID'
               objectID:
-                $ref: '../../responses/common.yml#/objectID'
+                $ref: '../../../responses/common.yml#/objectID'
     '400':
-      $ref: '../../responses/BadRequest.yml'
+      $ref: '../../../responses/BadRequest.yml'
     '404':
-      $ref: '../../responses/IndexNotFound.yml'
+      $ref: '../../../responses/IndexNotFound.yml'

specs/paths/search_client/objects/updateObject.yml

@@ -0,0 +1 @@
+put:

specs/paths/search_client/rules/batchRules.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/rules/clearRules.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/rules/deleteRule.yml

@@ -0,0 +1 @@
+delete:

specs/paths/search_client/rules/getRule.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/rules/saveRule.yml

@@ -0,0 +1 @@
+put:

specs/paths/search_client/rules/searchRules.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/search/browse.yml

@@ -0,0 +1 @@
+post:

specs/paths/indexes/multipleQueries.yml → specs/paths/search_client/search/multipleQueries.yml

@@ -24,7 +24,7 @@ post:
                     example: products
                     description: The Algolia index name
                   query:
-                    $ref: ../../schemas/SearchParams.yml#/searchParams/properties/query
+                    $ref: ../../../schemas/SearchParams.yml#/searchParams/properties/query
                   type:
                     type: string
                     enum: [default, facet]
@@ -56,8 +56,8 @@ post:
               results:
                 type: array
                 items:
-                  $ref: ../../schemas/SearchResponse.yml#/searchResponse
+                  $ref: ../../../schemas/SearchResponse.yml#/searchResponse
     '400':
-      $ref: ../../responses/BadRequest.yml
+      $ref: ../../../responses/BadRequest.yml
     '404':
-      $ref: ../../responses/IndexNotFound.yml
+      $ref: ../../../responses/IndexNotFound.yml

specs/paths/indexes/search.yml → specs/paths/search_client/search/search.yml

@@ -4,24 +4,24 @@ post:
   operationId: search
   summary: Get search results
   parameters:
-    - $ref: '../../parameters.yml#/IndexName'
+    - $ref: '../../../parameters.yml#/IndexName'
   requestBody:
     required: true
     content:
       application/json:
         schema:
           oneOf:
-            - $ref: ../../schemas/SearchParams.yml#/searchParams
-            - $ref: ../../schemas/SearchParams.yml#/searchParamsString
+            - $ref: ../../../schemas/SearchParams.yml#/searchParams
+            - $ref: ../../../schemas/SearchParams.yml#/searchParamsString
   responses:
     '200':
       description: OK
       content:
         application/json:
           schema:
             title: singleQueryResponse
-            $ref: ../../schemas/SearchResponse.yml#/searchResponse
+            $ref: ../../../schemas/SearchResponse.yml#/searchResponse
     '400':
-      $ref: ../../responses/BadRequest.yml
+      $ref: ../../../responses/BadRequest.yml
     '404':
-      $ref: ../../responses/IndexNotFound.yml
+      $ref: ../../../responses/IndexNotFound.yml

specs/paths/search_client/search/searchForFacetValues.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/settings/getSettings.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/settings/setSettings.yml

@@ -0,0 +1 @@
+put:

specs/paths/search_client/synonyms/batchSynonyms.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/synonyms/clearAllSynonyms.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/synonyms/deleteSynonym.yml

@@ -0,0 +1 @@
+delete:

specs/paths/search_client/synonyms/getSynonym.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/synonyms/saveSynonym.yml

@@ -0,0 +1 @@
+put:

specs/paths/search_client/synonyms/searchSynonyms.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/vault/appendSource.yml

@@ -0,0 +1 @@
+post:

specs/paths/search_client/vault/deleteSource.yml

@@ -0,0 +1 @@
+delete:

specs/paths/search_client/vault/listSources.yml

@@ -0,0 +1 @@
+get:

specs/paths/search_client/vault/replaceSources.yml

@@ -0,0 +1 @@
+put:

specs/spec_abtesting.yml

@@ -0,0 +1,46 @@
+openapi: 3.0.2
+info:
+  title: A/B Testing API
+  description: API powering the A/B Testing feature of Algolia.
+  version: 0.0.1
+servers:
+  - url: https://{appId}-1.algolianet.com
+    variables:
+      appId:
+        default: test
+  - url: https://{appId}-2.algolianet.com
+    variables:
+      appId:
+        default: test
+  - url: https://{appId}-3.algolianet.com
+    variables:
+      appId:
+        default: test
+  - url: https://{appId}-dsn.algolianet.com
+    variables:
+      appId:
+        default: test
+components:
+  securitySchemes:
+    appId:
+      type: apiKey
+      in: header
+      name: X-Algolia-Application-Id
+    apiKey:
+      type: apiKey
+      in: header
+      name: X-Algolia-API-Key
+security:
+  - appId: []
+    apiKey: []
+paths:
+#  /2/abtests:
+#    $ref: './paths/abtesting_client/addAbTest.yml'
+#  /2/abtests/{id}:
+#    $ref: './paths/abtesting_client/getAbTest.yml'
+#  /2/abtests:
+#    $ref: './paths/abtesting_client/listAbTests.yml'
+#  /2/abtests/{id}/stop:
+#    $ref: './paths/abtesting_client/stopAbTest.yml'
+#  /2/abtests/{id}:
+#    $ref: './paths/abtesting_client/deleteAbTest.yml'

specs/spec_personalization.yml

@@ -0,0 +1,44 @@
+openapi: 3.0.2
+info:
+  title: Personalization API
+  description: API powering the Personalization feature of Algolia.
+  version: 0.0.1
+servers:
+  - url: https://{appId}-1.algolianet.com
+    variables:
+      appId:
+        default: test
+  - url: https://{appId}-2.algolianet.com
+    variables:
+      appId:
+        default: test
+  - url: https://{appId}-3.algolianet.com
+    variables:
+      appId:
+        default: test
+  - url: https://{appId}-dsn.algolianet.com
+    variables:
+      appId:
+        default: test
+components:
+  securitySchemes:
+    appId:
+      type: apiKey
+      in: header
+      name: X-Algolia-Application-Id
+    apiKey:
+      type: apiKey
+      in: header
+      name: X-Algolia-API-Key
+security:
+  - appId: []
+    apiKey: []
+paths:
+#  /1/profiles/personalization/{userToken}:
+#    $ref: './paths/personalization_client/getUserTokenProfile.yml'
+#  /1/profiles/{userToken}:
+#    $ref: './paths/personalization_client/deleteUserProfile.yml'
+#  /1/strategies/personalization:
+#    $ref: './paths/personalization_client/getPersonalizationStrategy.yml'
+#  /1/strategies/personalization:
+#    $ref: './paths/personalization_client/setPersonalizationStrategy.yml'