Merge pull request #333 from richardfullmer/https

Fix and properly document the https option
nelmio · Feb 7, 2014 · 5bd455f · 5bd455f
2 parents 1457194 + dc8494b
commit 5bd455f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/Annotation/ApiDoc.php b/Annotation/ApiDoc.php
@@ -222,6 +222,10 @@ public function __construct(array $data)
         if (isset($data['deprecated'])) {
             $this->deprecated = $data['deprecated'];
         }
+
+        if (isset($data['https'])) {
+            $this->https = $data['https'];
+        }
     }
 
     /**

diff --git a/Resources/doc/index.md b/Resources/doc/index.md
@@ -123,6 +123,8 @@ The following properties are available:
 
 * `description`: a description of the API method;
 
+* `https`: whether the method described requires the https protocol (default: `false`);
+
 * `deprecated`: allow to set method as deprecated (default: `false`);
 
 * `filters`: an array of filters;