fix(specs): query suggestions api (#2924)

Co-authored-by: shortcuts <vannicattec@gmail.com>

Author: kai687

specs/query-suggestions/common/enums.yml

@@ -2,7 +2,7 @@ LogLevel:
   title: level
   type: string
   description: |
-    The type of log entry. 
+    Type of log entry.
 
     - `SKIP`. A query is skipped because it doesn't match the conditions for successful inclusion. For example, when a query doesn't generate enough search results.
     - `INFO`. An informative log entry.

specs/query-suggestions/common/responses/BadRequest.yml

@@ -2,31 +2,33 @@ description: Bad Request.
 content:
   application/json:
     schema:
-      $ref: '../schemas/BaseResponse.yml'
+      $ref: './BaseResponse.yml'
     examples:
       IndexNameRequired:
         summary: Index name required.
-        value: {'status': 400, 'message': 'IndexName cannot be empty'}
+        value:
+          status: 400
+          message: IndexName cannot be empty.
       SourceIndicesRequired:
         summary: Source indices required.
         value:
-          'status': 400
-          'message': 'Invalid body "sourceIndices needs to contain at least one index".'
-          
+          status: 400
+          message: Invalid body "sourceIndices needs to contain at least one index".
+
       SourceIndexNameRequired:
         summary: Source index name required.
         value:
-          'status': 400
-          'message': 'Invalid body "every source index must have an `indexName`".'
-          
+          status: 400
+          message: Invalid body "every source index must have an `indexName`".
+
       MinHitsPositive:
         summary: MinHits must be positive.
         value:
-          'status': 400
-          'message': 'Invalid body "every source index `minHits` must be positive".'
-          
+          status: 400
+          message: Invalid body "every source index `minHits` must be positive".
+
       MinLettersPositive:
         summary: MinLetters must be positive.
         value:
-          'status': 400
-          'message': 'Invalid body "every source index `minLetters` must be positive".'
+          status: 400
+          message: Invalid body "every source index `minLetters` must be positive".

specs/query-suggestions/common/schemas/BaseResponse.yml renamed to specs/query-suggestions/common/responses/BaseResponse.yml

@@ -1,5 +1,4 @@
 type: object
-additionalProperties: false
 properties:
   status:
     type: integer

specs/query-suggestions/common/responses/InternalError.yml

@@ -2,8 +2,10 @@ description: Internal Server Error.
 content:
   application/json:
     schema:
-      $ref: '../schemas/BaseResponse.yml'
+      $ref: './BaseResponse.yml'
     examples:
       Error:
         description: This error can happen if you use a non-existing `indexName` as a path parameter when trying to update or delete a Query Suggestions configuration.
-        value: {'status': 500, 'message': 'Internal Server Error'}
+        value:
+          status: 500
+          message: Internal Server Error

specs/query-suggestions/common/responses/NotFound.yml

@@ -2,8 +2,10 @@ description: Not Found.
 content:
   application/json:
     schema:
-      $ref: '../schemas/BaseResponse.yml'
+      $ref: './BaseResponse.yml'
     examples:
       NotFound:
         summary: Index not found.
-        value: {'status': 404, 'message': 'Not Found'}
+        value:
+          status: 404
+          message: Not Found

specs/query-suggestions/common/responses/QuerySuggestionsConfigurationResponse.yml

@@ -0,0 +1,20 @@
+QuerySuggestionsConfigurationResponse:
+  type: object
+  description: API response for retrieving Query Suggestions configurations.
+  allOf:
+    - $ref: '#/AppID'
+    - $ref: '../schemas/QuerySuggestionsConfiguration.yml#/QuerySuggestionsConfigurationWithIndex'
+  required:
+    - appID
+    - allowSpecialCharacters
+    - enablePersonalization
+    - exclude
+    - languages
+    - sourceIndices
+
+AppID:
+  type: object
+  properties:
+    appID:
+      type: string
+      description: Algolia application ID to which this Query Suggestions configuration belongs.

specs/query-suggestions/common/responses/Unauthorized.yml

@@ -2,24 +2,27 @@ description: Unauthorized
 content:
   application/json:
     schema:
-      $ref: '../schemas/BaseResponse.yml'
+      $ref: './BaseResponse.yml'
     examples:
       Unauthorized:
         summary: Wrong region.
         description: |
-          Make sure to make your request to the server corresponding to your region.  
+          Make sure to make your request to the server corresponding to your region.
 
           You can check the region for your application in the [Algolia dashboard](https://dashboard.algolia.com/account/infrastructure/analytics).
         value:
-          'status': 401
-          'message': 'The log processing region does not match'
-          
+          status: 401
+          message: The log processing region does not match.
+
       InvalidCredentials:
         summary: Invalid credentials.
         description: Your application ID or API key is wrong.
-        value: {'status': 401, 'message': 'Invalid credentials'}
+        value:
+          status: 401
+          message: Invalid credentials
       MissingACL:
         summary: Key is missing ACL.
         description: Your API key is missing the required ACL for this operation.
         value:
-          {'status': 401, 'message': 'The provided API key is missing the \"editSettings\" ACL'}
+          status: 401
+          message: The provided API key is missing the \"editSettings\" ACL.

specs/query-suggestions/common/responses/UnprocessableEntity.yml

@@ -2,10 +2,10 @@ description: Unprocessable Entity.
 content:
   application/json:
     schema:
-      $ref: '../schemas/BaseResponse.yml'
+      $ref: './BaseResponse.yml'
     examples:
       UnprocessableEntity:
         summary: Configuration already exists.
-        value: 
-          'status': 422
-          'message': 'Configuration already exists for index: test-qs'
+        value:
+          status: 422
+          message: 'Configuration already exists for index: test-qs'