Updated OpenAPISpecWriter & Parameter classes to allow for the option…

…al 'format' modifier field to be included in the output schema.
knuckleswtf · Dec 17, 2021 · b577931 · b577931
1 parent 30ea2dc
commit b577931
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 2 deletions.
diff --git a/camel/Extraction/Parameter.php b/camel/Extraction/Parameter.php
@@ -12,6 +12,7 @@ class Parameter extends BaseDTO
     public bool $required = false;
     public $example = null;
     public string $type = 'string';
+    public ?string $format = null;
 
     public function __construct(array $parameters = [])
     {

diff --git a/camel/Output/Parameter.php b/camel/Output/Parameter.php
@@ -19,6 +19,9 @@ class Parameter extends \Knuckles\Camel\Extraction\Parameter
     /** @var string */
     public string $type = 'string';
 
+    /** @var string|null */
+    public ?string $format = null;
+
     /** @var array */
     public $__fields = [];
 

diff --git a/src/Writing/OpenAPISpecWriter.php b/src/Writing/OpenAPISpecWriter.php
@@ -541,11 +541,15 @@ public function generateFieldData($field): array
                 })->all(),
             ];
         } else {
-            return [
+            $optionalSchema =  [];
+            if (!is_null($field->format)) {
+                $optionalSchema['format'] = $field->format;
+            }
+            return array_merge([
                 'type' => $this->normalizeTypeName($field->type),
                 'description' => $field->description ?: '',
                 'example' => $field->example,
-            ];
+            ], $optionalSchema);
         }
     }
 }
diff --git a/tests/GenerateDocumentationTest.php b/tests/GenerateDocumentationTest.php
@@ -336,6 +336,7 @@ public function will_not_overwrite_manually_modified_content_unless_force_flag_i
             'required' => true,
             'example' => 6,
             'type' => 'integer',
+            'format' => null,
         ];
         $group['endpoints'][0]['urlParameters']['a_param'] = $extraParam;
         file_put_contents($group1FilePath, Yaml::dump(