moved default value from parameter (#438)

dedoc · Jun 29, 2024 · 6a0ee09 · 6a0ee09
1 parent b5ea08a
commit 6a0ee09
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 20 deletions.
diff --git a/src/Support/Generator/Parameter.php b/src/Support/Generator/Parameter.php
@@ -22,9 +22,6 @@ class Parameter
     /** @var array|scalar|null|MissingExample */
     public $example;
 
-    /** @var array|scalar|null|MissingExample */
-    public $default;
-
     public bool $deprecated = false;
 
     public bool $allowEmptyValue = false;
@@ -37,7 +34,6 @@ public function __construct(string $name, string $in)
         $this->in = $in;
 
         $this->example = new MissingExample;
-        $this->default = new MissingExample;
 
         if ($this->in === 'path') {
             $this->required = true;
@@ -67,7 +63,6 @@ public function toArray(): array
         return array_merge(
             $result,
             $this->example instanceof MissingExample ? [] : ['example' => $this->example],
-            $this->default instanceof MissingExample ? [] : ['default' => $this->default],
         );
     }
 
@@ -92,13 +87,6 @@ public function setSchema(?Schema $schema): self
         return $this;
     }
 
-    public function default($default)
-    {
-        $this->default = $default;
-
-        return $this;
-    }
-
     public function description(string $description)
     {
         $this->description = $description;

diff --git a/src/Support/Generator/Schema.php b/src/Support/Generator/Schema.php
@@ -46,7 +46,6 @@ public static function createFromParameters(array $parameters)
 
                 $paramType->setDescription($parameter->description);
                 $paramType->example($parameter->example);
-                $paramType->default($parameter->default);
 
                 $type->addProperty($parameter->name, $paramType);
             })

diff --git a/src/Support/IndexBuilders/RequestParametersBuilder.php b/src/Support/IndexBuilders/RequestParametersBuilder.php
@@ -94,9 +94,10 @@ public function afterAnalyzedNode(Scope $scope, Node $node)
         $parameter
             ->description($this->makeDescriptionFromComments($commentHolderNode))
             ->setSchema(Schema::fromType(
-                app(TypeTransformer::class)->transform($parameterType)
-            ))
-            ->default($parameterDefault ?? new MissingExample);
+                app(TypeTransformer::class)
+                    ->transform($parameterType)
+                    ->default($parameterDefault ?? new MissingExample)
+            ));
 
         $this->bag->set($parameterName, $parameter);
     }

diff --git a/src/Support/OperationExtensions/RulesExtractor/RulesToParameter.php b/src/Support/OperationExtensions/RulesExtractor/RulesToParameter.php
@@ -90,7 +90,7 @@ private function applyDocsInfo(Parameter $parameter)
         }
 
         if ($default = ExamplesExtractor::make($this->docNode, '@default')->extract(preferString: $parameter->schema->type instanceof StringType)) {
-            $parameter->default($default[0]);
+            $parameter->schema->type->default($default[0]);
         }
 
         if ($this->docNode->getTagsByName('@query')) {

diff --git a/tests/Support/OperationExtensions/RequestBodyExtensionTest.php b/tests/Support/OperationExtensions/RequestBodyExtensionTest.php
@@ -197,8 +197,8 @@ enum RequestBodyExtensionTest__Status_Params_Extraction: string
             'in' => 'query',
             'schema' => [
                 'type' => 'string',
+                'default' => 'foo',
             ],
-            'default' => 'foo',
         ]]);
 });
 class RequestBodyExtensionTest__extracts_parameters_from_retrieving_methods_with_query
@@ -254,8 +254,10 @@ public function index(Illuminate\Http\Request $request)
         ->toBe([[
             'name' => 'foo',
             'in' => 'query',
-            'schema' => ['type' => 'integer'],
-            'default' => 10,
+            'schema' => [
+                'type' => 'integer',
+                'default' => 10,
+            ],
         ]]);
 });
 class RequestBodyExtensionTest__allows_explicitly_specifying_parameter_placement_in_query_manually_in_doc