From da0352a61a538232b07a58da04549c76c0d4a585 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marko=20Mili=C4=87?= <marko@tesobe.com>
Date: Thu, 13 Oct 2022 15:38:45 +0200
Subject: [PATCH] feature/Show which fields are optional / required in API
 Explorer 2

---
 .../scala/code/api/v1_4_0/JSONFactory1_4_0.scala  | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/obp-api/src/main/scala/code/api/v1_4_0/JSONFactory1_4_0.scala b/obp-api/src/main/scala/code/api/v1_4_0/JSONFactory1_4_0.scala
index bf6b74580..3d170b62a 100644
--- a/obp-api/src/main/scala/code/api/v1_4_0/JSONFactory1_4_0.scala
+++ b/obp-api/src/main/scala/code/api/v1_4_0/JSONFactory1_4_0.scala
@@ -420,11 +420,11 @@ object JSONFactory1_4_0 extends MdcLoggable{
    * @param parameter BANK_ID
    * @return [BANK_ID](/glossary#Bank.bank_id):gh.29.uk 
    */
-  def prepareDescription(parameter: String, types: List[(String, Boolean)]): String = {
+  def prepareDescription(parameter: String, optionalTypeFields: List[(String, Boolean)]): String = {
     val glossaryItemTitle = getGlossaryItemTitle(parameter)
     val exampleFieldValue = getExampleFieldValue(parameter)
     def boldIfMandatory() = {
-      types.exists(i => i._1 == parameter && i._2 == false) match {
+      optionalTypeFields.exists(i => i._1 == parameter && i._2 == false) match {
         case true =>
           s"**$parameter**"
         case false =>
@@ -444,7 +444,7 @@ object JSONFactory1_4_0 extends MdcLoggable{
 
   def prepareJsonFieldDescription(jsonBody: scala.Product, jsonType: String): String = {
     jsonBody.productIterator
-    val (jsonBodyJValue: json.JValue, types) = jsonBody match {
+    val (jsonBodyJValue: json.JValue, optionalTypeFields) = jsonBody match {
       case JvalueCaseClass(jValue) =>
         val types = Nil
         (jValue, types)
@@ -455,9 +455,14 @@ object JSONFactory1_4_0 extends MdcLoggable{
         (decompose(jsonBody), types)
     }
 
-    val jsonBodyFields =JsonUtils.collectFieldNames(jsonBodyJValue).keySet.toList.sorted
+    // Group by is mandatory criteria and sort those 2 groups by name of the field
+    val jsonBodyFieldsOptional = JsonUtils.collectFieldNames(jsonBodyJValue).keySet.toList
+      .filter(x => optionalTypeFields.exists(i => i._1 == x && i._2 == true)).sorted
+    val jsonBodyFieldsMandatory = JsonUtils.collectFieldNames(jsonBodyJValue).keySet.toList
+      .filter(x => optionalTypeFields.exists(i => i._1 == x && i._2 == false)).sorted
+    val jsonBodyFields = jsonBodyFieldsMandatory ::: jsonBodyFieldsOptional
 
-    val jsonFieldsDescription = jsonBodyFields.map(i => prepareDescription(i, types))
+    val jsonFieldsDescription = jsonBodyFields.map(i => prepareDescription(i, optionalTypeFields))
     
     val jsonTitleType = if (jsonType.contains("request")) "\n\n\n**JSON request body fields:**\n\n" else  "\n\n\n**JSON response body fields:**\n\n"