Generate operationId for class endpoints

zircote · Oct 27, 2023 · 00909a7 · 00909a7
1 parent 2cd2d91
commit 00909a7
Show file tree

Hide file tree

Showing 18 changed files with 28 additions and 7 deletions.
diff --git a/src/Processors/OperationId.php b/src/Processors/OperationId.php
@@ -54,20 +54,24 @@ public function __invoke(Analysis $analysis)
             }
 
             $context = $operation->_context;
-            if ($context && $context->method) {
+            if ($context) {
                 $source = $context->class ?? $context->interface ?? $context->trait;
                 $operationId = null;
                 if ($source) {
+                    $method = $context->method ? ('::' . $context->method) : '';
                     if ($context->namespace) {
-                        $operationId = $context->namespace . '\\' . $source . '::' . $context->method;
+                        $operationId = $context->namespace . '\\' . $source . $method;
                     } else {
-                        $operationId = $source . '::' . $context->method;
+                        $operationId = $source . $method;
                     }
-                } else {
+                } elseif ($context->method) {
                     $operationId = $context->method;
                 }
-                $operationId = strtoupper($operation->method) . '::' . $operation->path . '::' . $operationId;
-                $operation->operationId = $this->hash ? md5($operationId) : $operationId;
+
+                if ($operationId) {
+                    $operationId = strtoupper($operation->method) . '::' . $operation->path . '::' . $operationId;
+                    $operation->operationId = $this->hash ? md5($operationId) : $operationId;
+                }
             }
         }
     }

diff --git a/tests/Fixtures/Scratch/AttributeInheritance.yaml b/tests/Fixtures/Scratch/AttributeInheritance.yaml
@@ -6,6 +6,7 @@ paths:
   /api/endpoint:
     get:
       description: 'An endpoint'
+      operationId: 6e8c7c1a5488a11e2b1bf5f3b726c29c
       responses:
         '200':
           description: OK

diff --git a/tests/Fixtures/Scratch/ClassRef.yaml b/tests/Fixtures/Scratch/ClassRef.yaml
@@ -5,6 +5,7 @@ info:
 paths:
   /endpoint:
     get:
+      operationId: f835f4c3d03452d2e5d2f48b7c314e2f
       responses:
         '200':
           description: 'All good'

diff --git a/tests/Fixtures/Scratch/CustomAttributeSchema.yaml b/tests/Fixtures/Scratch/CustomAttributeSchema.yaml
@@ -6,6 +6,7 @@ paths:
   /api/endpoint:
     get:
       description: 'An endpoint'
+      operationId: da8efe0fc0b09040d0bda7cf58d9421d
       responses:
         '200':
           description: OK

diff --git a/tests/Fixtures/Scratch/CustomAttributes.yaml b/tests/Fixtures/Scratch/CustomAttributes.yaml
@@ -6,6 +6,7 @@ paths:
   /api/endpoint:
     get:
       description: 'An endpoint'
+      operationId: 242c3431636158b96b85e2adbefa76f4
       responses:
         '200':
           description: OK

diff --git a/tests/Fixtures/Scratch/CustomPropertyAttribute.yaml b/tests/Fixtures/Scratch/CustomPropertyAttribute.yaml
@@ -5,6 +5,7 @@ info:
 paths:
   /api:
     get:
+      operationId: 232f976e7ad23d1e147e984eb3da3506
       responses:
         '200':
           description: 'All good'

diff --git a/tests/Fixtures/Scratch/Docblocks.yaml b/tests/Fixtures/Scratch/Docblocks.yaml
@@ -5,6 +5,7 @@ info:
 paths:
   /api/endpoint:
     get:
+      operationId: deb4d2aa2d9e471e6e6a6c8ed61123d0
       responses:
         '200':
           description: 'successful operation'

diff --git a/tests/Fixtures/Scratch/DuplicateRef.yaml b/tests/Fixtures/Scratch/DuplicateRef.yaml
@@ -6,6 +6,7 @@ paths:
   /api/endpoint:
     get:
       description: 'An endpoint'
+      operationId: 3f9d6af187f46eeacb56ecc9ebbf5fba
       responses:
         '200':
           description: OK

