fix(sample-gen): should render additionalProperties in example (#6821)

* fix(sample-gen): should render additionalProperties in example * test(sample-gen): should return additional property from example for object and array schemas
swagger-api · Jan 13, 2021 · 35cb925 · 35cb925
1 parent 99f93a5
commit 35cb925
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 2 deletions.
diff --git a/src/core/plugins/samples/fn.js b/src/core/plugins/samples/fn.js
@@ -143,8 +143,7 @@ export const sampleFromSchemaGeneric = (schema, config={}, exampleOverride = und
   let addPropertyToResult
   if(respectXML) {
     addPropertyToResult = (propName, overrideE = undefined) => {
-
-      if(schema) {
+      if(schema && props[propName]) {
         // case it is an xml attribute
         props[propName].xml = props[propName].xml || {}
 
@@ -168,6 +167,13 @@ export const sampleFromSchemaGeneric = (schema, config={}, exampleOverride = und
           return
         }
         props[propName].xml.name = props[propName].xml.name || propName
+      } else if(!props[propName] && additionalProperties !== false) {
+        // case only additionalProperty that is not defined in schema
+        props[propName] = {
+          xml: {
+            name: propName
+          }
+        }
       }
 
       let t = sampleFromSchemaGeneric(schema && props[propName] || undefined, config, overrideE, respectXML)

diff --git a/test/unit/core/plugins/samples/fn.js b/test/unit/core/plugins/samples/fn.js
@@ -1093,7 +1093,28 @@ describe("createXMLExample", function () {
 
       expect(sut(definition)).toEqual(expected)
     })
+    it("should return additionalProperty example", () => {
+      let expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<aliens>\n\t<notalien>test</notalien>\n</aliens>"
+      let definition = {
+        type: "array",
+        items: {
+          type: "object",
+          properties: {
+            alien: {
+              type: "string"
+            },
+            dog: {
+              type: "integer"
+            }
+          }
+        },
+        xml: {
+          name: "aliens"
+        }
+      }
 
+      expect(sut(definition, {}, [{ notalien: "test" }])).toEqual(expected)
+    })
 })
 
   describe("object", function () {
@@ -1521,6 +1542,26 @@ describe("createXMLExample", function () {
 
       expect(sut(definition, {}, overrideExample)).toEqual(expected)
     })
+
+    it("should return additionalProperty example", () => {
+      let expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<aliens>\n\t<alien>test</alien>\n\t<dog>1</dog>\n</aliens>"
+      let definition = {
+        type: "object",
+        properties: {
+          alien: {
+            type: "string"
+          },
+          dog: {
+            type: "integer"
+          }
+        },
+        xml: {
+          name: "aliens"
+        }
+      }
+
+      expect(sut(definition, {}, { alien: "test", dog: 1 })).toEqual(expected)
+    })
   })
 })