ignore head methods by default

Author: mtrajano

config/laravel-swagger.php

@@ -34,4 +34,17 @@
     'produces' => [
         // 'application/json',
     ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Ignore methods
+    |--------------------------------------------------------------------------
+    |
+    | Methods in the following array will be ignored in the paths array
+    |
+    */
+
+    'ignoredMethods' => [
+        'head',
+    ],
 ];

src/Generator.php

@@ -43,6 +43,8 @@ public function generate()
             foreach ($methods as $method) {
                 $this->method = strtolower($method);
 
+                if (in_array($this->method, $this->config['ignoredMethods'])) continue;
+
                 $this->generatePath();
             }
         }

tests/GeneratorTest.php

@@ -54,6 +54,7 @@ public function testHasPaths($docs)
     public function testPathData($paths)
     {
         $this->assertArrayHasKey('get', $paths['/users']);
+        $this->assertArrayNotHasKey('head', $paths['/users']);
         $this->assertArrayHasKey('post', $paths['/users']);
 
         $this->assertArrayHasKey('description', $paths['/users']['get']);
@@ -65,6 +66,15 @@ public function testPathData($paths)
         $this->assertArrayHasKey('parameters', $paths['/users']['post']);
     }
 
+    public function testOverwriteIgnoreMethods()
+    {
+        $this->config['ignoredMethods'] = [];
+
+        $docs = (new Generator($this->config))->generate();
+
+        $this->assertArrayHasKey('head', $docs['paths']['/users']);
+    }
+
     public function testOptionalData()
     {
         $optionalData = [