Merge branch 'master' into MODFIN-320

mod-orders/examples/expectCollection.sample

@@ -0,0 +1,29 @@
+{
+  "toBeExpected": [
+    {
+      "poLineId": "3f4f61ab-d3c2-47a9-baa6-c903a4cfba57",
+      "expected": 2,
+      "expectPieces": [
+        {
+          "id": "fe729e0b-5c56-4f0a-bb3a-33bc405d71a0",
+          "comment": "Captivating cover art for the first edition"
+        },
+        {
+          "id": "4d6b8cf9-73bd-4b3d-8f1b-5b7cbf02d03a",
+          "comment": "Intriguing chapter titles and compelling storyline"
+        }
+      ]
+    },
+    {
+      "poLineId": "7d9fe888-bc7e-4d4e-9241-0b5f2457e0a3",
+      "expected": 1,
+      "expectPieces": [
+        {
+          "id": "9a2e97e3-5f8b-4b2c-9e27-16c8e8993018",
+          "comment": "A thought-provoking conclusion in the final chapter"
+        }
+      ]
+    }
+  ],
+  "totalRecords": 3
+}

mod-orders/schemas/expectCollection.json

@@ -0,0 +1,62 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "A collection of expect",
+  "type": "object",
+  "properties": {
+    "toBeExpected": {
+      "description": "List of expect",
+      "id": "toBeExpected",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "poLineId": {
+            "description": "The id of the expect PO line",
+            "type": "string",
+            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
+          },
+          "expected": {
+            "description": "The number of pieces to expect",
+            "type": "integer"
+          },
+          "expectPieces": {
+            "description": "A collection of piece records",
+            "type": "array",
+            "id": "expectPieces",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "description": "The id of the piece",
+                  "type": "string",
+                  "$ref": "../../common/schemas/uuid.json"
+                },
+                "comment": {
+                  "description": "The free form notes pertaining to the piece",
+                  "type": "string"
+                }
+              },
+              "additionalProperties": false,
+              "required": [
+                "id"
+              ]
+            }
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "poLineId"
+        ]
+      }
+    },
+    "totalRecords": {
+      "description": "The total number of pieces to expect in the list",
+      "type": "integer"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "toBeExpected",
+    "totalRecords"
+  ]
+}