Repository navigation
Regression: OAS2 response examples are not displayed #5458
Description
Q&A (please complete the following information)
- OS: Windows 10
- Browser: any
- Method of installation: https://editor.swagger.io
- Swagger-UI version: 3.23.0
- Swagger/OpenAPI version: OpenAPI 2.0
Content & configuration
Example Swagger/OpenAPI definition:
swagger: "2.0"
info:
title: test
version: 1.0.0
paths:
/foo1:
get:
summary: Response without a schema
produces:
- application/json
responses:
200:
description: Successful response
examples:
application/json:
foo: custom value
/foo2:
get:
summary: Response with schema
produces:
- application/json
responses:
200:
description: Successful response
schema:
$ref: '#/definitions/Foo'
examples:
application/json:
foo: custom value
definitions:
Foo:
type: object
properties:
foo:
type: string
example: barDescribe the bug you're encountering
/pull/5427 seems to have introduced an issue where OAS2 response examples are not displayed if the response does not have a schema defined. Previous versions of Swagger UI rendered the response examples in this case.
Expected behavior
Both /foo1 and /foo2 display the following response example, as it was in Swagger UI v. 3.22.3:
{
"foo": "custom value"
}
Actual behavior
/foo1 does not display any example.
/foo2 displays schema-based example instead of the custom example from examples.
Activity
[-]Regression: OAS2 response examples are not displayed if the response does not have schema[/-][+]Regression: OAS2 response examples are not displayed[/+]shockey commentedon Jul 13, 2019
(P1 in order to push this above #5453 and #5455)
shockey commentedon Jul 13, 2019
thanks as always @hkosova!
shockey commentedon Jul 13, 2019
wait a second
My implementation missed the mark, it's generating
custom valueinstead of the entire object.Reopening.
shockey commentedon Jul 13, 2019