Add support for linked libraries to WRSC event schema

umccr · Aug 20, 2024 · 1e2b8b3 · 1e2b8b3
1 parent 029a2bb
commit 1e2b8b3
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 0 deletions.
diff --git a/docs/schemas/events/executionservice/WorkflowRunStateChange.schema.json b/docs/schemas/events/executionservice/WorkflowRunStateChange.schema.json
@@ -77,11 +77,32 @@
         "workflowRunName": {
           "type": "string"
         },
+        "linkedLibraries": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/LibraryRecord"
+          }
+        },
         "payload": {
           "$ref": "#/definitions/Payload"
         }
       }
     },
+    "LibraryRecord": {
+      "type": "object",
+      "required": [
+        "libraryId",
+        "orcabusId"
+      ],
+      "properties": {
+        "libraryId": {
+          "type": "string"
+        },
+        "orcabusId": {
+          "type": "string"
+        }
+      }
+    },
     "Payload": {
       "type": "object",
       "required": [

diff --git a/docs/schemas/events/executionservice/example/WRSC__example1.json b/docs/schemas/events/executionservice/example/WRSC__example1.json
@@ -15,6 +15,16 @@
     "workflowName": "BclConvert",
     "workflowVersion": "4.2.7",
     "workflowRunName": "540424_A01001_0193_BBBBMMDRX5",
+    "linkedLibraries": [
+      {
+        "libraryId": "L000001",
+        "orcabusId": "lib.01J5M2J44HFJ9424G7074NKTGN"
+      },
+      {
+        "libraryId": "L000002",
+        "orcabusId": "lib.01J5M2JFE1JPYV62RYQEG99CP5"
+      }
+    ],
     "payload": {
       "version": "0.1.0",
       "data": {

diff --git a/docs/schemas/events/workflowmanager/WorkflowRunStateChange.schema.json b/docs/schemas/events/workflowmanager/WorkflowRunStateChange.schema.json
@@ -73,11 +73,32 @@
         "workflowRunName": {
           "type": "string"
         },
+        "linkedLibraries": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/LibraryRecord"
+          }
+        },
         "payload": {
           "$ref": "#/definitions/Payload"
         }
       }
     },
+    "LibraryRecord": {
+      "type": "object",
+      "required": [
+        "libraryId",
+        "orcabusId"
+      ],
+      "properties": {
+        "libraryId": {
+          "type": "string"
+        },
+        "orcabusId": {
+          "type": "string"
+        }
+      }
+    },
     "Payload": {
       "type": "object",
       "required": [

diff --git a/docs/schemas/events/workflowmanager/example/WRSC__example1.json b/docs/schemas/events/workflowmanager/example/WRSC__example1.json
@@ -14,6 +14,16 @@
     "workflowName": "<fill-by-workflow-manager> e.g. bssh_icav2_fastq_copy",
     "workflowVersion": "<fill-by-workflow-manager> e.g. 1.2.3",
     "workflowRunName": "<fill-by-workflow-manager> e.g. 540424_A01001_0193_BBBBMMDRX5 FASTQ Copy",
+    "linkedLibraries": [
+      {
+        "libraryId": "L000001",
+        "orcabusId": "lib.01J5M2J44HFJ9424G7074NKTGN"
+      },
+      {
+        "libraryId": "L000002",
+        "orcabusId": "lib.01J5M2JFE1JPYV62RYQEG99CP5"
+      }
+    ],
     "payload": {
       "refId": "<fill-by-workflow-manager> e.g. <uuid>",
       "version": "0.1.0",