OAS: Don't include forbidden headers (fixes #625)

knuckleswtf · Apr 8, 2023 · 56d589a · 56d589a
1 parent eb5e1b3
commit 56d589a
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 22 deletions.
diff --git a/src/Writing/OpenAPISpecWriter.php b/src/Writing/OpenAPISpecWriter.php
@@ -185,6 +185,11 @@ protected function generateEndpointParametersSpec(OutputEndpointData $endpoint):
 
         if (count($endpoint->headers)) {
             foreach ($endpoint->headers as $name => $value) {
+                if (in_array($name, ['Content-Type', 'content-type', 'Accept', 'accept']))
+                    // These headers are not allowed in the spec.
+                    // https://swagger.io/docs/specification/describing-parameters/#header-parameters
+                    continue;
+
                 $parameters[] = [
                     'in' => 'header',
                     'name' => $name,

diff --git a/tests/Fixtures/openapi.yaml b/tests/Fixtures/openapi.yaml
@@ -20,13 +20,6 @@ paths:
                     example: NotSoCustom
                     schema:
                         type: string
-                -
-                    in: header
-                    name: Content-Type
-                    description: ''
-                    example: multipart/form-data
-                    schema:
-                        type: string
             responses: {  }
             tags:
                 - 'Group A'
@@ -280,12 +273,6 @@ paths:
                   example: NotSoCustom
                   schema:
                       type: string
-                - in: header
-                  name: Content-Type
-                  description: ''
-                  example: application/json
-                  schema:
-                      type: string
             responses: {}
             tags:
                 - Group A

diff --git a/tests/Unit/OpenAPISpecWriterTest.php b/tests/Unit/OpenAPISpecWriterTest.php
@@ -174,21 +174,14 @@ public function adds_headers_correctly_as_parameters_on_operation_object()
         $results = $this->generate($groups);
 
         $this->assertEquals([], $results['paths']['/path1']['get']['parameters']);
-        $this->assertCount(2, $results['paths']['/path1']['post']['parameters']);
-        $this->assertEquals([
-            'in' => 'header',
-            'name' => 'Content-Type',
-            'description' => '',
-            'example' => 'application/json',
-            'schema' => ['type' => 'string'],
-        ], $results['paths']['/path1']['post']['parameters'][0]);
+        $this->assertCount(1, $results['paths']['/path1']['post']['parameters']);
         $this->assertEquals([
             'in' => 'header',
             'name' => 'Extra-Header',
             'description' => '',
             'example' => 'Some-example',
             'schema' => ['type' => 'string'],
-        ], $results['paths']['/path1']['post']['parameters'][1]);
+        ], $results['paths']['/path1']['post']['parameters'][0]);
     }
 
     /** @test */