Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Response example not rendering

See original GitHub issue

Response object is not rendering when configured as sister of schema and deletes properties when configured as daughter of schema

Q	A
Bug or feature request?	Bug
Which Swagger/OpenAPI version?	3.X
Which Swagger-UI version?	3.4.0
How did you install Swagger-UI?	github
Which browser & version?	Chrome 62
Which operating system?	Ubuntu 64

According to the docs, example should be a sister to schema when using $ref. When doing this, I do not get the substitution I would expect for count, next, and previous

      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Response'
                  - type: object
                    properties:
                      results:
                        type: array
                        items:
                            type: object
                            $ref: '#/components/schemas/Detection'
              example:
                count: 10
                next: "http://127.0.0.1/api/v2/detection?page=3&page_size=1"
                previous: "http://127.0.0.1/api/v2/detection?page=1&page_size=1"

substitution1

When I move example to a daughter of schema, I get he substitution, but lose additional properties that were appended to the schema

      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Response'
                  - type: object
                    properties:
                      results:
                        type: array
                        items:
                            type: object
                            $ref: '#/components/schemas/Detection'
                example:
                  count: 10
                  next: "http://127.0.0.1/api/v2/detection?page=3&page_size=1"
                  previous: "http://127.0.0.1/api/v2/detection?page=1&page_size=1"

substitution2