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

fix: Swagger 2.0 Response.examples, again (via #5465)

Browse Source 
* fix: Swagger 2.0 `Response.examples`

* stringify results
This commit is contained in:
kyle
2019-07-13 01:01:57 -05:00
committed by GitHub
parent 9749a47853
commit a9493a27be
2 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/core/components/response.jsx
View File

@@ -10,7 +10,7 @@ const getExampleComponent = ( sampleResponse, HighlightCode ) => {
sampleResponse !== undefined && sampleResponse !== undefined &&
sampleResponse !== null sampleResponse !== null
) { return <div> ) { return <div>
<HighlightCode className="example" value={ sampleResponse } /> <HighlightCode className="example" value={ stringify(sampleResponse) } />
</div> </div>
} }
return null return null

8
test/e2e-cypress/tests/bugs/5458.js
View File

@@ -1,18 +1,22 @@
// http://github.com/swagger-api/swagger-ui/issues/5458 // http://github.com/swagger-api/swagger-ui/issues/5458
const expectedValue = `{
"foo": "custom value"
}`
describe("#5458: Swagger 2.0 `Response.examples` mappings", () => { describe("#5458: Swagger 2.0 `Response.examples` mappings", () => {
it("should render a custom example when a schema is not defined", () => { it("should render a custom example when a schema is not defined", () => {
cy.visit("/?url=/documents/bugs/5458.yaml") cy.visit("/?url=/documents/bugs/5458.yaml")
.get("#operations-default-get_foo1") .get("#operations-default-get_foo1")
.click() .click()
.get(".model-example .highlight-code") .get(".model-example .highlight-code")
.contains("custom value") .contains(expectedValue)
}) })
it("should render a custom example when a schema is defined", () => { it("should render a custom example when a schema is defined", () => {
cy.visit("/?url=/documents/bugs/5458.yaml") cy.visit("/?url=/documents/bugs/5458.yaml")
.get("#operations-default-get_foo2") .get("#operations-default-get_foo2")
.click() .click()
.get(".model-example .highlight-code") .get(".model-example .highlight-code")
.contains("custom value") .contains(expectedValue)
}) })
}) })