Browse Source

improvement: omit deprecated fields in examples (via #4758)

bubble
Tim Macfarlane 6 years ago
committed by kyle
parent
commit
9a9cfdf101
2 changed files with 27 additions and 0 deletions
  1. +3
    -0
      src/core/plugins/samples/fn.js
  2. +24
    -0
      test/core/plugins/samples/fn.js

+ 3
- 0
src/core/plugins/samples/fn.js View File

@@ -52,6 +52,9 @@ export const sampleFromSchema = (schema, config={}) => {
let props = objectify(properties) let props = objectify(properties)
let obj = {} let obj = {}
for (var name in props) { for (var name in props) {
if ( props[name] && props[name].deprecated ) {
continue
}
if ( props[name] && props[name].readOnly && !includeReadOnly ) { if ( props[name] && props[name].readOnly && !includeReadOnly ) {
continue continue
} }


+ 24
- 0
test/core/plugins/samples/fn.js View File

@@ -79,6 +79,30 @@ describe("sampleFromSchema", function() {
expect(sampleFromSchema(definition, { includeReadOnly: true })).toEqual(expected) expect(sampleFromSchema(definition, { includeReadOnly: true })).toEqual(expected)
}) })


it("returns object without deprecated fields for parameter", function () {
var definition = {
type: "object",
properties: {
id: {
type: "integer"
},
deprecatedProperty: {
deprecated: true,
type: "string"
}
},
xml: {
name: "animals"
}
}

var expected = {
id: 0
}

expect(sampleFromSchema(definition)).toEqual(expected)
})

it("returns object without writeonly fields for parameter", function () { it("returns object without writeonly fields for parameter", function () {
var definition = { var definition = {
type: "object", type: "object",


Loading…
Cancel
Save