From 0960a9a82f57968ede102c42c9215f787dcb465b Mon Sep 17 00:00:00 2001
From: Andrew Butters <23127331+abutters@users.noreply.github.com>
Date: Thu, 15 Dec 2022 13:30:14 +0000
Subject: [PATCH] [DL-9311] Made the communicationsDate field optional in the
 API documentation for the penalties endpoint. Also made the description of
 that field consistent across late submission and late payment penalties.

---
 .../public/api/conf/1.0/schemas/penalties/Penalties.json     | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/resources/public/api/conf/1.0/schemas/penalties/Penalties.json b/resources/public/api/conf/1.0/schemas/penalties/Penalties.json
index b32c6291..3e930e76 100644
--- a/resources/public/api/conf/1.0/schemas/penalties/Penalties.json
+++ b/resources/public/api/conf/1.0/schemas/penalties/Penalties.json
@@ -161,7 +161,7 @@
                 ]
               },
               "communicationsDate": {
-                "description": "The date upon which a letter about the penalty was sent to the user.",
+                "description": "The date when a letter about the penalty was sent to the customer.",
                 "type": "string",
                 "example": "2022-07-01"
               },
@@ -262,7 +262,7 @@
                 "example": "2022-07-31"
               }
             },
-            "required": ["penaltyNumber", "penaltyOrder", "penaltyCategory", "penaltyStatus", "penaltyCreationDate", "penaltyExpiryDate", "communicationsDate"],
+            "required": ["penaltyNumber", "penaltyOrder", "penaltyCategory", "penaltyStatus", "penaltyCreationDate", "penaltyExpiryDate"],
             "additionalProperties": false
           }
         }
@@ -480,7 +480,6 @@
               "penaltyStatus",
               "penaltyAmountAccruing",
               "penaltyAmountPosted",
-              "communicationsDate",
               "principalChargeDocNumber",
               "principalChargeMainTransaction",
               "principalChargeSubTransaction",