New path to get the pipeline outputs.

Addresses #97
EOSC-synergy · Nov 22, 2021 · bf40bd5 · bf40bd5
1 parent d26a4dc
commit bf40bd5
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 3 deletions.
diff --git a/build/dist.yaml b/build/dist.yaml
@@ -652,7 +652,7 @@ paths:
               schema:
                 type: array
                 items:
-                  $ref: '#/components/schemas/Badge'
+                  $ref: '#/components/schemas/CriterionOutput'
         '400':
           description: Invalid pipeline ID supplied
         '404':
@@ -1064,6 +1064,14 @@ components:
       required:
         - upstream_status
         - upstream_reason
+    CriterionOutput:
+      type: object
+      properties:
+        id:
+          type: string
+          example: QC.Sty
+        stdout:
+          type: string
     Badge:
       type: object
       properties:

diff --git a/openapi/components/schemas/CriterionOutput.yaml b/openapi/components/schemas/CriterionOutput.yaml
@@ -0,0 +1,7 @@
+type: object
+properties:
+  id:
+    type: string
+    example: QC.Sty
+  stdout:
+    type: string
diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -44,3 +44,5 @@ paths:
     $ref: paths/pipeline_compressed_files.yaml
   /pipeline/{pipeline_id}/badge:
     $ref: paths/pipeline_badge.yaml
+  /pipeline/{pipeline_id}/output:
+    $ref: paths/pipeline_output.yaml
diff --git a/openapi/paths/pipeline_badge.yaml b/openapi/paths/pipeline_badge.yaml
@@ -36,7 +36,7 @@ get:
       schema:
         type: string
     - in: query
-      name: share 
+      name: share
       description: Returns the shared version of the badge in a specific format
       required: false
       schema:
@@ -52,7 +52,7 @@ get:
           schema:
             type: array
             items:
-              $ref: '../components/schemas/Badge.yaml'
+              $ref: '../components/schemas/CriterionOutput.yaml'
     '400':
       description: Invalid pipeline ID supplied
     '404':

diff --git a/openapi/paths/pipeline_output.yaml b/openapi/paths/pipeline_output.yaml
@@ -0,0 +1,25 @@
+get:
+  operationId: get_pipeline_output
+  summary: Get output from pipeline execution
+  parameters:
+    - in: path
+      name: pipeline_id
+      description: ID of the pipeline to get
+      required: true
+      schema:
+        type: string
+  description: >
+    Returns the console output from the pipeline execution.
+  responses:
+    '200':
+      description: Successful operation
+      content:
+        application/json:
+          schema:
+            type: array
+            items:
+              $ref: '../components/schemas/CriterionOutput.yaml'
+    '400':
+      description: Invalid pipeline ID supplied
+    '404':
+      description: Pipeline not found