Support defining descriptions for @SwagHeader

cnizzardini · May 1, 2020 · 09b979f · 09b979f
1 parent cf88d28
commit 09b979f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/src/Lib/Annotation/SwagHeader.php b/src/Lib/Annotation/SwagHeader.php
@@ -10,6 +10,7 @@
  * @Attributes({
  *   @Attribute("name", type = "string"),
  *   @Attribute("type",  type = "string"),
+ *   @Attribute("description",  type = "string"),
  *   @Attribute("required",  type = "bool"),
  * })
  */
@@ -21,6 +22,9 @@ class SwagHeader
     /** @var string */
     public $type;
 
+    /** @var string */
+    public $description;
+
     /** @var bool */
     public $required;
 
@@ -30,10 +34,11 @@ public function __construct(array $values)
             throw new InvalidArgumentException('Name parameter is required');
         }
 
-        $values = array_merge(['type' => 'string', 'required' => false], $values);
+        $values = array_merge(['type' => 'string', 'description' => '', 'required' => false], $values);
 
         $this->name = $values['name'];
         $this->type = $values['type'];
+        $this->description = $values['description'];
         $this->required = (bool) $values['required'];
     }
 }
diff --git a/src/Lib/Annotation/SwagHeaderHandler.php b/src/Lib/Annotation/SwagHeaderHandler.php
@@ -12,6 +12,7 @@ public function getHeaderParameters(SwagHeader $annotation) : Parameter
         $parameter = new Parameter();
         $parameter
             ->setName($annotation->name)
+            ->setDescription($annotation->description)
             ->setAllowEmptyValue(false)
             ->setDeprecated(false)
             ->setRequired($annotation->required)