Update oauth description with used flow

api-platform · Jan 11, 2020 · d05fad2 · d05fad2
1 parent 5727a1c
commit d05fad2
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/src/Swagger/Serializer/DocumentationNormalizer.php b/src/Swagger/Serializer/DocumentationNormalizer.php
@@ -639,7 +639,10 @@ private function computeDoc(bool $v3, Documentation $documentation, \ArrayObject
 
             $securityDefinitions['oauth'] = [
                 'type' => $this->oauthType,
-                'description' => 'OAuth client_credentials Grant',
+                'description' => sprintf(
+                    'OAuth 2.0 %s Grant',
+                    strtolower(preg_replace('/[A-Z]/', ' \\0', lcfirst($this->oauthFlow)))
+                ),
             ];
 
             if ($v3) {

diff --git a/tests/Swagger/Serializer/DocumentationNormalizerV2Test.php b/tests/Swagger/Serializer/DocumentationNormalizerV2Test.php
@@ -492,7 +492,7 @@ interface_exists(AdvancedNameConverterInterface::class)
             'securityDefinitions' => [
                 'oauth' => [
                     'type' => 'oauth2',
-                    'description' => 'OAuth client_credentials Grant',
+                    'description' => 'OAuth 2.0 application Grant',
                     'flow' => 'application',
                     'tokenUrl' => '/oauth/v2/token',
                     'authorizationUrl' => '/oauth/v2/auth',

diff --git a/tests/Swagger/Serializer/DocumentationNormalizerV3Test.php b/tests/Swagger/Serializer/DocumentationNormalizerV3Test.php
@@ -483,7 +483,7 @@ private function doTestNormalizeWithNameConverter(bool $legacy = false): void
             $legacy ? $nameConverter : null,
             true,
             'oauth2',
-            'application',
+            'authorizationCode',
             '/oauth/v2/token',
             '/oauth/v2/auth',
             ['scope param'],
@@ -554,9 +554,9 @@ private function doTestNormalizeWithNameConverter(bool $legacy = false): void
                 'securitySchemes' => [
                     'oauth' => [
                         'type' => 'oauth2',
-                        'description' => 'OAuth client_credentials Grant',
+                        'description' => 'OAuth 2.0 authorization code Grant',
                         'flows' => [
-                            'application' => [
+                            'authorizationCode' => [
                                 'tokenUrl' => '/oauth/v2/token',
                                 'authorizationUrl' => '/oauth/v2/auth',
                                 'scopes' => ['scope param'],