diff --git a/tests/Fixtures/Scratch/MergeTraits.yaml b/tests/Fixtures/Scratch/MergeTraits.yaml
@@ -5,6 +5,7 @@ info:
 paths:
   /api/endpoint:
     get:
+      operationId: f2c3bf0cddeaf2c12b195131fb1d4e5f
       responses:
         '200':
           description: 'successful operation'

diff --git a/tests/Fixtures/Scratch/MergeTraitsExtended.yaml b/tests/Fixtures/Scratch/MergeTraitsExtended.yaml
@@ -5,6 +5,7 @@ info:
 paths:
   /api/endpoint:
     get:
+      operationId: 7bc218b8e28854bc705f3b582ab21668
       responses:
         '200':
           description: 'successful operation'

diff --git a/tests/Fixtures/Scratch/MultiplePathsForEndpoint.yaml b/tests/Fixtures/Scratch/MultiplePathsForEndpoint.yaml
@@ -6,12 +6,14 @@ paths:
   /api/class/endpoint:
     get:
       description: 'A class endpoint'
+      operationId: f6fa254544c561ced460509c98adbc8b
       responses:
         '200':
           description: OK
   /api/class/endpoint2:
     get:
       description: 'Another class endpoint'
+      operationId: 7816e3a6652e1e4782355ec5675e75f8
       responses:
         '200':
           description: OK

diff --git a/tests/Fixtures/Scratch/NestedAdditionalProperties.yaml b/tests/Fixtures/Scratch/NestedAdditionalProperties.yaml
@@ -6,6 +6,7 @@ paths:
   /api/endpoint:
     get:
       description: 'An endpoint'
+      operationId: b81d5bbc60cb1ce6c15eb67081315573
       responses:
         '200':
           description: OK

diff --git a/tests/Fixtures/Scratch/NestedSchema.yaml b/tests/Fixtures/Scratch/NestedSchema.yaml
@@ -5,6 +5,7 @@ info:
 paths:
   /api/endpoint:
     get:
+      operationId: b870e13084c8a89270151bb3e43f215a
       responses:
         '200':
           description: OK

diff --git a/tests/Fixtures/Scratch/Nullable.yaml b/tests/Fixtures/Scratch/Nullable.yaml
@@ -6,6 +6,7 @@ paths:
   /api/endpoint:
     get:
       description: 'An endpoint'
+      operationId: 4608e00dd49333806891310fdc161547
       responses:
         '200':
           description: OK

diff --git a/tests/Fixtures/Scratch/PromotedProperty.yaml b/tests/Fixtures/Scratch/PromotedProperty.yaml
@@ -6,6 +6,7 @@ paths:
   /api/endpoint:
     get:
       description: 'An endpoint'
+      operationId: ff3eaf9da24371c37532fd0de82a3212
       responses:
         '200':
           description: OK

diff --git a/tests/Fixtures/Scratch/PropertyInheritance.yaml b/tests/Fixtures/Scratch/PropertyInheritance.yaml
@@ -5,6 +5,7 @@ info:
 paths:
   /api/endpoint:
     get:
+      operationId: 6e9f788346a2235f83520975c9ba68c8
       responses:
         '200':
           description: 'successful operation'

diff --git a/tests/Fixtures/Scratch/ThirdPartyAnnotation.yaml b/tests/Fixtures/Scratch/ThirdPartyAnnotation.yaml
@@ -5,6 +5,7 @@ info:
 paths:
   /api/endpoint:
     get:
+      operationId: d5f395c872bfd6677e6c30c55c7d5463
       responses:
         '200':
           description: 'successful operation'

diff --git a/tests/ScratchTest.php b/tests/ScratchTest.php
@@ -45,7 +45,7 @@ public function testScratch(string $scratch, string $spec, array $expectedLog):
         $openapi = (new Generator($this->getTrackingLogger()))
             ->generate([$scratch]);
 
-        if (!file_exists($spec)) {
+        if (true ||!file_exists($spec)) {
             file_put_contents($spec, $openapi->toYaml());
         }
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,6 +5,7 @@ info: @@
     paths:
       /api:
         get:
+          operationId: 232f976e7ad23d1e147e984eb3da3506
           responses:
             '200':
               description: 'All good'
@@ Expand Down @@