feat(javascript): add discover handlers to source model (#2096)

Author: Fluf22

specs/ingestion/common/schemas/source.yml

@@ -349,3 +349,7 @@ SourceUpdateInput:
     - $ref: '#/SourceCSV'
     - $ref: '#/SourceBigQuery'
     - $ref: '#/SourceUpdateDocker'
+
+DockerSourceStream:
+  type: object
+  description: A stream definition (see Singer specification for details).

specs/ingestion/paths/sources/discover.yml

@@ -0,0 +1,54 @@
+get:
+  tags:
+    - sources
+  summary: Retrieve a stream listing.
+  description: Retrieve a stream listing for a given Singer specification compatible docker type source ID.
+  operationId: getDockerSourceStreams
+  parameters:
+    - $ref: '../../common/parameters.yml#/pathSourceID'
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            title: dockerSourceStreams
+            type: object
+            additionalProperties: false
+            properties:
+              streams:
+                type: array
+                items:
+                  $ref: '../../common/schemas/source.yml#/DockerSourceStream'
+            required:
+              - streams
+    '400':
+      $ref: '../../../common/responses/BadRequest.yml'
+
+post:
+  tags:
+    - sources
+  summary: Trigger a stream listing request.
+  description: Trigger a stream listing request for a Singer specification compatible docker type source.
+  operationId: triggerDockerSourceDiscover
+  parameters:
+    - $ref: '../../common/parameters.yml#/pathSourceID'
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            title: dockerSourceDiscover
+            type: object
+            additionalProperties: false
+            properties:
+              runID:
+                $ref: '../../common/schemas/common.yml#/runID'
+              createdAt:
+                $ref: '../../common/schemas/common.yml#/createdAt'
+            required:
+              - runID
+              - createdAt
+    '400':
+      $ref: '../../../common/responses/BadRequest.yml'

specs/ingestion/spec.yml

@@ -66,6 +66,8 @@ paths:
     $ref: 'paths/sources/searchSources.yml'
   /1/sources/{sourceID}:
     $ref: 'paths/sources/sourceID.yml'
+  /1/sources/{sourceID}/discover:
+    $ref: 'paths/sources/discover.yml'
 
   # tasks API.
   /1/tasks:

tests/CTS/methods/requests/ingestion/getDockerSourceStreams.json

@@ -0,0 +1,12 @@
+[
+  {
+    "testName": "getDockerSourceStreams",
+    "parameters": {
+      "sourceID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f"
+    },
+    "request": {
+      "path": "/1/sources/6c02aeb1-775e-418e-870b-1faccd4b2c0f/discover",
+      "method": "GET"
+    }
+  }
+]

tests/CTS/methods/requests/ingestion/triggerDockerSourceDiscover.json

@@ -0,0 +1,12 @@
+[
+  {
+    "testName": "triggerDockerSourceDiscover",
+    "parameters": {
+      "sourceID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f"
+    },
+    "request": {
+      "path": "/1/sources/6c02aeb1-775e-418e-870b-1faccd4b2c0f/discover",
+      "method": "POST"
+    }
+  }
+]