Merge pull request #69 from SPINEProject/postman-api-schema

Postman api schema

Author: gregblt

.postman/api_ed3ea5f7-995a-4255-914e-5b12f7b8f03f

@@ -37,6 +37,7 @@ files[] = {"path":"API/workflow/workflowIdConfigure.json","metaData":{}}
 files[] = {"path":"API/workflowExecutionMatrix/workflowExecutionMatrix.json","metaData":{}}
 files[] = {"path":"API/workflowExecutionMatrix/workflowExecutionMatrixId.json","metaData":{}}
 files[] = {"path":"API/workflowExecutionMatrix/workflowExecutionMatrixIdAction.json","metaData":{}}
+files[] = {"path":"API/workflowExecutionMatrix/workflowExecutionMatrixIdGlobalAction.json","metaData":{}}
 files[] = {"path":"center.schema.json","metaData":{}}
 files[] = {"path":"cohort.schema.json","metaData":{}}
 files[] = {"path":"core.schema.json","metaData":{}}
@@ -48,6 +49,10 @@ files[] = {"path":"helpPanel.schema.json","metaData":{}}
 files[] = {"path":"imageFilter.schema.json","metaData":{}}
 files[] = {"path":"imageFilterAttribute.schema.json","metaData":{}}
 files[] = {"path":"imageFilterSnapshot.schema.json","metaData":{}}
+files[] = {"path":"import.schema.json","metaData":{}}
+files[] = {"path":"importSeries.schema.json","metaData":{}}
+files[] = {"path":"importSubject.schema.json","metaData":{}}
+files[] = {"path":"importVisit.schema.json","metaData":{}}
 files[] = {"path":"livePresenterExperiment.schema.json","metaData":{}}
 files[] = {"path":"livePresenterExperimentResult.schema.json","metaData":{}}
 files[] = {"path":"materializedTask.schema.json","metaData":{}}

package.json

@@ -12,7 +12,7 @@
     "workflow"
   ],
   "description": "Set of JSON schemas for the SPINE Virtual Laboratory",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "dependencies": {
     "ajv": "^6.12.2"
   },

schemas/API/index.json

@@ -1,7 +1,7 @@
 {
     "openapi": "3.0.0",
     "info": {
-        "version": "0.2",
+        "version": "0.2.3-dev",
         "title": "SPINE API",
         "description": "SPINE API"
     },
@@ -29,6 +29,9 @@
         "/workflow-execution-matrix/{workflowExecutionMatrixId}/action": {
             "$ref": "./workflowExecutionMatrix/workflowExecutionMatrixIdAction.json"
         },
+        "/workflow-execution-matrix/{workflowExecutionMatrixId}/global-action": {
+            "$ref": "./workflowExecutionMatrix/workflowExecutionMatrixIdGlobalAction.json"
+        },
         "/filter/{filterId}": {
             "$ref": "./filter/filterId.json"
         },

schemas/API/workflowExecutionMatrix/workflowExecutionMatrixIdGlobalAction.json

@@ -0,0 +1,54 @@
+{
+    "parameters": [
+        {
+            "name": "workflowExecutionMatrixId",
+            "in": "path",
+            "required": true,
+            "schema": {
+                "type": "string"
+            }
+        }
+    ],
+    "post": {
+        "security": [
+            {
+                "bearerAuth": []
+            }
+        ],
+        "tags": [
+            "workflow execution matrix"
+        ],
+        "summary": "/api/workflow-execution-matrix/workflowExecutionMatrixId/global-action",
+        "description": "This API is used to post an action (launch, ...) to all the case of a wf exec plan",
+        "requestBody": {
+            "required": true,
+            "content": {
+                "application/json": {
+                    "schema": {
+                        "$ref": "../../workflowExecutionMatrix.schema.json#/definitions/postWorkflowExecutionMatrixGlobalActionBody"
+                    },
+                    "examples": {
+                        "1": {
+                            "value": {
+                                "actionType": "LAUNCH"
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "responses": {
+            "200": {
+                "description": "200",
+                "content": {
+                    "application/json": {
+
+                    }
+                }
+            },
+            "500": {
+                "description": "Unexpected error"
+            }
+        }
+    }
+}