question-mark
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.

[QUESTION] "Examples" empty select box in Swagger UI doc

See original GitHub issue

I run the sample notes app of the tutorial.

Opening the API documentation with Swagger UI, I found an empty select box labeled “Examples” in Request body block as images below.

What is this select box? What is this use? How can I set a value in the select box?

AwesomeScreenshot-Fast-API-Swagger-UI-2019-07-03-12-07-34

Try it out button Clicked

AwesomeScreenshot-Fast-API-Swagger-UI-2019-07-03-12-07-71

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Reactions:1
  • Comments:6 (4 by maintainers)

github_iconTop GitHub Comments

2reactions
tiangolocommented, Apr 12, 2020

There’s a new section in the docs with this: https://fastapi.tiangolo.com/tutorial/schema-extra-example/ 🎉

2reactions
dmontagucommented, Jul 15, 2019

Oh man, this looks like it could be really useful as a way to quickly convey/grasp how a given endpoint should be used (especially if the endpoint has a complex or deeply/variably-nested input model).

@tiangolo if https://github.com/samuelcolvin/pydantic/pull/663 makes it possible to easily add examples that can be selected in this drop down, I think that will be worth a specific call-out in the fastapi docs!

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to get Swagger UI's Parameter to be Dropdown menu ...
Is there any way to display a drop-down menu on the Swagger UI instead of having a text input field so that users...
Read more >
Swagger UI tutorial | Documenting APIs - Idratherbewriting.com
Swagger UI provides a display framework that reads an OpenAPI specification document and generates an interactive documentation website.
Read more >
Describing Parameters - Swagger
In Swagger, API operation parameters are defined under the parameters ... Path, query, header and form parameters can accept a list of values,...
Read more >
F.A.Q - Springdoc-openapi
#For sorting endpoints alphabetically springdoc.swagger-ui. ... You can set list of paths to include using the following property: springdoc.
Read more >
Solved: How to find the full documentation API for SwggerU...
So my question basically is, where to find the full list of object properties that "wrapSelectors" provides for example?
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found