Merge pull request #292 from sc-bruno/feature/deprecation-ability

Add deprecation ability

src/Support/Generator/Operation.php

@@ -16,6 +16,8 @@ class Operation
 
     public string $summary = '';
 
+    public bool $deprecated = false;
+
     /** @var array<Security|array> */
     public array $security = [];
 
@@ -111,6 +113,13 @@ public function description(string $description)
         return $this;
     }
 
+    public function deprecated(bool $deprecated)
+    {
+        $this->deprecated = $deprecated;
+
+        return $this;
+    }
+
     public function setTags(array $tags)
     {
         $this->tags = array_map(fn ($t) => (string) $t, $tags);
@@ -141,6 +150,10 @@ public function toArray()
             $result['summary'] = $this->summary;
         }
 
+        if ($this->deprecated) {
+            $result['deprecated'] = $this->deprecated;
+        }
+
         if (count($this->tags)) {
             $result['tags'] = $this->tags;
         }

tests/Generator/Operation/OperationTest.php

@@ -0,0 +1,21 @@
+<?php
+
+it('deprecated key is properly set', function () {
+    $operation = new \Dedoc\Scramble\Support\Generator\Operation('get');
+    $operation->deprecated(true);
+
+    $array = $operation->toArray();
+
+    expect($operation->deprecated)->toBeTrue()
+        ->and($array)->toHaveKey('deprecated')
+        ->and($array['deprecated'])->toBeTrue();
+});
+
+it('default deprecated key is false', function () {
+    $operation = new \Dedoc\Scramble\Support\Generator\Operation('get');
+
+    $array = $operation->toArray();
+
+    expect($operation->deprecated)->toBeFalse()
+        ->and($array)->not()->toHaveKey('deprecated');
+});