From 990b781322f161a69acf9f85a8be7f8dba5eebc1 Mon Sep 17 00:00:00 2001 From: Ilyas Salikhov Date: Tue, 1 Oct 2024 18:33:15 +0300 Subject: [PATCH] remove unused https annotation param --- Annotation/ApiDoc.php | 26 --------- Extractor/Handler/PhpDocHandler.php | 9 --- Resources/doc/the-apidoc-annotation.rst | 2 - Resources/views/method.html.twig | 8 +-- Tests/Extractor/ApiDocExtractorTest.php | 2 +- Tests/Fixtures/Controller/TestController.php | 7 --- Tests/Fixtures/app/config/routing.yml | 5 -- Tests/Formatter/SimpleFormatterTest.php | 1 - Tests/Formatter/testFormat-result_1.markdown | 4 -- Tests/Formatter/testFormat-result_1.php | 61 +++++--------------- 10 files changed, 17 insertions(+), 108 deletions(-) diff --git a/Annotation/ApiDoc.php b/Annotation/ApiDoc.php index 4a2658a..4db218e 100644 --- a/Annotation/ApiDoc.php +++ b/Annotation/ApiDoc.php @@ -125,11 +125,6 @@ class ApiDoc */ private $route; - /** - * @var bool - */ - private $https = false; - /** * @var int */ @@ -288,10 +283,6 @@ class ApiDoc } } - if (isset($data['https'])) { - $this->https = $data['https']; - } - if (isset($data['resourceDescription'])) { $this->resourceDescription = $data['resourceDescription']; } @@ -522,22 +513,6 @@ class ApiDoc $this->host = $host; } - /** - * @return bool - */ - public function getHttps() - { - return $this->https; - } - - /** - * @param bool $https - */ - public function setHttps($https): void - { - $this->https = $https; - } - /** * @return int */ @@ -698,7 +673,6 @@ class ApiDoc $data['resourceDescription'] = $resourceDescription; } - $data['https'] = $this->https; $data['deprecated'] = $this->deprecated; $data['scope'] = $this->scope; diff --git a/Extractor/Handler/PhpDocHandler.php b/Extractor/Handler/PhpDocHandler.php index 5e90c89..4e74d79 100644 --- a/Extractor/Handler/PhpDocHandler.php +++ b/Extractor/Handler/PhpDocHandler.php @@ -54,15 +54,6 @@ class PhpDocHandler implements HandlerInterface 'description' => '', ]; } - - if ('_scheme' === $name) { - $https = ('https' == $value); - $annotation->setHttps($https); - } - } - - if (method_exists($route, 'getSchemes')) { - $annotation->setHttps(in_array('https', $route->getSchemes())); } $paramDocs = []; diff --git a/Resources/doc/the-apidoc-annotation.rst b/Resources/doc/the-apidoc-annotation.rst index a5c7468..56e1206 100644 --- a/Resources/doc/the-apidoc-annotation.rst +++ b/Resources/doc/the-apidoc-annotation.rst @@ -65,8 +65,6 @@ The following properties are available: * ``resource``: whether the method describes a main resource or not (default: ``false``); * ``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``); * ``tags``: allow to tag a method (e.g. ``beta`` or ``in-development``). Either a single tag or an array of tags. Each tag can have an optional hex colorcode diff --git a/Resources/views/method.html.twig b/Resources/views/method.html.twig index f9181d3..f697efa 100644 --- a/Resources/views/method.html.twig +++ b/Resources/views/method.html.twig @@ -11,10 +11,6 @@ {% endif %} - {% if data.https %} - - {% endif %} - {% if data.host is defined -%} {{ data.https ? 'https://' : 'http://' -}} @@ -231,9 +227,9 @@ {% if enableSandbox %}
{% if app.request is not null and data.https and app.request.secure != data.https %} - Please reload the documentation using the scheme {% if data.https %}HTTPS{% else %}HTTP{% endif %} if you want to use the sandbox. + Please reload the documentation using the scheme HTTP if you want to use the sandbox. {% else %} -
+
Input {% if data.requirements is defined %} diff --git a/Tests/Extractor/ApiDocExtractorTest.php b/Tests/Extractor/ApiDocExtractorTest.php index 3a87f68..4ad3556 100644 --- a/Tests/Extractor/ApiDocExtractorTest.php +++ b/Tests/Extractor/ApiDocExtractorTest.php @@ -17,7 +17,7 @@ use Nelmio\ApiDocBundle\Tests\WebTestCase; class ApiDocExtractorTest extends WebTestCase { - private static $ROUTES_QUANTITY_DEFAULT = 27; // Routes in the default view + private static $ROUTES_QUANTITY_DEFAULT = 26; // Routes in the default view private static $ROUTES_QUANTITY_PREMIUM = 5; // Routes in the premium view private static $ROUTES_QUANTITY_TEST = 2; // Routes in the test view diff --git a/Tests/Fixtures/Controller/TestController.php b/Tests/Fixtures/Controller/TestController.php index 43bc938..ed790a7 100644 --- a/Tests/Fixtures/Controller/TestController.php +++ b/Tests/Fixtures/Controller/TestController.php @@ -145,13 +145,6 @@ class TestController { } - /** - * @ApiDoc() - */ - public function secureRouteAction(): void - { - } - /** * @ApiDoc() */ diff --git a/Tests/Fixtures/app/config/routing.yml b/Tests/Fixtures/app/config/routing.yml index c0ec458..dea434a 100644 --- a/Tests/Fixtures/app/config/routing.yml +++ b/Tests/Fixtures/app/config/routing.yml @@ -42,11 +42,6 @@ test_route_10: methods: [GET] defaults: { _controller: Nelmio\ApiDocBundle\Tests\Fixtures\Controller\TestController::jmsReturnTestAction } -test_route_12: - path: /secure-route - schemes: [https] - defaults: { _controller: Nelmio\ApiDocBundle\Tests\Fixtures\Controller\TestController::secureRouteAction } - test_service_route_1: path: /tests.{_format} methods: [GET] diff --git a/Tests/Formatter/SimpleFormatterTest.php b/Tests/Formatter/SimpleFormatterTest.php index d0d15a6..9e03015 100644 --- a/Tests/Formatter/SimpleFormatterTest.php +++ b/Tests/Formatter/SimpleFormatterTest.php @@ -58,7 +58,6 @@ class SimpleFormatterTest extends WebTestCase 'requirements' => [ '_format' => ['dataType' => '', 'description' => '', 'requirement' => ''], ], - 'https' => false, 'deprecated' => false, 'scope' => null, ]; diff --git a/Tests/Formatter/testFormat-result_1.markdown b/Tests/Formatter/testFormat-result_1.markdown index e33fa15..92f837b 100644 --- a/Tests/Formatter/testFormat-result_1.markdown +++ b/Tests/Formatter/testFormat-result_1.markdown @@ -682,10 +682,6 @@ _Route with host placeholder_ -### `ANY` /secure-route ### - - - ### `GET` /with-link ### diff --git a/Tests/Formatter/testFormat-result_1.php b/Tests/Formatter/testFormat-result_1.php index 6427d77..f5b8206 100644 --- a/Tests/Formatter/testFormat-result_1.php +++ b/Tests/Formatter/testFormat-result_1.php @@ -285,7 +285,6 @@ With multiple lines.', ], ], 'resourceDescription' => 'Operations on another resource.', - 'https' => false, 'deprecated' => false, 'scope' => null, ], @@ -305,7 +304,6 @@ With multiple lines.', 'description' => '', ], ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], @@ -374,7 +372,6 @@ With multiple lines.', ], ], 'resourceDescription' => 'Operations on resource.', - 'https' => false, 'deprecated' => false, 'scope' => null, ], @@ -810,7 +807,6 @@ With multiple lines.', 'untilVersion' => '0.5', ], ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], @@ -830,7 +826,6 @@ With multiple lines.', 'description' => '', ], ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], @@ -850,7 +845,6 @@ With multiple lines.', 'description' => '', ], ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], @@ -879,7 +873,6 @@ With multiple lines.', 'description' => '', ], ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], @@ -937,7 +930,6 @@ With multiple lines.', 0 => 'default', 1 => 'premium', ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], @@ -958,7 +950,6 @@ With multiple lines.', 0 => 'default', 1 => 'premium', ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], @@ -970,7 +961,6 @@ With multiple lines.', 'views' => [ 0 => 'default', ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], @@ -1006,7 +996,6 @@ With multiple lines.', 0 => 'default', 1 => 'test', ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], @@ -1021,7 +1010,6 @@ With multiple lines.', 'description' => '', ], ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], @@ -1285,7 +1273,6 @@ With multiple lines.', 'untilVersion' => null, ], ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], @@ -1315,7 +1302,6 @@ With multiple lines.', ], ], ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], @@ -1347,7 +1333,6 @@ And, it supports multilines until the first \'@\' char.', 'requirement' => '', ], ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], @@ -1610,7 +1595,6 @@ With multiple lines.', 'untilVersion' => null, ], ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], @@ -1634,26 +1618,17 @@ With multiple lines.', 'views' => [ 0 => 'default', ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], 7 => [ - 'method' => 'ANY', - 'uri' => '/secure-route', - 'https' => true, + 'method' => 'GET', + 'uri' => '/with-link', + 'link' => 'http://symfony.com', 'deprecated' => false, 'scope' => null, ], 8 => [ - 'method' => 'GET', - 'uri' => '/with-link', - 'link' => 'http://symfony.com', - 'https' => false, - 'deprecated' => false, - 'scope' => null, - ], - 9 => [ 'method' => 'ANY', 'uri' => '/yet-another/{id}', 'requirements' => [ @@ -1663,18 +1638,16 @@ With multiple lines.', 'description' => '', ], ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], - 10 => [ + 9 => [ 'method' => 'GET', 'uri' => '/z-action-with-deprecated-indicator', - 'https' => false, 'deprecated' => true, 'scope' => null, ], - 11 => [ + 10 => [ 'method' => 'ANY', 'uri' => '/z-return-jms-and-validator-output', 'response' => [ @@ -1787,11 +1760,10 @@ With multiple lines.', ], ], ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], - 12 => [ + 11 => [ 'method' => 'ANY', 'uri' => '/z-return-selected-parsers-input', 'parameters' => [ @@ -1832,11 +1804,10 @@ With multiple lines.', 'readonly' => false, ], ], - 'https' => false, 'deprecated' => false, 'scope' => null, ], - 13 => [ + 12 => [ 'method' => 'ANY', 'uri' => '/z-return-selected-parsers-output', 'response' => [ @@ -1949,25 +1920,22 @@ With multiple lines.', ], ], ], - 'https' => false, + 'deprecated' => false, + 'scope' => null, + ], + 13 => [ + 'method' => 'POST', + 'uri' => '/zcached', 'deprecated' => false, 'scope' => null, ], 14 => [ 'method' => 'POST', - 'uri' => '/zcached', - 'https' => false, + 'uri' => '/zsecured', 'deprecated' => false, 'scope' => null, ], 15 => [ - 'method' => 'POST', - 'uri' => '/zsecured', - 'https' => false, - 'deprecated' => false, - 'scope' => null, - ], - 16 => [ 'method' => 'GET', 'uri' => '/zz-tests-route-version.{_format}', 'requirements' => [ @@ -1977,7 +1945,6 @@ With multiple lines.', 'description' => '', ], ], - 'https' => false, 'deprecated' => false, 'scope' => null, ],