Update Schema.example/2 typespec to allow references

open-api-spex · Jul 31, 2024 · 5ec452f · 5ec452f
1 parent 19ffc49
commit 5ec452f
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/lib/open_api_spex/schema.ex b/lib/open_api_spex/schema.ex
@@ -363,7 +363,8 @@ defmodule OpenApiSpex.Schema do
         assert ...
       end
   """
-  @spec example(schema :: Schema.t() | module) :: map | String.t() | number | boolean
+  @spec example(schema :: Schema.t() | module | Reference.t()) ::
+          map | String.t() | number | boolean
   def example(%Schema{example: example} = schema) when not is_nil(example) do
     schema.example
   end