fix(specs): correct mistakes (#509)

Co-authored-by: Clément Vannicatte <[email protected]>

Author: Haroenv

clients/algoliasearch-client-javascript/packages/client-common/src/transporter/createTransporter.ts

@@ -292,7 +292,7 @@ export function createTransporter({
     const cacheable = Boolean(requestOptions.cacheable || request.cacheable);
 
     /**
-     * If is not "cacheable", we immediatly trigger the retryable request, no
+     * If is not "cacheable", we immediately trigger the retryable request, no
      * need to check cache implementations.
      */
     if (cacheable !== true) {
@@ -315,7 +315,7 @@ export function createTransporter({
 
     /**
      * With the computed key, we first ask the responses cache
-     * implemention if this request was been resolved before.
+     * implementation if this request was been resolved before.
      */
     return responsesCache.get(
       key,

clients/algoliasearch-client-javascript/packages/client-common/src/types/Transporter.ts

@@ -7,7 +7,7 @@ export type QueryParameters = Record<string, any>;
 
 export type RequestOptions = {
   /**
-   * Custom timeout for the request. Note that, in normal situacions
+   * Custom timeout for the request. Note that, in normal situations
    * the given timeout will be applied. But the transporter layer may
    * increase this timeout if there is need for it.
    */
@@ -64,7 +64,7 @@ export type AlgoliaAgent = {
   value: string;
 
   /**
-   * Mutates the current user agent ading the given user agent options.
+   * Mutates the current user agent adding the given user agent options.
    */
   add: (options: AlgoliaAgentOptions) => AlgoliaAgent;
 };
@@ -84,23 +84,23 @@ export type TransporterOptions = {
 
   /**
    * The underlying requester used. Should differ
-   * depending of the enviroment where the client
+   * depending of the environment where the client
    * will be used.
    */
   requester: Requester;
 
   /**
    * The cache of the requests. When requests are
    * `cacheable`, the returned promised persists
-   * in this cache to shared in similar resquests
+   * in this cache to shared in similar requests
    * before being resolved.
    */
   requestsCache: Cache;
 
   /**
    * The cache of the responses. When requests are
    * `cacheable`, the returned responses persists
-   * in this cache to shared in similar resquests.
+   * in this cache to shared in similar requests.
    */
   responsesCache: Cache;
 
@@ -145,23 +145,23 @@ export type Transporter = {
 
   /**
    * The underlying requester used. Should differ
-   * depending of the enviroment where the client
+   * depending of the environment where the client
    * will be used.
    */
   requester: Requester;
 
   /**
    * The cache of the requests. When requests are
    * `cacheable`, the returned promised persists
-   * in this cache to shared in similar resquests
+   * in this cache to shared in similar requests
    * before being resolved.
    */
   requestsCache: Cache;
 
   /**
    * The cache of the responses. When requests are
    * `cacheable`, the returned responses persists
-   * in this cache to shared in similar resquests.
+   * in this cache to shared in similar requests.
    */
   responsesCache: Cache;
 
@@ -194,7 +194,7 @@ export type Transporter = {
 
   /**
    * Performs a request.
-   * The `baseRequest` and `baseRequestOptions` will be merged accordignly.
+   * The `baseRequest` and `baseRequestOptions` will be merged accordingly.
    */
   request: <TResponse>(
     baseRequest: Request,

specs/abtesting/common/parameters.yml

@@ -34,4 +34,4 @@ description:
 
 trafficPercentage:
   type: integer
-  description: The traffic perfecentage for the A/B test.
+  description: The traffic percentage for the A/B test.

specs/common/responses/Success.yml

@@ -3,7 +3,7 @@ content:
   application/json:
     schema:
       type: object
-      title: SucessResponse
+      title: SuccessResponse
       additionalProperties: false
       required:
         - status

specs/query-suggestions/common/schemas/QuerySuggestionsIndex.yml

@@ -27,12 +27,12 @@ SourceIndicesWithReplicas:
   type: array
   description: List of source indices used to generate a Query Suggestions index.
   items:
-    $ref: '#/SourceIndiceWithReplicas'
+    $ref: '#/SourceIndexWithReplicas'
 
-SourceIndiceWithReplicas:
+SourceIndexWithReplicas:
   type: object
   additionalProperties: false
-  description: Source indice with replicas used to generate a Query Suggestions index.
+  description: Source index with replicas used to generate a Query Suggestions index.
   required:
     - replicas
     - indexName

specs/query-suggestions/paths/qsConfig.yml

@@ -54,7 +54,7 @@ delete:
   description: >
     Delete a configuration of a Query Suggestion's index.
 
-    By deleting a configuraton, you stop all updates to the underlying query suggestion index.
+    By deleting a configuration, you stop all updates to the underlying query suggestion index.
 
     Note that when doing this, the underlying index does not change - existing suggestions remain untouched.
   parameters:

specs/search/common/schemas/SearchResponse.yml

@@ -63,7 +63,7 @@ baseSearchResponse:
       description: Indicate if the nbHits count was exhaustive or approximate.
     exhaustiveTypo:
       type: boolean
-      description: Indicate if the typo-tolerence search was exhaustive or approximate (only included when typo-tolerance is enabled).
+      description: Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
     facets:
       type: object
       additionalProperties:

specs/search/common/schemas/listIndicesResponse.yml

@@ -6,13 +6,13 @@ listIndicesResponse:
       type: array
       description: List of the fetched indices.
       items:
-        $ref: '#/indice'
+        $ref: '#/fetchedIndex'
     nbPages:
       type: integer
       description: Number of pages.
       example: 100
 
-indice:
+fetchedIndex:
   type: object
   additionalProperties: false
   properties:

specs/search/paths/advanced/getLogs.yml

@@ -51,7 +51,7 @@ get:
                       description: Timestamp in ISO-8601 format.
                     method:
                       type: string
-                      description: HTTP method of the perfomed request.
+                      description: HTTP method of the performed request.
                     answer_code:
                       type: string
                       description: HTTP response code.
@@ -66,7 +66,7 @@ get:
                       description: Request URL.
                     ip:
                       type: string
-                      description: IP of the client which perfomed the request.
+                      description: IP of the client which performed the request.
                     query_headers:
                       type: string
                       description: Request Headers (API Key is obfuscated).

specs/search/paths/dictionaries/batchDictionaryEntries.yml

@@ -1,6 +1,6 @@
 post:
   tags:
-    - Dictionnaries
+    - Dictionaries
   operationId: batchDictionaryEntries
   description: Send a batch of dictionary entries.
   summary: Batch dictionary entries.

specs/search/paths/dictionaries/dictionarySettings.yml

@@ -1,6 +1,6 @@
 get:
   tags:
-    - Dictionnaries
+    - Dictionaries
   operationId: getDictionarySettings
   description: Retrieve dictionaries settings. The API stores languages whose standard entries are disabled. Fetch settings does not return false values.
   summary: Retrieve dictionaries settings.
@@ -29,7 +29,7 @@ get:
 
 put:
   tags:
-    - Dictionnaries
+    - Dictionaries
   operationId: setDictionarySettings
   description: Set dictionaries settings.
   summary: Set dictionaries settings.

specs/search/paths/dictionaries/getDictionaryLanguages.yml

@@ -1,6 +1,6 @@
 get:
   tags:
-    - Dictionnaries
+    - Dictionaries
   operationId: getDictionaryLanguages
   description: List dictionaries supported per language.
   summary: List available languages.

specs/search/paths/dictionaries/searchDictionaryEntries.yml

@@ -1,6 +1,6 @@
 post:
   tags:
-    - Dictionnaries
+    - Dictionaries
   operationId: searchDictionaryEntries
   description: Search the dictionary entries.
   summary: Search a dictionary entries.

specs/search/paths/manage_indices/operationIndex.yml

@@ -3,7 +3,7 @@ post:
     - Indices
   operationId: operationIndex
   summary: Copy/move index.
-  description: Peforms a copy or a move operation on a index.
+  description: Performs a copy or a move operation on a index.
   parameters:
     - $ref: '../../../common/parameters.yml#/IndexName'
   requestBody:

specs/search/spec.yml

@@ -40,8 +40,8 @@ tags:
     description: Manage your Api Keys.
   - name: Clusters
     description: Clusters operations.
-  - name: Dictionnaries
-    description: Dictionnaries operations.
+  - name: Dictionaries
+    description: Dictionaries operations.
   - name: Indices
     description: Manage indices.
   - name: Records
@@ -68,7 +68,7 @@ x-tagGroups:
     tags:
       - Rules
       - Synonyms
-      - Dictionnaries
+      - Dictionaries
   - name: Others
     tags:
       - Api Keys