ruby-grape / ruby-grape/grape-swagger
Swagger Rails UI do not render example responses
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 1.1k
- Forks
- 479
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 6
Description
I want to add some examples of response to swagger to show it in the UI, but UI did not show it. I have checked swagger json file, examples of response had existed there and I tried to upload that json to SwaggerHub and it showed as I expected. I suggest, there are some problems when handling.
Here my code:
failure [
{code: 400, message: "Params invalid", model: Entities::V1::Error, examples: {"application/json" => {error_code: "400", message: "error message"}}},
{code: 401, message: "Unauthenticated", model: Entities::V1::Error, examples: {"application/json" => {error_code: "401", message: "error message"}}},
{code: 406, message: "Not Acceptable", model: Entities::V1::Error, examples: {"application/json" => {error_code: "406", message: "error message"}}}
]
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 reproducing the issue with the provided failure response definitions and compare the generated Swagger JSON with what the Rails UI renders. Done means the response examples already present in the JSON are displayed correctly in the UI.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100