CCM-12281: Extend documentation and examples for ManagementInformation in OAS spec

Author: m-houston

specification/api/components/examples/createMI/requests/createMIRequest.json

@@ -1,9 +1,8 @@
 {
   "data": {
     "attributes": {
-      "cost": 10.25,
       "groupId": "abc123",
-      "lineItem": "Letter",
+      "lineItem": "envelope-business-standard",
       "quantity": 22,
       "specificationId": "da0b1495-c7cb-468c-9d81-07dee089d728",
       "stockRemaining": 2000,

specification/api/components/examples/createMI/responses/createMIResponse.json

@@ -1,9 +1,8 @@
 {
   "data": {
     "attributes": {
-      "cost": 10.25,
       "groupId": "abc123",
-      "lineItem": "Letter",
+      "lineItem": "envelope-business-standard",
       "quantity": 22,
       "specificationId": "da0b1495-c7cb-468c-9d81-07dee089d728",
       "stockRemaining": 2000,

specification/api/components/schemas/miData.yml

@@ -9,27 +9,32 @@ properties:
       attributes:
         type: object
         properties:
-          specificationId:
-            type: string
-            example: 2WL5eYSWGzCHlGmzNxuqVusPxDg
-          groupId:
+          lineItem:
+            description: "A line item reference that should match an invoice line item"
             type: string
-            example: abc123
+            example: envelope-business-standard
           timestamp:
+            description: "The effective date of the activity being reported"
             type: string
             format: date-time
             example: "2023-11-17T14:27:51.413Z"
-          lineItem:
-            type: string
-            example: Letter
           quantity:
+            description: "The quantity of the line item being reported"
             type: number
             example: 22
-          cost:
-            type: number
-            description: "Total Amount"
-            example: 10.25
+          specificationId:
+            description: "A specification ID provided in the Letter request that this MI relates to"
+            type: string
+            example: da0b1495-c7cb-468c-9d81-07dee089d728
+          groupId:
+            description: "A group ID provided in the Letter request that this MI relates to"
+            type: string
+            example: abc123
           stockRemaining:
+            description: "Stock remaining for this line item, where applicable"
             type: number
-            description: "Stock remaining for this line item"
             example: 20000
+        required:
+            - lineItem
+            - timestamp
+            - quantity

specification/api/components/schemas/miItem.yml

@@ -9,27 +9,32 @@ properties:
   attributes:
     type: object
     properties:
-      specificationId:
-        type: string
-        example: da0b1495-c7cb-468c-9d81-07dee089d728
-      groupId:
+      lineItem:
+        description: "A line item reference that should match an invoice line item"
         type: string
-        example: abc123
+        example: envelope-business-standard
       timestamp:
+        description: "The effective date of the activity being reported"
         type: string
         format: date-time
         example: "2023-11-17T14:27:51.413Z"
-      lineItem:
-        type: string
-        example: Letter
       quantity:
+        description: "The quantity of the line item being reported"
         type: number
         example: 22
-      cost:
-        type: number
-        description: "Total Amount"
-        example: 10.25
+      specificationId:
+        description: "A specification ID provided in the Letter request that this MI relates to"
+        type: string
+        example: da0b1495-c7cb-468c-9d81-07dee089d728
+      groupId:
+        description: "A group ID provided in the Letter request that this MI relates to"
+        type: string
+        example: abc123
       stockRemaining:
+        description: "Stock remaining for this line item, where applicable"
         type: number
-        description: "Stock remaining for this line item"
         example: 20000
+    required:
+        - lineItem
+        - timestamp
+        - quantity