From d0f3b7228e0c521a9790e03fb0cd50c97c3d7881 Mon Sep 17 00:00:00 2001 From: Antek Drzewiecki Date: Tue, 29 Jul 2014 14:27:50 +0200 Subject: [PATCH] Added documentation for responseModel support. --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5da51cf6..a2c095ac 100644 --- a/README.md +++ b/README.md @@ -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