- Switched to using enumValues for fields, sorts, includes, and appends

Author: dash8x

docs/generating-api-docs/adding-additional-fields.md

@@ -9,7 +9,13 @@ For those, you will need to define them as additional allowed methods by overrid
 ## apiDocAdditionalIndexQueryParameters()
 
 Use this method to specify additional query parameters for `index` endpoint.
-Will support all properties allowed by `Knuckles\Scribe\Attributes\QueryParam` Attribute.
+Will support the following properties: 
+- `description`
+- `type`
+- `required`
+- `example`
+- `enumValues`
+- `nullable`
 
 ```php
 // in IslandsController.php
@@ -34,7 +40,13 @@ public static function apiDocAdditionalIndexQueryParameters(): array
 ## apiDocAdditionalShowQueryParameters()
 
 Use this method to specify additional query parameters for `show` endpoint.
-Will support all properties allowed by `Knuckles\Scribe\Attributes\QueryParam` Attribute.
+Will support the following properties:
+- `description`
+- `type`
+- `required`
+- `example`
+- `enumValues`
+- `nullable`
 
 ```php
 // in IslandsController.php

docs/generating-api-docs/customizing-api-docs-metadata.md

@@ -12,7 +12,14 @@ Here are some of the methods we recommend to override.
 
 ## apiDocFilterMetadata()
 
-Use this method to describe what each filter does. Will support all properties allowed by `Knuckles\Scribe\Attributes\QueryParam` Attribute.
+Use this method to describe what each filter does.
+Will support the following properties:
+- `description`
+- `type`
+- `required`
+- `example`
+- `enumValues`
+- `nullable`
 
 ```php
 // in ProductsController.php

src/Concerns/ApiDocHelpers.php

@@ -206,9 +206,8 @@ public static function apiDocGenerateFieldsMetadata(array $fields): array
     {
         return [
             'type' => 'string',
-            'description' => static::apiFieldsDescription() .
-                '<br><br> **Allowed values:** ' . "\n" . implode("\n", array_map(fn($field) => "- `$field`", $fields)),
-            'enum' => $fields,
+            'description' => static::apiFieldsDescription(),
+            'enumValues' => $fields,
             'example' => implode(',', $fields),
         ];
     }
@@ -229,10 +228,8 @@ public static function apiDocGenerateSortsMetadata(array $sorts, string $default
     {
         return [
             'type' => 'string',
-            'description' => static::apiSortsDescription() .
-                '<br><br>**Allowed sorts:** ' . "\n" . implode("\n", array_map(fn($field) => "- `$field`", $sorts)) . "\n\n" .
-                '<br>**Default sort:** ' . ($default_sort ? '`' . $default_sort . '`' : 'None'),
-            'enum' => static::apiDocAllowedSorts(),
+            'description' => static::apiSortsDescription(),
+            'enumValues' => static::apiDocAllowedSorts(),
             'example' => static::apiDocDefaultSort(),
         ];
     }
@@ -254,9 +251,8 @@ public static function apiDocGenerateAppendsMetadata(array $appends): array
     {
         return [
             'type' => 'string',
-            'description' => static::apiAppendsDescription() .
-                '<br><br> **Allowed values:** ' . "\n" . implode("\n", array_map(fn($field) => "- `$field`", $appends)),
-            'enum' => $appends,
+            'description' => static::apiAppendsDescription(),
+            'enumValues' => $appends,
             'example' => implode(',', $appends),
         ];
     }
@@ -278,8 +274,8 @@ public static function apiDocGenerateIncludesMetadata(array $includes): array
     {
         return [
             'type' => 'string',
-            'description' => static::apiIncludesDescription() . '<br><br> **Allowed values:** ' . "\n" . implode("\n", array_map(fn($field) => "- `$field`", $includes)),
-            'enum' => $includes,
+            'description' => static::apiIncludesDescription(),
+            'enumValues' => $includes,
             'example' => implode(',', $includes),
         ];
     }

src/Concerns/IsApiController.php

@@ -9,7 +9,6 @@
 use Illuminate\Foundation\Bus\DispatchesJobs;
 use Illuminate\Foundation\Validation\ValidatesRequests;
 use Illuminate\Http\Request;
-use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 use Illuminate\Validation\ValidationException;
 use Javaabu\QueryBuilder\QueryBuilder;