Improve docs

surgeventures · Sep 12, 2024 · 381e93f · 381e93f
1 parent e4c2704
commit 381e93f
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -51,6 +51,22 @@ end
 defmodule MyApp.Schema do
   use Absinthe.Schema
   @prototype_schema AbsintheHelpers.Directives.Constraints
+
+  directive :constraints do
+    on([:argument_definition, :field_definition, :input_field_definition])
+
+    arg(:min, :integer, description: "Minimum value allowed")
+    arg(:max, :integer, description: "Maximum value allowed")
+    arg(:min_items, :integer, description: "Minimum number of items allowed in a list")
+    arg(:max_items, :integer, description: "Maximum number of items allowed in a list")
+  end
+
+  query do
+  end
+
+  mutation do
+  end
+
   # ...
 end
 ```

diff --git a/lib/phases/apply_constraints.ex b/lib/phases/apply_constraints.ex
@@ -18,7 +18,17 @@ defmodule AbsintheHelpers.Phases.ApplyConstraints do
 
       defmodule MyApp.Schema do
         use Absinthe.Schema
+
         @prototype_schema AbsintheHelpers.Directives.Constraints
+
+        directive :constraints do
+          on([:argument_definition, :field_definition, :input_field_definition])
+
+          arg(:min, :integer, description: "Minimum value allowed")
+          arg(:max, :integer, description: "Maximum value allowed")
+          arg(:min_items, :integer, description: "Minimum number of items allowed in a list")
+          arg(:max_items, :integer, description: "Maximum number of items allowed in a list")
+        end
         # ...
       end