kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(example): set discriminated properties to mapped value (#8213)

Browse Source
This commit is contained in:
Ahmed Yarub Hani Al Nuaimi
2022-10-17 20:22:43 -03:00
committed by GitHub
parent 7936ec9fea
commit f5bb456ffa
2 changed files with 82 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/core/plugins/samples/fn.js
View File

@@ -346,7 +346,20 @@ export const sampleFromSchemaGeneric = (schema, config={}, exampleOverride = und
if(!canAddProperty(propName)) {
return
}
if(Object.prototype.hasOwnProperty.call(schema, "discriminator") &&
schema.discriminator &&
Object.prototype.hasOwnProperty.call(schema.discriminator, "mapping") &&
schema.discriminator.mapping &&
schema.discriminator.propertyName === propName) {
for (let pair in schema.discriminator.mapping){
if (schema.$$ref.search(schema.discriminator.mapping[pair]) !== -1) {
res[propName] = pair
break
}
}
} else {
res[propName] = sampleFromSchemaGeneric(props[propName], config, overrideE, respectXML)
}
propertyAddedCounter++
}
}

68
test/unit/core/plugins/samples/fn.js
View File

@@ -605,6 +605,74 @@ describe("sampleFromSchema", () => {
})
})
describe("discriminator mapping example", () => {
it("returns an example where discriminated field is equal to mapping value", () => {
let definition = {
"type": "array",
"items": {
"oneOf": [
{
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TYPE1",
"TYPE2"
]
}
},
"discriminator": {
"propertyName": "type",
"mapping": {
"TYPE1": "#/components/schemas/FirstDto",
"TYPE2": "#/components/schemas/SecondDto"
}
},
"$$ref": "examples/swagger-config.yaml#/components/schemas/FirstDto"
},
{
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TYPE1",
"TYPE2"
]
}
},
"discriminator": {
"propertyName": "type",
"mapping": {
"TYPE1": "#/components/schemas/FirstDto",
"TYPE2": "#/components/schemas/SecondDto"
}
},
"$$ref": "examples/swagger-config.yaml#/components/schemas/SecondDto"
}
]
}
}
let expected = [
{
"type": "TYPE1"
}, {
"type": "TYPE2"
}
]
expect(sampleFromSchema(definition)).toEqual(expected)
})
})
it("should use overrideExample when defined", () => {
const definition = {
type: "object",