schema-service openapi fixes 75/139875/1
authorFiete Ostkamp <Fiete.Ostkamp@telekom.de>
Wed, 8 Jan 2025 11:41:40 +0000 (12:41 +0100)
committerFiete Ostkamp <Fiete.Ostkamp@telekom.de>
Wed, 8 Jan 2025 11:41:40 +0000 (12:41 +0100)
- do not use type: object together with $ref ($ref should reference an object)
- change order of type and description declarations (this is only a matter of personal preference)

Issue-ID: AAI-4104
Signed-off-by: Fiete Ostkamp <Fiete.Ostkamp@telekom.de>
Change-Id: I68ed7f68aeb315359c52d33d3f83eb4910b5070b

aai-schema-gen/src/main/java/org/onap/aai/schemagen/genxsd/NodesYAMLfromOXM.java
aai-schema-gen/src/main/java/org/onap/aai/schemagen/genxsd/YAMLfromOXM.java

index 8a06c37..4f1996d 100644 (file)
@@ -246,9 +246,9 @@ public class NodesYAMLfromOXM extends OxmFileProcessor {
     private String getDictionary(String resource) {
         StringBuilder dictSb = new StringBuilder();
         dictSb.append("  ").append(resource).append(":\n");
+        dictSb.append("    type: object\n");
         dictSb.append("    description: |\n");
         dictSb.append("      dictionary of ").append(resource).append("\n");
-        dictSb.append("    type: object\n");
         dictSb.append("    properties:\n");
         dictSb.append("      ").append(resource).append(":\n");
         dictSb.append("        type: array\n");
@@ -408,7 +408,6 @@ public class NodesYAMLfromOXM extends OxmFileProcessor {
                         sbProperties.append("      ").append(getXmlRootElementName(addType))
                             .append(":\n");
                         if ("RelationshipList".equals(addType)) {
-                            sbProperties.append("        type: object\n");
                             sbProperties.append("        $ref: \"#/definitions/").append(itemName)
                                 .append("\"\n");
                         } else {
@@ -515,6 +514,8 @@ public class NodesYAMLfromOXM extends OxmFileProcessor {
         } else if (xmlRootElementName.equals("relationship")) {
             definitionsSb.append("  " + "relationship-dict" + ":\n");
             definitionsLocalSb.append("  " + "relationship-dict" + ":\n");
+            definitionsSb.append("    type: object\n");
+            definitionsLocalSb.append("    type: object\n");
             dict = getDictionary(xmlRootElementName);
         } else {
             definitionsSb.append("  ").append(xmlRootElementName).append(":\n");
index 1b746d5..71baa9c 100644 (file)
@@ -250,9 +250,9 @@ public class YAMLfromOXM extends OxmFileProcessor {
     private String getDictionary(String resource) {
         StringBuilder dictSb = new StringBuilder();
         dictSb.append("  ").append(resource).append(":\n");
+        dictSb.append("    type: object\n");
         dictSb.append("    description: |\n");
         dictSb.append("      dictionary of ").append(resource).append("\n");
-        dictSb.append("    type: object\n");
         dictSb.append("    properties:\n");
         dictSb.append("      ").append(resource).append(":\n");
         dictSb.append("        type: array\n");
@@ -437,7 +437,6 @@ public class YAMLfromOXM extends OxmFileProcessor {
                         sbProperties.append("      ").append(getXmlRootElementName(addType))
                             .append(":\n");
                         if ("RelationshipList".equals(addType)) {
-                            sbProperties.append("        type: object\n");
                             sbProperties.append("        $ref: \"#/definitions/").append(itemName)
                                 .append("\"\n");
                             sbPropertiesPatch.append("      ")
@@ -553,6 +552,8 @@ public class YAMLfromOXM extends OxmFileProcessor {
         } else if (xmlRootElementName.equals("relationship")) {
             definitionsSb.append("  " + "relationship-dict" + ":\n");
             definitionsLocalSb.append("  " + "relationship-dict" + ":\n");
+            definitionsSb.append("    type: object\n");
+            definitionsLocalSb.append("    type: object\n");
             dict = getDictionary(xmlRootElementName);
         } else {
             definitionsSb.append("  ").append(xmlRootElementName).append(":\n");