Allow adding inline documentation

Author: tobyzerner

src/Handler/Index.php

@@ -246,7 +246,7 @@ private function filter($query, Request $request)
             }
 
             if (isset($filters[$name])) {
-                $filters[$name]($query, $value, $request);
+                $filters[$name]->getCallback()($query, $value, $request);
                 continue;
             }
 

src/Schema/Field.php

@@ -20,6 +20,7 @@ abstract class Field
     use HasListeners;
 
     private $name;
+    private $description;
     private $property;
     private $visible = true;
     private $single = false;
@@ -41,6 +42,16 @@ public function __construct(string $name)
      */
     abstract public function getLocation(): string;
 
+    /**
+     * Set the description of the field for documentation generation.
+     */
+    public function description(string $description)
+    {
+        $this->description = $description;
+
+        return $this;
+    }
+
     /**
      * Set the model property to which this field corresponds.
      */

src/Schema/Filter.php

@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of tobyz/json-api-server.
+ *
+ * (c) Toby Zerner <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Tobyz\JsonApiServer\Schema;
+
+final class Filter
+{
+    private $name;
+    private $callback;
+    private $description;
+
+    public function __construct(string $name, callable $callback)
+    {
+        $this->name = $name;
+        $this->callback = $callback;
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function getCallback(): callable
+    {
+        return $this->callback;
+    }
+
+    /**
+     * Set the description of the type for documentation generation.
+     */
+    public function description(string $description)
+    {
+        $this->description = $description;
+    }
+}

src/Schema/Type.php

@@ -19,6 +19,7 @@ final class Type
 {
     use HasListeners, HasMeta;
 
+    private $description;
     private $fields = [];
     private $filters = [];
     private $sortFields = [];
@@ -35,6 +36,14 @@ final class Type
     private $deletable = false;
     private $deleteCallback;
 
+    /**
+     * Set the description of the type for documentation generation.
+     */
+    public function description(string $description)
+    {
+        $this->description = $description;
+    }
+
     /**
      * Add an attribute to the resource type.
      *
@@ -98,9 +107,9 @@ public function getFields(): array
     /**
      * Add a filter to the resource type.
      */
-    public function filter(string $name, callable $callback): void
+    public function filter(string $name, callable $callback): Filter
     {
-        $this->filters[$name] = $callback;
+        return $this->filters[$name] = new Filter($name, $callback);
     }
 
     /**