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

feat(examples): add support for examples keyword (#8908)

Browse Source 
This change is specific to JSON Schema 2020-12
and OpenAPI 3.1.0.

Refs #8577
This commit is contained in:
Vladimír Gorej
2023-06-10 17:08:24 +02:00
committed by GitHub
parent 6c622a87e7
commit 4b0b28518e
7 changed files with 116 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

111
test/unit/core/plugins/json-schema-2020-12/samples-extensions/fn.js
View File

@@ -627,98 +627,6 @@ describe("sampleFromSchema", () => {
)
})
it("returns object without any $$ref fields at the root schema level", function () {
const definition = {
type: "object",
properties: {
message: {
type: "string",
},
},
example: {
value: {
message: "Hello, World!",
},
$$ref: "https://example.com/#/components/examples/WelcomeExample",
},
$$ref: "https://example.com/#/components/schemas/Welcome",
}
const expected = {
value: {
message: "Hello, World!",
},
}
expect(sampleFromSchema(definition, { includeWriteOnly: true })).toEqual(
expected
)
})
it("returns object without any $$ref fields at nested schema levels", function () {
const definition = {
type: "object",
properties: {
message: {
type: "string",
},
},
example: {
a: {
value: {
message: "Hello, World!",
},
$$ref: "https://example.com/#/components/examples/WelcomeExample",
},
},
$$ref: "https://example.com/#/components/schemas/Welcome",
}
const expected = {
a: {
value: {
message: "Hello, World!",
},
},
}
expect(sampleFromSchema(definition, { includeWriteOnly: true })).toEqual(
expected
)
})
it("returns object with any $$ref fields that appear to be user-created", function () {
const definition = {
type: "object",
properties: {
message: {
type: "string",
},
},
example: {
$$ref: {
value: {
message: "Hello, World!",
},
$$ref: "https://example.com/#/components/examples/WelcomeExample",
},
},
$$ref: "https://example.com/#/components/schemas/Welcome",
}
const expected = {
$$ref: {
value: {
message: "Hello, World!",
},
},
}
expect(sampleFromSchema(definition, { includeWriteOnly: true })).toEqual(
expected
)
})
it("returns example value for date-time property", () => {
const definition = {
type: "string",
@@ -1836,7 +1744,7 @@ describe("createXMLExample", function () {
it("returns example value when provided", function () {
const expected =
'<?xml version="1.0" encoding="UTF-8"?>\n<newtagname>two</newtagname>'
'<?xml version="1.0" encoding="UTF-8"?>\n<newtagname>one</newtagname>'
const definition = {
type: "string",
default: "one",
@@ -1850,6 +1758,23 @@ describe("createXMLExample", function () {
expect(sut(definition)).toEqual(expected)
})
it("returns item from examples value when provided", function () {
const expected =
'<?xml version="1.0" encoding="UTF-8"?>\n<newtagname>three</newtagname>'
const definition = {
type: "string",
default: "one",
example: "two",
examples: ["three", "four"],
enum: ["two", "one"],
xml: {
name: "newtagname",
},
}
expect(sut(definition)).toEqual(expected)
})
it("sets first enum if provided", function () {
const expected =
'<?xml version="1.0" encoding="UTF-8"?>\n<newtagname>one</newtagname>'