Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/core/plugins/samples/fn.js
Original file line number Diff line number Diff line change
Expand Up @@ -203,8 +203,12 @@ export const sampleFromSchemaGeneric = (schema, config={}, exampleOverride = und

// if json just return
if(!respectXML) {
// spacial case yaml parser can not know about
if(typeof sample === "number" && type === "string") {
return `${sample}`
}
// return if sample does not need any parsing
if(typeof sample !== "string") {
if(typeof sample !== "string" || type === "string") {
return sample
}
// check if sample is parsable or just a plain string
Expand Down
36 changes: 36 additions & 0 deletions test/unit/core/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -1582,6 +1582,42 @@ describe("utils", () => {
expect(actual.test).toEqual(123)
})

it("should handle number example with string schema as string", () => {
// Given
const expected = 123
const res = getSampleSchema({
type: "string",
}, "text/json", {}, expected)

// Then
const actual = JSON.parse(res)
expect(actual).toEqual("123")
})

it("should handle number literal example with string schema as string", () => {
// Given
const expected = "123"
const res = getSampleSchema({
type: "string",
}, "text/json", {}, expected)

// Then
const actual = JSON.parse(res)
expect(actual).toEqual("123")
})

it("should handle number literal example with number schema as number", () => {
// Given
const expected = "123"
const res = getSampleSchema({
type: "number",
}, "text/json", {}, expected)

// Then
const actual = JSON.parse(res)
expect(actual).toEqual(123)
})

it("should return yaml example if yaml is contained in the content-type", () => {
const res = getSampleSchema({
type: "object",
Expand Down