vllm-project / vllm-project/production-stack
feature: Enable passing body of request in swagger docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.6k
- Forks
- 503
- Avg merge
- 4d 17h
- Merged PRs (30d)
- 8
Description
Describe the feature
When clicking "Try it out" in the swagger docs, it is not possible to pass the request body. For example, for /v1/chat/completions and /v1/completions, etc.
This makes the "try it out" feature practically useless for those endpoints.
Why do you need this feature?
It would be useful to be able to test more things from the swagger docs.
Additional context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Swagger/OpenAPI documentation configuration for /v1/chat/completions and /v1/completions. Check how those endpoints are represented in the generated docs and verify the Try it out flow can accept a request body for them; done means the body can be entered and sent from Swagger UI.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100