swagger-ui
swagger-ui copied to clipboard
BUG: failing to fetch examples for parameters
Q&A (please complete the following information)
- OS: ArchLinux
- Browser: chrome
- Version: 127.0.6533.99 (Official Build) (64-bit)
- Method of installation: Swagger editor
- Swagger-UI version: 3.10.0
- Swagger/OpenAPI version: OpenAPI 3.1.0
Content & configuration
Example Swagger/OpenAPI definition:
/api/resource/User:
get:
tags:
- user
summary: "Get All Users"
description: "Retrieve a list of all User records."
parameters:
- name: fields
in: query
description: "Comma-separated list of fields to include in the response."
schema:
type: string
examples:
- 'field'
Describe the bug you're encountering
Swagger UI doesn't use example or parameter when using the examples key (as an array). I got it to work using the deprecated example
To reproduce...
Steps to reproduce the behavior:
- write a sample swagger yaml in swagger editor
- add a path and add a param field.
- add example
exampleto the properties and you can see the example value. - replace with examples as an array and you'd lose the example value
Expected behavior
should be able to render the example vaue when using examples
Screenshots
Additional context or thoughts
Willing to attempt fixing this - if it gets approved to be a bug