From 4d95dde523a9fcbc2ef231676c1f2dadb03c0b69 Mon Sep 17 00:00:00 2001
From: Guilhem N <egetick@gmail.com>
Date: Sat, 13 Jan 2018 13:21:23 +0100
Subject: [PATCH] Make the docs clearer about models (#1185)

* Make the docs clearer about models

* Fixes
---
 Resources/doc/index.rst | 32 +++++++++++++++++++++-----------
 1 file changed, 21 insertions(+), 11 deletions(-)

diff --git a/Resources/doc/index.rst b/Resources/doc/index.rst
index 9645204..1bf606e 100644
--- a/Resources/doc/index.rst
+++ b/Resources/doc/index.rst
@@ -168,19 +168,29 @@ Use models
 As shown in the example above, the bundle provides the ``@Model`` annotation.
 When you use it, the bundle will deduce your model properties.
 
+.. note::
+
+    A model can be a Symfony form type, a Doctrine ORM entity or a general PHP object.
+
 It has two options:
 
 * ``type`` to specify your model's type::
 
     /**
-     * @Model(type=User::class)
-     */
+     * @SWG\Response(
+     *     response=200,
+     *     @Model(type=User::class)
+     * )
+     */
 
 * ``groups`` to specify the serialization groups used to (de)serialize your model::
 
-    /**
-     * @Model(type=User::class, groups={"non_sensitive_data"})
-     */
+    /**
+     * @SWG\Response(
+     *     response=200,
+     *     @Model(type=User::class, groups={"non_sensitive_data"})
+     * )
+     */
 
 .. caution::
 
@@ -191,8 +201,8 @@ It has two options:
 
         /**
          * @SWG\Response(
-         *   response="200",
-         *   description="Success",
+         *   response="200",
+         *   description="Success",
          *   @SWG\Schema(@Model(type=User::class))
          * )
          */
@@ -208,7 +218,7 @@ It has two options:
         responses:
             200:
                 schema:
-                    items: { $ref: '#/definitions/MyModel' }
+                    items: { $ref: '#/definitions/User' }
 
     while you probably expected:
 
@@ -217,7 +227,7 @@ It has two options:
         # ...
         responses:
             200:
-                schema: { $ref: '#/definitions/MyModel' }
+                schema: { $ref: '#/definitions/User' }
 
     To obtain the output you expected, remove the ``@Schema`` annotation::
 
@@ -225,10 +235,10 @@ It has two options:
          * @SWG\Response(
          *   response="200",
          *   description="Success",
-         *   @Model(type=MyModel::class)
+         *   @Model(type=User::class)
          * )
          */
-        public function myAction()
+        public function getUserAction()
         {
         }