feat(specs): add authentications to ingestion transformations (#3494)

algolia · Aug 8, 2024 · 7d2ab99 · 7d2ab99
1 parent 078868b
commit 7d2ab99
Show file tree

Hide file tree

Showing 6 changed files with 152 additions and 1 deletion.
diff --git a/specs/ingestion/common/schemas/transformation.yml b/specs/ingestion/common/schemas/transformation.yml
@@ -4,6 +4,8 @@ Transformation:
   properties:
     transformationID:
       $ref: './common.yml#/transformationID'
+    authenticationIDs:
+      $ref: '#/AuthenticationIDs'
     code:
       $ref: '#/Code'
     name:
@@ -32,6 +34,12 @@ Description:
   type: string
   description: A descriptive name for your transformation of what it does.
 
+AuthenticationIDs:
+  description: The authentications associated for the current transformation.
+  type: array
+  items:
+    $ref: './common.yml#/authenticationID'
+
 TransformationCreate:
   type: object
   additionalProperties: false
@@ -43,6 +51,8 @@ TransformationCreate:
       $ref: '#/Name'
     description:
       $ref: '#/Description'
+    authenticationIDs:
+      $ref: '#/AuthenticationIDs'
   required:
     - code
     - name
@@ -93,6 +103,10 @@ TransformationTry:
     sampleRecord:
       description: The record to apply the given code to.
       type: object
+    authentications:
+      type: array
+      items:
+        $ref: './authentication.yml#/AuthenticationCreate'
   required:
     - code
     - sampleRecord

diff --git a/specs/ingestion/paths/transformations/transformationTryID.yml b/specs/ingestion/paths/transformations/transformationTryID.yml
@@ -0,0 +1,27 @@
+post:
+  tags:
+    - transformations
+  summary: Try a transformation
+  description: Try a transformation before updating it.
+  operationId: tryTransformationBeforeUpdate
+  x-acl:
+    - addObject
+    - deleteIndex
+    - editSettings
+  parameters:
+    - $ref: '../../common/parameters.yml#/pathTransformationID'
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: '../../common/schemas/transformation.yml#/TransformationTry'
+    required: true
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: '../../common/schemas/transformation.yml#/TransformationTryResponse'
+    '400':
+      $ref: '../../../common/responses/BadRequest.yml'
diff --git a/specs/ingestion/paths/transformations/transformationsTry.yml b/specs/ingestion/paths/transformations/transformationsTry.yml
@@ -2,7 +2,7 @@ post:
   tags:
     - transformations
   summary: Try a transformation
-  description: Try a transformation.
+  description: Try a transformation before creating it.
   operationId: tryTransformation
   x-acl:
     - addObject

diff --git a/specs/ingestion/spec.yml b/specs/ingestion/spec.yml
@@ -179,6 +179,8 @@ paths:
     $ref: 'paths/transformations/transformationsModels.yml'
   /1/transformations/{transformationID}:
     $ref: 'paths/transformations/transformationID.yml'
+  /1/transformations/{transformationID}/try:
+    $ref: 'paths/transformations/transformationTryID.yml'
 
   # observability API.
   /1/runs:

diff --git a/tests/CTS/requests/ingestion/tryTransformation.json b/tests/CTS/requests/ingestion/tryTransformation.json
@@ -16,5 +16,46 @@
         }
       }
     }
+  },
+  {
+    "testName": "with authentications",
+    "parameters": {
+      "code": "foo",
+      "sampleRecord": {
+        "bar": "baz"
+      },
+      "authentications": [
+        {
+          "type": "oauth",
+          "name": "authName",
+          "input": {
+            "url": "http://test.oauth",
+            "client_id": "myID",
+            "client_secret": "mySecret"
+          }
+        }
+      ]
+    },
+    "request": {
+      "path": "/1/transformations/try",
+      "method": "POST",
+      "body": {
+        "code": "foo",
+        "sampleRecord": {
+          "bar": "baz"
+        },
+        "authentications": [
+          {
+            "type": "oauth",
+            "name": "authName",
+            "input": {
+              "url": "http://test.oauth",
+              "client_id": "myID",
+              "client_secret": "mySecret"
+            }
+          }
+        ]
+      }
+    }
   }
 ]
diff --git a/tests/CTS/requests/ingestion/tryTransformationBeforeUpdate.json b/tests/CTS/requests/ingestion/tryTransformationBeforeUpdate.json
@@ -0,0 +1,67 @@
+[
+  {
+    "parameters": {
+      "transformationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
+      "transformationTry": {
+        "code": "foo",
+        "sampleRecord": {
+          "bar": "baz"
+        }
+      }
+    },
+    "request": {
+      "path": "/1/transformations/6c02aeb1-775e-418e-870b-1faccd4b2c0f/try",
+      "method": "POST",
+      "body": {
+        "code": "foo",
+        "sampleRecord": {
+          "bar": "baz"
+        }
+      }
+    }
+  },
+  {
+    "testName": "existing with authentications",
+    "parameters": {
+      "transformationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
+      "transformationTry": {
+        "code": "foo",
+        "sampleRecord": {
+          "bar": "baz"
+        },
+        "authentications": [
+          {
+            "type": "oauth",
+            "name": "authName",
+            "input": {
+              "url": "http://test.oauth",
+              "client_id": "myID",
+              "client_secret": "mySecret"
+            }
+          }
+        ]
+      }
+    },
+    "request": {
+      "path": "/1/transformations/6c02aeb1-775e-418e-870b-1faccd4b2c0f/try",
+      "method": "POST",
+      "body": {
+        "code": "foo",
+        "sampleRecord": {
+          "bar": "baz"
+        },
+        "authentications": [
+          {
+            "type": "oauth",
+            "name": "authName",
+            "input": {
+              "url": "http://test.oauth",
+              "client_id": "myID",
+              "client_secret": "mySecret"
+            }
+          }
+        ]
+      }
+    }
+  }
+]