Add groupId to schema and examples

m-houston · m-houston · commit 86342b020b1a · 2025-09-08T09:58:46.000Z
diff --git a/specification/api/components/examples/createMI/requests/createMIRequest.json b/specification/api/components/examples/createMI/requests/createMIRequest.json
@@ -2,6 +2,7 @@
   "data": {
     "attributes": {
       "cost": 10.25,
+      "groupId": "abc123",
       "lineItem": "Letter",
       "quantity": 22,
       "specificationId": "da0b1495-c7cb-468c-9d81-07dee089d728",
diff --git a/specification/api/components/examples/createMI/responses/createMIResponse.json b/specification/api/components/examples/createMI/responses/createMIResponse.json
@@ -2,6 +2,7 @@
   "data": {
     "attributes": {
       "cost": 10.25,
+      "groupId": "abc123",
       "lineItem": "Letter",
       "quantity": 22,
       "specificationId": "da0b1495-c7cb-468c-9d81-07dee089d728",
diff --git a/specification/api/components/examples/getLetter/responses/getLetter.json b/specification/api/components/examples/getLetter/responses/getLetter.json
@@ -1,6 +1,7 @@
 {
   "data": {
     "attributes": {
+      "groupId": "abc123",
       "reasonCode": 100,
       "reasonText": "failed validation",
       "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
diff --git a/specification/api/components/examples/getLetters/responses/getLetters.json b/specification/api/components/examples/getLetters/responses/getLetters.json
@@ -2,6 +2,7 @@
   "data": [
     {
       "attributes": {
+        "groupId": "abc123",
         "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
         "status": "PENDING"
       },
diff --git a/specification/api/components/examples/patchLetter/responses/patchLetter.json b/specification/api/components/examples/patchLetter/responses/patchLetter.json
@@ -1,6 +1,7 @@
 {
   "data": {
     "attributes": {
+      "groupId": "abc123",
       "reasonCode": 100,
       "reasonText": "failed validation",
       "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
diff --git a/specification/api/components/examples/postLetter/responses/postLetter.json b/specification/api/components/examples/postLetter/responses/postLetter.json
@@ -2,6 +2,7 @@
   "data": [
     {
       "attributes": {
+        "groupId": "abc123",
         "reasonCode": 100,
         "reasonText": "failed validation",
         "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
diff --git a/specification/api/components/schemas/letterItem.yml b/specification/api/components/schemas/letterItem.yml
@@ -15,6 +15,9 @@ properties:
       specificationId:
         type: string
         example: 2WL5eYSWGzCHlGmzNxuqVusPxDg
+      groupId:
+        type: string
+        example: abc123
       status:
         $ref: "./letterStatus.yml"
       reasonCode:
diff --git a/specification/api/components/schemas/miData.yml b/specification/api/components/schemas/miData.yml
@@ -12,6 +12,9 @@ properties:
           specificationId:
             type: string
             example: da0b1495-c7cb-468c-9d81-07dee089d728
+          groupId:
+            type: string
+            example: abc123
           timestamp:
             type: string
             format: date-time
diff --git a/specification/api/components/schemas/miItem.yml b/specification/api/components/schemas/miItem.yml
@@ -9,9 +9,12 @@ properties:
   attributes:
     type: object
     properties:
-      messageReference:
+      specificationId:
         type: string
         example: da0b1495-c7cb-468c-9d81-07dee089d728
+      groupId:
+        type: string
+        example: abc123
       timestamp:
         type: string
         format: date-time

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"data": {`
`3`	`3`	`"attributes": {`
	`4`	`+ "groupId": "abc123",`
`4`	`5`	`"reasonCode": 100,`
`5`	`6`	`"reasonText": "failed validation",`
`6`	`7`	`"specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`"data": [`
`3`	`3`	`{`
`4`	`4`	`"attributes": {`
	`5`	`+ "groupId": "abc123",`
`5`	`6`	`"specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",`
`6`	`7`	`"status": "PENDING"`
`7`	`8`	`},`