feat(json-schema): support x-additionalPropertiesName (#10006)

Author: eltoder

src/core/plugins/json-schema-2020-12-samples/fn/main.js

@@ -482,6 +482,8 @@ export const sampleFromSchemaGeneric = (
       ) {
         res[displayName].push(additionalPropSample)
       } else {
+        const keyName =
+          additionalProps?.["x-additionalPropertiesName"] || "additionalProp"
         const toGenerateCount =
           Number.isInteger(schema.minProperties) &&
           schema.minProperties > 0 &&
@@ -494,10 +496,10 @@ export const sampleFromSchemaGeneric = (
           }
           if (respectXML) {
             const temp = {}
-            temp["additionalProp" + i] = additionalPropSample["notagname"]
+            temp[keyName + i] = additionalPropSample["notagname"]
             res[displayName].push(temp)
           } else {
-            res["additionalProp" + i] = additionalPropSample
+            res[keyName + i] = additionalPropSample
           }
           propertyAddedCounter++
         }

src/core/plugins/json-schema-5-samples/fn/index.js

@@ -518,6 +518,7 @@ export const sampleFromSchemaGeneric = (schema, config={}, exampleOverride = und
       {
         res[displayName].push(additionalPropSample)
       } else {
+        const keyName = additionalProps["x-additionalPropertiesName"] || "additionalProp"
         const toGenerateCount = schema.minProperties !== null && schema.minProperties !== undefined && propertyAddedCounter < schema.minProperties
           ? schema.minProperties - propertyAddedCounter
           : 3
@@ -527,10 +528,10 @@ export const sampleFromSchemaGeneric = (schema, config={}, exampleOverride = und
           }
           if(respectXML) {
             const temp = {}
-            temp["additionalProp" + i] = additionalPropSample["notagname"]
+            temp[keyName + i] = additionalPropSample["notagname"]
             res[displayName].push(temp)
           } else {
-            res["additionalProp" + i] = additionalPropSample
+            res[keyName + i] = additionalPropSample
           }
           propertyAddedCounter++
         }

test/unit/core/plugins/json-schema-2020-12-samples/fn.js

@@ -1263,6 +1263,30 @@ describe("sampleFromSchema", () => {
     expect(sampleFromSchema(definition)).toEqual(expected)
   })
 
+  it("should handle additionalProperties with x-additionalPropertiesName", () => {
+    const definition = {
+      type: "object",
+      additionalProperties: {
+        type: "string",
+        "x-additionalPropertiesName": "bar",
+      },
+      properties: {
+        foo: {
+          type: "string",
+        },
+      },
+    }
+
+    const expected = {
+      foo: "string",
+      bar1: "string",
+      bar2: "string",
+      bar3: "string",
+    }
+
+    expect(sampleFromSchema(definition)).toEqual(expected)
+  })
+
   it("should handle additionalProperties=true", () => {
     const definition = {
       type: "object",
@@ -2765,6 +2789,28 @@ describe("createXMLExample", function () {
       expect(sut(definition)).toEqual(expected)
     })
 
+    it("returns object with additional props with x-additionalPropertiesName", function () {
+      const expected =
+        '<?xml version="1.0" encoding="UTF-8"?>\n<animals>\n\t<dog>string</dog>\n\t<animal1>string</animal1>\n\t<animal2>string</animal2>\n\t<animal3>string</animal3>\n</animals>'
+      const definition = {
+        type: "object",
+        properties: {
+          dog: {
+            type: "string",
+          },
+        },
+        additionalProperties: {
+          type: "string",
+          "x-additionalPropertiesName": "animal",
+        },
+        xml: {
+          name: "animals",
+        },
+      }
+
+      expect(sut(definition)).toEqual(expected)
+    })
+
     it("returns object with additional props =true", function () {
       const expected =
         '<?xml version="1.0" encoding="UTF-8"?>\n<animals>\n\t<dog>string</dog>\n\t<additionalProp>Anything can be here</additionalProp>\n</animals>'

test/unit/core/plugins/json-schema-5-samples/fn/index.js

@@ -969,6 +969,30 @@ describe("sampleFromSchema", () => {
     expect(sampleFromSchema(definition)).toEqual(expected)
   })
 
+  it("should handle additionalProperties with x-additionalPropertiesName", () => {
+    const definition = {
+      type: "object",
+      additionalProperties: {
+        type: "string",
+        "x-additionalPropertiesName": "bar",
+      },
+      properties: {
+        foo: {
+          type: "string",
+        },
+      },
+    }
+
+    const expected = {
+      foo: "string",
+      bar1: "string",
+      bar2: "string",
+      bar3: "string",
+    }
+
+    expect(sampleFromSchema(definition)).toEqual(expected)
+  })
+
   it("should handle additionalProperties=true", () => {
     const definition = {
       type: "object",
@@ -2223,6 +2247,27 @@ describe("createXMLExample", function () {
       expect(sut(definition)).toEqual(expected)
     })
 
+    it("returns object with additional props with x-additionalPropertiesName", function () {
+      let expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<animals>\n\t<dog>string</dog>\n\t<animal1>string</animal1>\n\t<animal2>string</animal2>\n\t<animal3>string</animal3>\n</animals>"
+      let definition = {
+        type: "object",
+        properties: {
+          dog: {
+            type: "string"
+          }
+        },
+        additionalProperties: {
+          type: "string",
+          "x-additionalPropertiesName": "animal"
+        },
+        xml: {
+          name: "animals"
+        }
+      }
+
+      expect(sut(definition)).toEqual(expected)
+    })
+
     it("returns object with additional props =true", function () {
       let expected = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<animals>\n\t<dog>string</dog>\n\t<additionalProp>Anything can be here</additionalProp>\n</animals>"
       let definition = {