feat: add full clients architecture init (#13)

README.md

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

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/search/spec.yml",
         "gitHost": "algolia",
         "gitUserId": "algolia",
         "gitRepoId": "algoliasearch-client-javascript",

package.json

@@ -6,16 +6,18 @@
     "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/search/spec.yml --outfile dist/openapi.yml --type yaml",
+    "build:spec:json": "yarn swagger-cli bundle specs/search/spec.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",
     "lint:js": "yarn prettier --write clients/algoliasearch-client-javascript clients/utils/javascript",
     "lint:specs": "yarn prettier --write specs",
     "lint": "yarn lint:specs && yarn lint:js",
     "generate:js": "PACKAGE_VERSION='4.11.0' yarn openapi-generator-cli generate --generator-key javascript-client && yarn install && yarn utils:import-js",
+    "generate:js:search": "PACKAGE_VERSION='4.11.0' yarn openapi-generator-cli generate -i specs/search/spec.yml --generator-key javascript-client && yarn install && yarn utils:import-js",
     "generate": "yarn generate:js && yarn lint",
+    "generate:search": "yarn generate:js:search && yarn lint",
     "playground:js": "yarn workspace algoliasearch-client-javascript-playground start",
     "utils:import-js": "mkdir -p -- clients/algoliasearch-client-javascript/utils && cp -R clients/utils/javascript/ clients/algoliasearch-client-javascript/utils"
   },

specs/abtesting/paths/abtest.yml

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

specs/abtesting/paths/abtests.yml

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

specs/abtesting/paths/stopAbTest.yml

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

specs/abtesting/spec.yml

@@ -0,0 +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'

specs/analytics/paths/click/getAverageTopClickPosition.yml

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

specs/analytics/paths/click/getClickPositions.yml

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

specs/analytics/paths/click/getClickThroughRate.yml

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

specs/analytics/paths/click/getConversionRate.yml

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

specs/analytics/paths/search/getAttributeTopFilters.yml

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

specs/analytics/paths/search/getNoClickRate.yml

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

specs/analytics/paths/search/getNoResultTopFilters.yml

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

specs/analytics/paths/search/getNoResultsRate.yml

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

specs/analytics/paths/search/getSearchAttributesTopFilters.yml

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

specs/analytics/paths/search/getSearchesCount.yml

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

specs/analytics/paths/search/getSearchesNoClicks.yml

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

specs/analytics/paths/search/getSearchesNoResults.yml

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

specs/analytics/paths/search/getTopCountries.yml

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

specs/analytics/paths/search/getTopFilterAttributes.yml

@@ -0,0 +1,2 @@
+get:
+# handle /2/filters?search= as well

specs/analytics/paths/search/getTopHits.yml

@@ -0,0 +1,2 @@
+get:
+# handle /2/hits?search= as well

specs/analytics/paths/search/getTopSearches.yml

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

specs/analytics/paths/search/getUsersCount.yml

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

specs/analytics/paths/status/getStatus.yml

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

specs/analytics/spec.yml

@@ -0,0 +1,62 @@
+openapi: 3.0.2
+info:
+  title: Analytics API
+  description: API powering the Analytics feature of Algolia.
+  version: 0.1.0
+components:
+  securitySchemes:
+    appId:
+      $ref: '../common/securitySchemes.yml#/appId'
+    apiKey:
+      $ref: '../common/securitySchemes.yml#/apiKey'
+security:
+  - appId: []
+    apiKey: []
+paths:
+  # ########################
+  # ### Status Endpoints ###
+  # ########################
+  /2/status:
+    $ref: './paths/status/getStatus.yml'
+  #
+  # ##################################
+  # ### Search Analytics Endpoints ###
+  # ##################################
+  # /2/searches:
+  #  $ref: './paths/search/getTopSearches.yml'
+  # /2/searches/count:
+  #   $ref: './paths/search/getSearchesCount.yml'
+  # /2/searches/noResults:
+  #   $ref: './paths/search/getSearchesNoResults.yml'
+  # /2/searches/noClicks:
+  #   $ref: './paths/search/getSearchesNoClicks.yml'
+  # /2/searches/noResultRate:
+  #   $ref: './paths/search/getNoResultsRate.yml'
+  # /2/searches/noClickRate:
+  #   $ref: './paths/search/getNoClickRate.yml'
+  # /2/hits:
+  #  $ref: './paths/search/getTopHits.yml'
+  # /2/users/count:
+  #   $ref: './paths/search/getUsersCount.yml'
+  # /2/filters:
+  #   $ref: './paths/search/getTopFilterAttributes.yml'
+  # /2/filters/noResults?search=:
+  #   $ref: './paths/search/getNoResultTopFilters.yml'
+  # /2/filters/{attribute list}?search=:
+  #   $ref: './paths/search/getSearchAttributesTopFilters.yml'
+  # /2/filters/{attribute}:
+  #   $ref: './paths/search/getAttributeTopFilters.yml'
+  # /2/countries:
+  #   $ref: './paths/search/getTopCountries.yml'
+  #
+  # #################################
+  # ### Click Analytics Endpoints ###
+  # #################################
+  # /2/clicks/averageClickPosition:
+  #   $ref: './paths/click/getAverageTopClickPosition.yml'
+  # /2/clicks/positions:
+  #   $ref: './paths/click/getClickPositions.yml'
+  # /2/clicks/clickThroughRate:
+  #   $ref: './paths/click/getClickThroughRate.yml'
+  # /2/conversions/conversionRate:
+  #   $ref: './paths/click/getConversionRate.yml'

