OpenAPI: default to v2 (#2408)

* OpenAPI: default to v2

* default export command to v2 and fix test

Author: dunglas

features/openapi/docs.feature

@@ -5,7 +5,7 @@ Feature: Documentation support
 
   @createSchema
   Scenario: Retrieve the OpenAPI documentation
-    Given I send a "GET" request to "/docs.json"
+    Given I send a "GET" request to "/docs.json?spec_version=3"
     Then the response status code should be 200
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/json; charset=utf-8"
@@ -89,15 +89,15 @@ Feature: Documentation support
 
   Scenario: OpenAPI UI is enabled for docs endpoint
     Given I add "Accept" header equal to "text/html"
-    And I send a "GET" request to "/docs"
+    And I send a "GET" request to "/docs?spec_version=3"
     Then the response status code should be 200
     And I should see text matching "My Dummy API"
     And I should see text matching "openapi"
     And I should see text matching "3.0.2"
 
   Scenario: OpenAPI UI is enabled for an arbitrary endpoint
     Given I add "Accept" header equal to "text/html"
-    And I send a "GET" request to "/dummies"
+    And I send a "GET" request to "/dummies?spec_version=3"
     Then the response status code should be 200
     And I should see text matching "openapi"
     And I should see text matching "3.0.2"

features/swagger/docs.feature

@@ -5,7 +5,7 @@ Feature: Documentation support
 
   @createSchema
   Scenario: Retrieve the Swagger/OpenAPI documentation
-    Given I send a "GET" request to "/docs.json?spec_version=2"
+    Given I send a "GET" request to "/docs.json"
     Then the response status code should be 200
     And the response should be in JSON
     And the header "Content-Type" should be equal to "application/json; charset=utf-8"
@@ -89,15 +89,15 @@ Feature: Documentation support
 
   Scenario: Swagger UI is enabled for docs endpoint
     Given I add "Accept" header equal to "text/html"
-    And I send a "GET" request to "/docs?spec_version=2"
+    And I send a "GET" request to "/docs"
     Then the response status code should be 200
     And I should see text matching "My Dummy API"
     And I should see text matching "swagger"
     And I should see text matching "2.0"
 
   Scenario: Swagger UI is enabled for an arbitrary endpoint
     Given I add "Accept" header equal to "text/html"
-    And I send a "GET" request to "/dummies?spec_version=2"
+    And I send a "GET" request to "/dummies"
     Then the response status code should be 200
     And I should see text matching "My Dummy API"
     And I should see text matching "swagger"

src/Bridge/Symfony/Bundle/Action/SwaggerUiAction.php

@@ -124,7 +124,7 @@ private function getContext(Request $request, Documentation $documentation): arr
             'graphqlEnabled' => $this->graphqlEnabled,
         ];
 
-        $swaggerContext = ['spec_version' => $request->query->getInt('spec_version', 3)];
+        $swaggerContext = ['spec_version' => $request->query->getInt('spec_version', 2)];
         if ('' !== $baseUrl = $request->getBaseUrl()) {
             $swaggerContext['base_url'] = $baseUrl;
         }

src/Bridge/Symfony/Bundle/Command/SwaggerCommand.php

@@ -61,7 +61,7 @@ protected function configure()
             ->setAliases(['api:swagger:export'])
             ->setDescription('Dump the OpenAPI documentation')
             ->addOption('yaml', 'y', InputOption::VALUE_NONE, 'Dump the documentation in YAML')
-            ->addOption('spec-version', null, InputOption::VALUE_OPTIONAL, 'OpenAPI version to use ("2" or "3")', '3')
+            ->addOption('spec-version', null, InputOption::VALUE_OPTIONAL, 'OpenAPI version to use ("2" or "3")', '2')
             ->addOption('output', 'o', InputOption::VALUE_OPTIONAL, 'Write output to file');
     }
 

src/Documentation/Action/DocumentationAction.php

@@ -62,7 +62,7 @@ public function __construct(ResourceNameCollectionFactoryInterface $resourceName
     public function __invoke(Request $request = null): Documentation
     {
         if (null !== $request) {
-            $context = ['base_url' => $request->getBaseUrl(), 'spec_version' => $request->query->getInt('spec_version', 3)];
+            $context = ['base_url' => $request->getBaseUrl(), 'spec_version' => $request->query->getInt('spec_version', 2)];
             if ($request->query->getBoolean('api_gateway', false)) {
                 $context['api_gateway'] = true;
             }

tests/Bridge/Symfony/Bundle/Command/SwaggerCommandTest.php

@@ -41,23 +41,23 @@ protected function setUp()
         $this->tester = new ApplicationTester($application);
     }
 
-    public function testExecuteWithAlias()
+    public function testExecuteWithAliasVersion3()
     {
-        $this->tester->run(['command' => 'api:swagger:export']);
+        $this->tester->run(['command' => 'api:swagger:export', '--spec-version' => '3']);
 
         $this->assertJson($this->tester->getDisplay());
     }
 
     public function testExecuteOpenApiVersion2()
     {
-        $this->tester->run(['command' => 'api:openapi:export', '--spec-version' => '2']);
+        $this->tester->run(['command' => 'api:openapi:export']);
 
         $this->assertJson($this->tester->getDisplay());
     }
 
-    public function testExecuteWithYaml()
+    public function testExecuteWithYamlVersion3()
     {
-        $this->tester->run(['command' => 'api:swagger:export', '--yaml' => true]);
+        $this->tester->run(['command' => 'api:swagger:export', '--yaml' => true, '--spec-version' => '3']);
 
         $result = $this->tester->getDisplay();
         $this->assertYaml($result);
@@ -85,7 +85,7 @@ public function testExecuteWithYaml()
 
     public function testExecuteOpenApiVersion2WithYaml()
     {
-        $this->tester->run(['command' => 'api:openapi:export', '--spec-version' => '2', '--yaml' => true]);
+        $this->tester->run(['command' => 'api:openapi:export', '--yaml' => true]);
 
         $result = $this->tester->getDisplay();
         $this->assertYaml($result);

tests/Documentation/Action/DocumentationActionTest.php

@@ -40,7 +40,7 @@ public function testDocumentationAction()
         $requestProphecy->query = $queryProphecy->reveal();
         $requestProphecy->getBaseUrl()->willReturn('/api')->shouldBeCalledTimes(1);
         $queryProphecy->getBoolean('api_gateway', false)->willReturn(true)->shouldBeCalledTimes(1);
-        $queryProphecy->getInt('spec_version', 3)->willReturn(2)->shouldBeCalledTimes(1);
+        $queryProphecy->getInt('spec_version', 2)->willReturn(2)->shouldBeCalledTimes(1);
         $attributesProphecy->all()->willReturn(['_api_normalization_context' => ['foo' => 'bar', 'base_url' => '/api', 'api_gateway' => true, 'spec_version' => 2]])->shouldBeCalledTimes(1);
         $attributesProphecy->get('_api_normalization_context', [])->willReturn(['foo' => 'bar'])->shouldBeCalledTimes(1);
         $attributesProphecy->set('_api_normalization_context', ['foo' => 'bar', 'base_url' => '/api', 'api_gateway' => true, 'spec_version' => 2])->shouldBeCalledTimes(1);