Add examples property to Schema (#654)

Fixes #653

Author: madjar

lib/open_api_spex/schema.ex

@@ -183,6 +183,7 @@ defmodule OpenApiSpex.Schema do
     :xml,
     :externalDocs,
     :example,
+    :examples,
     :deprecated,
     :"x-struct",
     :"x-validate",
@@ -250,6 +251,7 @@ defmodule OpenApiSpex.Schema do
           xml: Xml.t() | nil,
           externalDocs: ExternalDocumentation.t() | nil,
           example: any,
+          examples: [any] | nil,
           deprecated: boolean | nil,
           "x-struct": module | nil,
           "x-validate": module | nil,
@@ -369,6 +371,10 @@ defmodule OpenApiSpex.Schema do
     schema.example
   end
 
+  def example(%Schema{examples: [example | _]}) when not is_nil(example) do
+    example
+  end
+
   def example(%Schema{enum: [example | _]}) do
     example
   end

test/schema_test.exs

@@ -103,6 +103,10 @@ defmodule OpenApiSpex.SchemaTest do
       assert Schema.example(%Schema{type: :string, example: "foo"}) == "foo"
     end
 
+    test "uses the first value in `examples` property when not nil" do
+      assert Schema.example(%Schema{type: :string, examples: ["foo", "bar"]}) == "foo"
+    end
+
     test "defaults to type-appropriate value for :string" do
       assert Schema.example(%Schema{type: :string}) == ""
     end