feat(example): set discriminated properties to mapped value (#8213)
This commit is contained in:
committed by
GitHub
parent
7936ec9fea
commit
f5bb456ffa
@@ -346,7 +346,20 @@ export const sampleFromSchemaGeneric = (schema, config={}, exampleOverride = und
|
|||||||
if(!canAddProperty(propName)) {
|
if(!canAddProperty(propName)) {
|
||||||
return
|
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)
|
res[propName] = sampleFromSchemaGeneric(props[propName], config, overrideE, respectXML)
|
||||||
|
}
|
||||||
propertyAddedCounter++
|
propertyAddedCounter++
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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", () => {
|
it("should use overrideExample when defined", () => {
|
||||||
const definition = {
|
const definition = {
|
||||||
type: "object",
|
type: "object",
|
||||||
|
|||||||
Reference in New Issue
Block a user