Merge pull request #394 from dedoc/fix/parameters-placement-duplication

Added `@ignoreParam` support for skipping a parameter from being documented
dedoc · May 23, 2024 · 24a27c9 · 24a27c9
2 parents dbbf57b + 516fb08
commit 24a27c9
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 1 deletion.
diff --git a/src/Support/Generator/Types/Type.php b/src/Support/Generator/Types/Type.php
@@ -9,7 +9,7 @@ abstract class Type
 {
     use WithAttributes;
 
-    protected string $type;
+    public string $type;
 
     public string $format = '';
 

diff --git a/src/Support/OperationExtensions/RulesExtractor/RulesToParameter.php b/src/Support/OperationExtensions/RulesExtractor/RulesToParameter.php
@@ -38,6 +38,10 @@ public function __construct(string $name, $rules, ?PhpDocNode $docNode, TypeTran
 
     public function generate()
     {
+        if (count($this->docNode?->getTagsByName('@ignoreParam') ?? [])) {
+            return null;
+        }
+
         $rules = collect($this->rules)
             ->map(fn ($v) => method_exists($v, '__toString') ? $v->__toString() : $v)
             ->sortByDesc($this->rulesSorter());

diff --git a/src/Support/OperationExtensions/RulesExtractor/RulesToParameters.php b/src/Support/OperationExtensions/RulesExtractor/RulesToParameters.php
@@ -40,6 +40,7 @@ public function handle()
     {
         return collect($this->rules)
             ->map(fn ($rules, $name) => (new RulesToParameter($name, $rules, $this->nodeDocs[$name] ?? null, $this->openApiTransformer))->generate())
+            ->filter()
             ->pipe($this->handleNested(...))
             ->pipe($this->handleConfirmed(...))
             ->values()

diff --git a/tests/Support/OperationExtensions/RequestBodyExtensionTest.php b/tests/Support/OperationExtensions/RequestBodyExtensionTest.php
@@ -298,3 +298,23 @@ public function index(Illuminate\Http\Request $request)
         ]);
     }
 }
+
+it('ignores param in rules with annotation', function () {
+    $openApiDocument = generateForRoute(function () {
+        return RouteFacade::get('api/test/{id}', [RequestBodyExtensionTest__ignores_rules_param_with_annotation::class, 'index']);
+    });
+
+    expect($params = $openApiDocument['paths']['/test/{id}']['get']['parameters'])
+        ->toHaveCount(1)
+        ->and($params[0]['in'])->toBe('path');
+});
+class RequestBodyExtensionTest__ignores_rules_param_with_annotation
+{
+    public function index(Illuminate\Http\Request $request, string $id)
+    {
+        $request->validate([
+            /** @ignoreParam */
+            'id' => 'integer',
+        ]);
+    }
+}