ORD-1915 Improved Swagger documentation.

Author: tasselchof

src/ApiFactory.php

@@ -407,6 +407,10 @@ private function getField(array $fieldData)
             $field->setFieldType($fieldData['field_type']);
         }
 
+        if (isset($fieldData['example'])) {
+            $field->setExample($fieldData['example']);
+        }
+
         $required = isset($fieldData['required']) ? (bool) $fieldData['required'] : false;
         $field->setRequired($required);
 

src/Field.php

@@ -36,6 +36,11 @@ class Field implements IteratorAggregate
      */
     protected $fieldType = '';
 
+    /**
+     * @var string
+     */
+    protected $example;
+
     /**
      * @param string $name
      */
@@ -116,6 +121,18 @@ public function setFieldType($fieldType)
         $this->fieldType = $fieldType;
     }
 
+    public function getExample()
+    {
+        return $this->example;
+    }
+
+    public function setExample($example)
+    {
+        $this->example = $example;
+
+        return $this;
+    }
+
     /**
      * Cast object to array
      *
@@ -127,6 +144,7 @@ public function toArray()
             'description' => $this->description,
             'required' => $this->required,
             'type' => $this->fieldType,
+            'example' => $this->example,
         ];
     }