Merge pull request #2092 from huyvohcmc/improve-include-missing-doc

Improve include missing doc
ruby-grape · Aug 4, 2020 · 470f80c · 470f80c
2 parents e7e2501 + 3e57355
commit 470f80c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@
 * Your contribution here.
 * [#2089](/~https://github.com/ruby-grape/grape/pull/2089): Specify order of mounting Grape with Rack::Cascade in README - [@jonmchan](/~https://github.com/jonmchan).
 * [#2083](/~https://github.com/ruby-grape/grape/pull/2083): Set `Cache-Control` header only for streamed responses - [@stanhu](/~https://github.com/stanhu).
+* [#2092](/~https://github.com/ruby-grape/grape/pull/2092): Correct an example params in Include Missing doc - [@huyvohcmc](/~https://github.com/huyvohcmc).
 
 ### 1.4.0 (2020/07/10)
 

diff --git a/README.md b/README.md
@@ -908,8 +908,10 @@ By default `declared(params)` includes parameters that have `nil` values. If you
 format :json
 
 params do
-  requires :first_name, type: String
-  optional :last_name, type: String
+  requires :user, type: Hash do
+    requires :first_name, type: String
+    optional :last_name, type: String
+  end
 end
 
 post 'users/signup' do