date rule support

dedoc · Feb 12, 2025 · f1710f9 · f1710f9
1 parent 2eaa33c
commit f1710f9
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/src/Support/OperationExtensions/RulesExtractor/RulesMapper.php b/src/Support/OperationExtensions/RulesExtractor/RulesMapper.php
@@ -219,4 +219,13 @@ public function url(Type $type)
 
         return $type->format('uri');
     }
+
+    public function date(Type $type)
+    {
+        if ($type instanceof UnknownType) {
+            $type = $this->string($type);
+        }
+
+        return $type->format('date-time');
+    }
 }
diff --git a/tests/ValidationRulesDocumentingTest.php b/tests/ValidationRulesDocumentingTest.php
@@ -398,6 +398,20 @@ function validationRulesToDocumentationWithDeep($rulesToParameters)
         ->toHaveProperty('nullable', true);
 });
 
+it('documents date rule', function () {
+    $rules = [
+        'some_date' => 'date',
+    ];
+
+    $params = ($this->buildRulesToParameters)($rules)->handle();
+
+    expect($params = collect($params)->all())
+        ->toHaveCount(1)
+        ->and($params[0]->schema->type)
+        ->toBeInstanceOf(\Dedoc\Scramble\Support\Generator\Types\StringType::class)
+        ->toHaveProperty('format', 'date-time');
+});
+
 it('extracts rules from request->validate call', function () {
     RouteFacade::get('api/test', [ValidationRulesDocumenting_Test::class, 'index']);