Add SwagEntityAttribute::example #208

Changes SchemaProperty::example to `@var mixed`
cnizzardini · Oct 18, 2020 · 7a0b786 · 7a0b786
1 parent bade171
commit 7a0b786
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 7 deletions.
diff --git a/src/Lib/Annotation/AbstractSchemaProperty.php b/src/Lib/Annotation/AbstractSchemaProperty.php
@@ -138,6 +138,11 @@ abstract class AbstractSchemaProperty
      */
     public $enum = [];
 
+    /**
+     * @var mixed
+     */
+    public $example;
+
     /**
      * @param array $values Annotation attributes as key-value pair
      */

diff --git a/src/Lib/Annotation/SwagEntityAttribute.php b/src/Lib/Annotation/SwagEntityAttribute.php
@@ -32,6 +32,7 @@
  * @Attribute("maxProperties",  type = "integer"),
  * @Attribute("minProperties", type = "integer"),
  * @Attribute("enum", type = "array"),
+ * @Attribute("example", type = "mixed"),
  * })
  *
  * Read OpenAPI specification for exact usage of the attributes:

diff --git a/src/Lib/OpenApi/SchemaProperty.php b/src/Lib/OpenApi/SchemaProperty.php
@@ -31,9 +31,9 @@ class SchemaProperty implements JsonSerializable
     private $format = '';
 
     /**
-     * @var string
+     * @var mixed
      */
-    private $example = '';
+    private $example;
 
     /**
      * @var string
@@ -232,20 +232,20 @@ public function setRequired(bool $required)
     }
 
     /**
-     * @return string
+     * @return mixed
      */
-    public function getExample(): string
+    public function getExample()
     {
         return $this->example;
     }
 
     /**
-     * @param string|int $example Example
+     * @param mixed $example An example value
      * @return $this
      */
     public function setExample($example)
     {
-        $this->example = (string)$example;
+        $this->example = $example;
 
         return $this;
     }
@@ -371,4 +371,6 @@ public function setItems(array $items)
 
         return $this;
     }
+
+
 }
diff --git a/src/Lib/Schema/SchemaPropertyFromAnnotationFactory.php b/src/Lib/Schema/SchemaPropertyFromAnnotationFactory.php
@@ -43,6 +43,7 @@ public function create(AbstractSchemaProperty $attribute): SchemaProperty
             'uniqueItems',
             'maxProperties',
             'minProperties',
+            'example',
         ];
 
         foreach ($properties as $property) {

diff --git a/tests/TestCase/Lib/Annotations/SwagEntityAttributeTest.php b/tests/TestCase/Lib/Annotations/SwagEntityAttributeTest.php
@@ -62,6 +62,7 @@ public function testEntityAttribute()
         $employee = $arr['components']['schemas']['Employee'];
 
         $this->assertNotEmpty($employee['properties']['gender']['enum']);
+        $this->assertEquals('female', $employee['properties']['gender']['example']);
         $this->assertEquals(3, $employee['properties']['last_name']['minLength']);
         $this->assertEquals(59, $employee['properties']['last_name']['maxLength']);
         $this->assertEquals('/\W/', $employee['properties']['last_name']['pattern']);

diff --git a/tests/test_app/src/Model/Entity/Employee.php b/tests/test_app/src/Model/Entity/Employee.php
@@ -9,7 +9,7 @@
 /**
  * Employee Entity
  * @SwagAnnotation\SwagEntityAttribute(
- *     name="gender", type="string", required=false, enum={"male","female","other"},
+ *     name="gender", type="string", required=false, enum={"male","female","other"}, example="female"
  * )
  * @SwagAnnotation\SwagEntityAttribute(
  *     name="last_name", type="string", minLength=3, maxLength=59, pattern="/\W/"