Skip to content

Commit

Permalink
Merge pull request #131 from Antek-drzewiecki/http_status_code_docume…
Browse files Browse the repository at this point in the history
…ntation

Added documentation for responseModel support.
  • Loading branch information
dblock committed Jul 29, 2014
2 parents e81d305 + d0f3b72 commit 3fd3066
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,11 +310,12 @@ desc "Reserve a virgin in heaven", {
}
```

You can also document the HTTP status codes that your API returns with the following syntax.
You can also document the HTTP status codes with a description and a specified model that your API returns with the following syntax.

``` ruby
get '/', http_codes: [
[400, "Invalid parameter entry"],
[200, 'Ok', Entities::Client],
[400, "Invalid parameter entry"]
] do
...
end
Expand Down

0 comments on commit 3fd3066

Please sign in to comment.