From 9a9cfdf10104263538632b6cdee426cfcc36800c Mon Sep 17 00:00:00 2001
From: Tim Macfarlane <timmacfarlane@gmail.com>
Date: Mon, 20 Aug 2018 22:11:50 +0100
Subject: [PATCH] improvement: omit deprecated fields in examples (via #4758)

---
 src/core/plugins/samples/fn.js  |  3 +++
 test/core/plugins/samples/fn.js | 24 ++++++++++++++++++++++++
 2 files changed, 27 insertions(+)

diff --git a/src/core/plugins/samples/fn.js b/src/core/plugins/samples/fn.js
index 83b6c83f..b6a4ded4 100644
--- a/src/core/plugins/samples/fn.js
+++ b/src/core/plugins/samples/fn.js
@@ -52,6 +52,9 @@ export const sampleFromSchema = (schema, config={}) => {
     let props = objectify(properties)
     let obj = {}
     for (var name in props) {
+      if ( props[name] && props[name].deprecated ) {
+        continue
+      }
       if ( props[name] && props[name].readOnly && !includeReadOnly ) {
         continue
       }
diff --git a/test/core/plugins/samples/fn.js b/test/core/plugins/samples/fn.js
index 609ba24b..697da7f1 100644
--- a/test/core/plugins/samples/fn.js
+++ b/test/core/plugins/samples/fn.js
@@ -79,6 +79,30 @@ describe("sampleFromSchema", function() {
     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 () {
     var definition = {
       type: "object",
-- 
GitLab