specs/common/securitySchemes.yml

@@ -0,0 +1,8 @@
+appId:
+  type: apiKey
+  in: header
+  name: X-Algolia-Application-Id
+apiKey:
+  type: apiKey
+  in: header
+  name: X-Algolia-API-Key

specs/insights/paths/pushEvents.yml

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

specs/insights/spec.yml

@@ -0,0 +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'

specs/personalization/paths/deleteUserProfile.yml

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

specs/personalization/paths/getUserTokenProfile.yml

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

specs/personalization/paths/personalizationStrategy.yml

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

specs/personalization/spec.yml

@@ -0,0 +1,21 @@
+openapi: 3.0.2
+info:
+  title: Personalization API
+  description: API powering the Personalization 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/profiles/personalization/{userToken}:
+    $ref: './paths/getUserTokenProfile.yml'
+#  /1/profiles/{userToken}:
+#    $ref: './paths/deleteUserProfile.yml'
+#  /1/strategies/personalization:
+#    $ref: './paths/personalizationStrategy.yml'

specs/query_suggestions/paths/getConfigurationStatus.yml

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

specs/query_suggestions/paths/getLogFile.yml

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

specs/query_suggestions/paths/qsConfig.yml

@@ -0,0 +1,3 @@
+put:
+delete:
+get:

specs/query_suggestions/paths/qsConfigs.yml

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

specs/query_suggestions/spec.yml

@@ -0,0 +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'
+#  /1/configs/{indexName}:
+#    $ref: './paths/qsConfig.yml'
+#  /1/configs/{indexName}/status:
+#    $ref: './paths/getConfigurationStatus.yml'
+#  /1/logs/{indexName}:
+#    $ref: './paths/getLogFile.yml'

specs/recommend/paths/getRecommendations.yml

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

specs/recommend/spec.yml

@@ -0,0 +1,17 @@
+openapi: 3.0.2
+info:
+  title: Recommend API
+  description: API powering the Recommend 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/indexes/*/recommendations:
+    $ref: './paths/getRecommendations.yml'

specs/responses/BadRequest.yml → specs/search/common/responses/BadRequest.yml

@@ -2,4 +2,4 @@ description: Bad request or request arguments
 content:
   application/json:
     schema:
-      $ref: '../schemas/ErrorBase.yml'
+      $ref: '../../../common/schemas/ErrorBase.yml'

specs/responses/IndexNotFound.yml → specs/search/common/responses/IndexNotFound.yml

@@ -2,4 +2,4 @@ description: Index not found
 content:
   application/json:
     schema:
-      $ref: '../schemas/ErrorBase.yml'
+      $ref: '../../../common/schemas/ErrorBase.yml'

specs/schemas/Record.yml → specs/search/common/schemas/Record.yml

@@ -6,7 +6,7 @@ record:
     - objectID
   properties:
     objectID:
-      $ref: '../responses/common.yml#/objectID'
+      $ref: '../../../common/responses/common.yml#/objectID'
     _highlightResult:
       $ref: '#/highlightResult'
     _snippetResult:

specs/schemas/SearchResponse.yml → specs/search/common/schemas/SearchResponse.yml

@@ -14,9 +14,9 @@ searchResponse:
     - params
   properties:
     abTestID:
-      $ref: ../responses/common.yml#/abTestID
+      $ref: ../../../common/responses/common.yml#/abTestID
     abTestVariantID:
-      $ref: ../responses/common.yml#/abTestVariantID
+      $ref: ../../../common/responses/common.yml#/abTestVariantID
     aroundLatLng:
       type: string
       description: The computed geo location.

specs/search/paths/advanced/getLogs.yml

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

specs/search/paths/advanced/getTask.yml

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

specs/search/paths/advanced/isAlive.yml

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

specs/search/paths/dictionaries/batchDictionaryEntries.yml

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

specs/search/paths/dictionaries/dictionarySettings.yml

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

specs/search/paths/dictionaries/getDictionaryLanguages.yml

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

specs/search/paths/dictionaries/searchDictionaryEntries.yml

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

specs/search/paths/keys/key.yml

@@ -0,0 +1,3 @@
+put:
+get:
+delete:

specs/search/paths/keys/keys.yml

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

specs/search/paths/keys/restoreApiKey.yml

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

specs/search/paths/manage_indices/copyIndex.yml

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

specs/search/paths/manage_indices/listIndices.yml

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

specs/search/paths/multiclusters/batchAssignUserIds.yml

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

specs/search/paths/multiclusters/getTopUserIds.yml

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

specs/search/paths/multiclusters/hasPendingMappings.yml

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

specs/search/paths/multiclusters/listClusters.yml

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

specs/search/paths/multiclusters/searchUserIds.yml

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

specs/search/paths/multiclusters/userId.yml

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

specs/search/paths/multiclusters/userIds.yml

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