fix(specs): getApiKeyResponse, multipleBatch, partialUpdateObject (#889)

Author: shortcuts

specs/common/responses/common.yml

@@ -13,6 +13,11 @@ createdAt:
   type: string
   description: Date of creation (ISO-8601 format).
 
+createdAtTimestamp:
+  type: integer
+  format: int64
+  description: Time of the event expressed in milliseconds since the Unix epoch.
+
 updatedAt:
   type: string
   description: Date of last update (ISO-8601 format).

specs/search/paths/keys/common/schemas.yml

@@ -9,7 +9,6 @@ apiKey:
       default: []
       items:
         $ref: '#/acl'
-
     description:
       type: string
       description: A comment used to identify a key more easily in the dashboard. It is not interpreted by the API.
@@ -47,20 +46,24 @@ apiKey:
 
 keyString:
   type: string
-  description: Key string.
+  description: The API key.
+
+getApiKeyResponse:
+  allOf:
+    - $ref: '#/baseGetApiKeyResponse'
+    - $ref: '#/apiKey'
 
-createdAtObject:
+baseGetApiKeyResponse:
   type: object
-  required:
-    - createdAt
+  additionalProperties: false
   properties:
+    value:
+      $ref: '#/keyString'
     createdAt:
-      $ref: '../../../../common/responses/common.yml#/createdAt'
-
-key:
-  allOf:
-    - $ref: '#/apiKey'
-    - $ref: '#/createdAtObject'
+      $ref: '../../../../common/responses/common.yml#/createdAtTimestamp'
+  required:
+    - key
+    - createdAt
 
 addApiKeyResponse:
   type: object
@@ -75,6 +78,21 @@ addApiKeyResponse:
     - createdAt
 
 acl:
+  description: |
+    List of rights for the API key. The following rights can be used:
+
+    addObject: allows to add/update an object in the index (copy/move index are also allowed with this right).
+    analytics: allows to retrieve the analytics through the Analytics API.
+    browse: allows to retrieve all index content via the browse API.
+    deleteIndex: allows to delete or clear index content.
+    deleteObject: allows to delete objects from the index.
+    editSettings: allows to change index settings.
+    listIndexes: allows to list all accessible indices.
+    logs: allows to get the logs.
+    recommendation: Allows usage of the Personalization dashboard and the Recommendation API.
+    search: allows to search the index.
+    seeUnretrievableAttributes: disable unretrievableAttributes feature for all operations returning records.
+    settings: allows to get index settings.
   type: string
   enum:
     - addObject

specs/search/paths/keys/key.yml

@@ -12,7 +12,7 @@ get:
       content:
         application/json:
           schema:
-            $ref: 'common/schemas.yml#/key'
+            $ref: 'common/schemas.yml#/getApiKeyResponse'
     '400':
       $ref: '../../../common/responses/BadRequest.yml'
     '402':

specs/search/paths/keys/keys.yml

@@ -20,7 +20,7 @@ get:
                 type: array
                 description: List of api keys.
                 items:
-                  $ref: 'common/schemas.yml#/key'
+                  $ref: 'common/schemas.yml#/getApiKeyResponse'
     '400':
       $ref: '../../../common/responses/BadRequest.yml'
     '402':

specs/search/paths/objects/common/schemas.yml

@@ -40,7 +40,7 @@ builtInOperation:
     - _operation
     - value
 
-attributeOrBuiltInOperation:
+attributeToUpdate:
   oneOf:
     - $ref: '#/attribute'
     - $ref: '#/builtInOperation'

specs/search/paths/objects/getObjects.yml

@@ -39,6 +39,8 @@ post:
                   indexName:
                     type: string
                     description: name of the index containing the object.
+          required:
+            - requests
   responses:
     '200':
       description: OK

specs/search/paths/objects/multipleBatch.yml

@@ -29,6 +29,12 @@ post:
                   indexName:
                     type: string
                     description: Index to target for this operation.
+                required:
+                  - action
+                  - body
+                  - indexName
+          required:
+            - requests
   responses:
     '200':
       description: OK
@@ -42,8 +48,13 @@ post:
               taskID:
                 type: object
                 description: List of tasksIDs per index.
+                additionalProperties:
+                  $ref: '../../../common/responses/common.yml#/taskID'
               objectIDs:
                 $ref: '../../../common/responses/common.yml#/objectIDs'
+            required:
+              - taskID
+              - objectIDs
     '400':
       $ref: '../../../common/responses/BadRequest.yml'
     '402':

specs/search/paths/objects/partialUpdate.yml

@@ -29,10 +29,9 @@ post:
           type: array
           items:
             type: object
-            title: attributeToUpdate
             description: Attribute to update.
             additionalProperties:
-              $ref: 'common/schemas.yml#/attributeOrBuiltInOperation'
+              $ref: 'common/schemas.yml#/attributeToUpdate'
   responses:
     '200':
       $ref: '../../../common/responses/UpdatedAtWithObjectId.yml'

templates/java/api.mustache

@@ -340,7 +340,7 @@ public class {{classname}} extends ApiClient {
    * @param timeout  The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)
    */
-  public Key waitForApiKey(
+  public GetApiKeyResponse waitForApiKey(
     ApiKeyOperation operation,
     String key,
     ApiKey apiKey,
@@ -358,7 +358,7 @@ public class {{classname}} extends ApiClient {
         () -> {
           return this.getApiKey(key, requestOptions);
         },
-        (Key respKey) -> {
+        (GetApiKeyResponse respKey) -> {
           // we need to convert to an ApiKey object to use the `equals` method
           ApiKey sameType = new ApiKey()
             .setAcl(respKey.getAcl())
@@ -378,7 +378,7 @@ public class {{classname}} extends ApiClient {
     }
 
     // bypass lambda restriction to modify final object
-    final Key[] addedKey = new Key[] { null };
+    final GetApiKeyResponse[] addedKey = new GetApiKeyResponse[] { null };
 
     // check the status of the getApiKey method
     TaskUtils.retryUntil(
@@ -421,7 +421,7 @@ public class {{classname}} extends ApiClient {
    * @param timeout  The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)
    */
-  public Key waitForApiKey(ApiKeyOperation operation, String key, int maxRetries, IntUnaryOperator timeout, RequestOptions requestOptions) {
+  public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation, String key, int maxRetries, IntUnaryOperator timeout, RequestOptions requestOptions) {
     return this.waitForApiKey(operation, key, null, maxRetries, timeout, requestOptions);
   }
 
@@ -434,7 +434,7 @@ public class {{classname}} extends ApiClient {
    * @param apiKey Necessary to know if an `update` operation has been processed, compare fields of the response with it.
    * @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)
    */
-  public Key waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey, RequestOptions requestOptions) {
+  public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey, RequestOptions requestOptions) {
     return this.waitForApiKey(operation, key, apiKey, TaskUtils.DEFAULT_MAX_RETRIES, TaskUtils.DEFAULT_TIMEOUT, requestOptions);
   }
 
@@ -446,7 +446,7 @@ public class {{classname}} extends ApiClient {
    * @param key The `key` that has been added, deleted or updated.
    * @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)
    */
-  public Key waitForApiKey(ApiKeyOperation operation, String key, RequestOptions requestOptions) {
+  public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation, String key, RequestOptions requestOptions) {
     return this.waitForApiKey(operation, key, null, TaskUtils.DEFAULT_MAX_RETRIES, TaskUtils.DEFAULT_TIMEOUT, requestOptions);
   }
 
@@ -460,7 +460,7 @@ public class {{classname}} extends ApiClient {
    * @param maxRetries The maximum number of retry. 50 by default. (optional)
    * @param timeout  The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)
    */
-  public Key waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey, int maxRetries, IntUnaryOperator timeout) {
+  public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey, int maxRetries, IntUnaryOperator timeout) {
     return this.waitForApiKey(operation, key, apiKey, maxRetries, timeout, null);
   }
 
@@ -473,7 +473,7 @@ public class {{classname}} extends ApiClient {
    * @param maxRetries The maximum number of retry. 50 by default. (optional)
    * @param timeout  The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)
    */
-  public Key waitForApiKey(ApiKeyOperation operation, String key, int maxRetries, IntUnaryOperator timeout) {
+  public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation, String key, int maxRetries, IntUnaryOperator timeout) {
     return this.waitForApiKey(operation, key, null, maxRetries, timeout, null);
   }
 
@@ -485,7 +485,7 @@ public class {{classname}} extends ApiClient {
    * @param key The `key` that has been added, deleted or updated.
    * @param apiKey Necessary to know if an `update` operation has been processed, compare fields of the response with it.
    */
-  public Key waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey) {
+  public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey) {
     return this.waitForApiKey(operation, key, apiKey, TaskUtils.DEFAULT_MAX_RETRIES, TaskUtils.DEFAULT_TIMEOUT, null);
   }
 
@@ -496,7 +496,7 @@ public class {{classname}} extends ApiClient {
    * @param operation The `operation` that was done on a `key`. (ADD or DELETE only)
    * @param key The `key` that has been added, deleted or updated.
    */
-  public Key waitForApiKey(ApiKeyOperation operation, String key) {
+  public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation, String key) {
     return this.waitForApiKey(operation, key, null, TaskUtils.DEFAULT_MAX_RETRIES, TaskUtils.DEFAULT_TIMEOUT, null);
   }
   {{/isSearchClient}}

templates/javascript/clients/client/api/helpers.mustache

@@ -56,9 +56,9 @@ waitForApiKey(
       Math.min(retryCount * 200, 5000),
   }: WaitForApiKeyOptions,
   requestOptions?: RequestOptions
-): Promise<ApiError | Key> {
+): Promise<ApiError | GetApiKeyResponse> {
   let retryCount = 0;
-  const baseIteratorOptions: IterableOptions<ApiError | Key> = {
+  const baseIteratorOptions: IterableOptions<ApiError | GetApiKeyResponse> = {
     aggregator: () => (retryCount += 1),
     error: {
       validate: () => retryCount >= maxRetries,

templates/javascript/clients/client/model/clientMethodProps.mustache

@@ -74,7 +74,7 @@ export type WaitForTaskOptions = WaitForOptions<GetTaskResponse> & {
   taskID: number;
 };
 
-export type WaitForApiKeyOptions = WaitForOptions<Key> & {
+export type WaitForApiKeyOptions = WaitForOptions<GetApiKeyResponse> & {
   /**
    * The API Key.
    */

tests/CTS/methods/requests/search/partialUpdateObject.json

@@ -3,7 +3,7 @@
     "parameters": {
       "indexName": "theIndexName",
       "objectID": "uniqueID",
-      "attributeOrBuiltInOperation": [
+      "attributeToUpdate": [
         {
           "id1": "test",
           "id2": {