feat(preparator): exclude generic headers from random examples

OpenClassrooms · Feb 23, 2024 · 9b3470e · 9b3470e
1 parent 617f2c2
commit 9b3470e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/src/Definition/Collection/Parameters.php b/src/Definition/Collection/Parameters.php
@@ -38,12 +38,17 @@ public function getExamples(): array
     }
 
     /**
+     * @param string[] $exclude
+     *
      * @return array<string, string>
      */
-    public function getRandomExamples(): array
+    public function getRandomExamples(array $exclude = []): array
     {
         $params = [];
         foreach ($this as $parameter) {
+            if (\in_array(mb_strtolower($parameter->getName()), $exclude, true)) {
+                continue;
+            }
             $schema = $parameter->getSchema();
             if ($schema !== null) {
                 $random = (new SchemaFaker($schema, new Options()))->generate();

diff --git a/src/Definition/Example/OperationExample.php b/src/Definition/Example/OperationExample.php
@@ -258,7 +258,11 @@ public function getHeaders(): array
             if ($this->forceRandom || ($this->autoComplete && \count($this->headers) < $definitionHeadersCount)) {
                 $randomHeaders = $this->parent
                     ->getHeaders()
-                    ->getRandomExamples()
+                    ->getRandomExamples([
+                        'content-type',
+                        'authorization',
+                        'range',
+                    ])
                 ;
                 $this->headers = array_merge($randomHeaders, $this->headers);
             }