- Removed examples from the docs

Author: dash8x

src/Concerns/ApiDocHelpers.php

@@ -208,7 +208,7 @@ public static function apiDocGenerateFieldsMetadata(array $fields): array
             'type' => 'string[]',
             'description' => static::apiFieldsDescription(),
             'enumValues' => $fields,
-            'example' => $fields,
+            //'example' => $fields,
         ];
     }
 
@@ -231,7 +231,7 @@ public static function apiDocGenerateSortsMetadata(array $sorts, string $default
             'description' => static::apiSortsDescription() .
                 '<br>**Default sort:** ' . ($default_sort ? '`' . $default_sort . '`' : 'None'),
             'enumValues' => $sorts,
-            'example' => [$default_sort],
+            //'example' => [$default_sort],
         ];
     }
 
@@ -254,7 +254,7 @@ public static function apiDocGenerateAppendsMetadata(array $appends): array
             'type' => 'string[]',
             'description' => static::apiAppendsDescription(),
             'enumValues' => $appends,
-            'example' => $appends,
+            //'example' => $appends,
         ];
     }
 
@@ -277,7 +277,7 @@ public static function apiDocGenerateIncludesMetadata(array $includes): array
             'type' => 'string[]',
             'description' => static::apiIncludesDescription(),
             'enumValues' => $includes,
-            'example' => $includes,
+            //'example' => $includes,
         ];
     }
 
@@ -289,7 +289,7 @@ public static function apiDocGeneratePerPageMetadata(): array
                 (static::apiDocAllowUnlimitedResultsPerPage() ? '<br></br>To return all results, set `per_page` to `-1`' : '') .
                 '<br>**Max per page:** ' . static::apiDocMaxPerPage() .
                 '<br>**Default per page:** ' . static::apiDocDefaultPerPage(),
-            'example' => static::apiDocDefaultPerPage(),
+            //'example' => static::apiDocDefaultPerPage(),
         ];
     }
 
@@ -298,7 +298,7 @@ public static function apiDocGeneratePageMetadata(): array
         return [
             'type' => 'integer',
             'description' => 'For paginated results, which page to return.',
-            'example' => 1,
+            //'example' => 1,
         ];
     }
 

tests/Feature/ApiControllerTest.php

@@ -77,10 +77,10 @@ public function it_can_get_index_method_api_doc_query_params(): void
 
         $this->assertIsArray($params);
 
-        $this->assertArrayHasKey('fields', $params);
-        $this->assertArrayHasKey('include', $params);
-        $this->assertArrayHasKey('append', $params);
-        $this->assertArrayHasKey('sort', $params);
+        $this->assertArrayHasKey('fields[]', $params);
+        $this->assertArrayHasKey('include[]', $params);
+        $this->assertArrayHasKey('append[]', $params);
+        $this->assertArrayHasKey('sort[]', $params);
         $this->assertArrayHasKey('per_page', $params);
         $this->assertArrayHasKey('page', $params);
         $this->assertArrayHasKey('filter[name]', $params);
@@ -94,9 +94,9 @@ public function it_can_get_show_method_api_doc_query_params(): void
 
         $this->assertIsArray($params);
 
-        $this->assertArrayHasKey('fields', $params);
-        $this->assertArrayHasKey('include', $params);
-        $this->assertArrayHasKey('append', $params);
+        $this->assertArrayHasKey('fields[]', $params);
+        $this->assertArrayHasKey('include[]', $params);
+        $this->assertArrayHasKey('append[]', $params);
 
         $this->assertArrayNotHasKey('sort', $params);
         $this->assertArrayNotHasKey('per_page', $params);