default and query support when provided in validation rules

dedoc · Apr 7, 2024 · d71f07a · d71f07a
1 parent 7ccb054
commit d71f07a
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/src/Support/OperationExtensions/RulesExtractor/RulesToParameter.php b/src/Support/OperationExtensions/RulesExtractor/RulesToParameter.php
@@ -89,6 +89,14 @@ private function applyDocsInfo(Parameter $parameter)
             $parameter->example($examples[0]);
         }
 
+        if ($default = ExamplesExtractor::make($this->docNode, '@default')->extract(preferString: $parameter->schema->type instanceof StringType)) {
+            $parameter->default($default[0]);
+        }
+
+        if ($this->docNode->getTagsByName('@query')) {
+            $parameter->setAttribute('isInQuery', true);
+        }
+
         return $parameter;
     }
 

diff --git a/tests/Support/OperationExtensions/RequestBodyExtensionTest.php b/tests/Support/OperationExtensions/RequestBodyExtensionTest.php
@@ -245,3 +245,37 @@ public function index(Illuminate\Http\Request $request)
         $request->integer('foo', 10);
     }
 }
+
+it('allows specifying query position and default for params inferred from validation rules using validate method', function () {
+    $openApiDocument = generateForRoute(function () {
+        return RouteFacade::post('api/test', [RequestBodyExtensionTest__allows_specifying_query_position_and_default_for_params_inferred_from_validation_rules_using_validate_method::class, 'index']);
+    });
+
+    expect($openApiDocument['paths']['/test']['post']['requestBody']['content']['application/json']['schema']['properties'])
+        ->toBe([
+            'per_page' => [
+                'type' => 'integer',
+                'default' => 10,
+            ]
+        ])
+        ->and($openApiDocument['paths']['/test']['post']['parameters'])
+        ->toBe([[
+            'name' => 'all',
+            'in' => 'query',
+            'schema' => [
+                'type' => 'boolean',
+            ],
+        ]]);
+});
+class RequestBodyExtensionTest__allows_specifying_query_position_and_default_for_params_inferred_from_validation_rules_using_validate_method
+{
+    public function index(Illuminate\Http\Request $request)
+    {
+        $request->validate([
+            /** @default 10 */
+            'per_page' => 'integer',
+            /** @query */
+            'all' => 'boolean',
+        ]);
+    }
+}