No OneTemporary
Actions

Size

66 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/lib/open_api_spex.ex b/lib/open_api_spex.ex
	index bbae919..f57c3dc 100644
	--- a/lib/open_api_spex.ex
	+++ b/lib/open_api_spex.ex
	@@ -1,217 +1,225 @@
	defmodule OpenApiSpex do
	@moduledoc """
	Provides the entry-points for defining schemas, validating and casting.
	"""

	alias OpenApiSpex.{
	+ Components,
	OpenApi,
	Operation,
	Operation2,
	Reference,
	Schema,
	SchemaException,
	SchemaResolver
	}

	alias OpenApiSpex.Cast.Error

	@doc """
	Adds schemas to the api spec from the modules specified in the Operations.

	Eg, if the response schema for an operation is defined with:

	responses: %{
	200 => Operation.response("User", "application/json", UserResponse)
	}

	Then the `UserResponse.schema()` function will be called to load the schema, and
	a `Reference` to the loaded schema will be used in the operation response.

	See `OpenApiSpex.schema` macro for a convenient syntax for defining schema modules.
	"""
	@spec resolve_schema_modules(OpenApi.t()) :: OpenApi.t()
	def resolve_schema_modules(spec = %OpenApi{}) do
	SchemaResolver.resolve_schema_modules(spec)
	end

	def cast_and_validate(
	spec = %OpenApi{},
	operation = %Operation{},
	conn = %Plug.Conn{},
	content_type \\ nil
	) do
	Operation2.cast(operation, conn, content_type, spec.components)
	end

	@doc """
	Cast params to conform to a `OpenApiSpex.Schema`.

	See `OpenApiSpex.Schema.cast/3` for additional examples and details.
	"""
	@spec cast(OpenApi.t(), Schema.t() \| Reference.t(), any) :: {:ok, any} \| {:error, String.t()}
	def cast(spec = %OpenApi{}, schema = %Schema{}, params) do
	Schema.cast(schema, params, spec.components.schemas)
	end

	def cast(spec = %OpenApi{}, schema = %Reference{}, params) do
	Schema.cast(schema, params, spec.components.schemas)
	end

	@doc """
	Cast all params in `Plug.Conn` to conform to the schemas for `OpenApiSpex.Operation`.

	Returns `{:ok, Plug.Conn.t}` with `params` and `body_params` fields updated if successful,
	or `{:error, reason}` if casting fails.

	`content_type` may optionally be supplied to select the `requestBody` schema.
	"""
	@spec cast(OpenApi.t(), Operation.t(), Plug.Conn.t(), content_type \| nil) ::
	{:ok, Plug.Conn.t()} \| {:error, String.t()}
	when content_type: String.t()
	def cast(spec = %OpenApi{}, operation = %Operation{}, conn = %Plug.Conn{}, content_type \\ nil) do
	Operation.cast(operation, conn, content_type, spec.components.schemas)
	end

	@doc """
	Validate params against `OpenApiSpex.Schema`.

	See `OpenApiSpex.Schema.validate/3` for examples of error messages.
	"""
	@spec validate(OpenApi.t(), Schema.t() \| Reference.t(), any) :: :ok \| {:error, String.t()}
	def validate(spec = %OpenApi{}, schema = %Schema{}, params) do
	Schema.validate(schema, params, spec.components.schemas)
	end

	def validate(spec = %OpenApi{}, schema = %Reference{}, params) do
	Schema.validate(schema, params, spec.components.schemas)
	end

	@doc """
	Validate all params in `Plug.Conn` against `OpenApiSpex.Operation` `parameter` and `requestBody` schemas.

	`content_type` may be optionally supplied to select the `requestBody` schema.
	"""
	@spec validate(OpenApi.t(), Operation.t(), Plug.Conn.t(), content_type \| nil) ::
	:ok \| {:error, String.t()}
	when content_type: String.t()
	def validate(
	spec = %OpenApi{},
	operation = %Operation{},
	conn = %Plug.Conn{},
	content_type \\ nil
	) do
	Operation.validate(operation, conn, content_type, spec.components.schemas)
	end

	def path_to_string(%Error{} = error) do
	Error.path_to_string(error)
	end

	@doc """
	Declares a struct based `OpenApiSpex.Schema`

	- defines the schema/0 callback
	- ensures the schema is linked to the module by "x-struct" extension property
	- defines a struct with keys matching the schema properties
	- defines a @type `t` for the struct
	- derives a `Jason.Encoder` and/or `Poison.Encoder` for the struct

	See `OpenApiSpex.Schema` for additional examples and details.

	## Example

	require OpenApiSpex

	defmodule User do
	OpenApiSpex.schema %{
	title: "User",
	description: "A user of the app",
	type: :object,
	properties: %{
	id: %Schema{type: :integer, description: "User ID"},
	name: %Schema{type: :string, description: "User name", pattern: ~r/[a-zA-Z][a-zA-Z0-9_]+/},
	email: %Schema{type: :string, description: "Email address", format: :email},
	inserted_at: %Schema{type: :string, description: "Creation timestamp", format: :'date-time'},
	updated_at: %Schema{type: :string, description: "Update timestamp", format: :'date-time'}
	},
	required: [:name, :email],
	example: %{
	"id" => 123,
	"name" => "Joe User",
	"email" => "joe@gmail.com",
	"inserted_at" => "2017-09-12T12:34:55Z",
	"updated_at" => "2017-09-13T10:11:12Z"
	}
	}
	end
	"""
	defmacro schema(body) do
	quote do
	@compile {:report_warnings, false}
	@behaviour OpenApiSpex.Schema
	@schema struct(
	OpenApiSpex.Schema,
	Map.put(Map.delete(unquote(body), :__struct__), :"x-struct", __MODULE__)
	)
	def schema, do: @schema

	@derive Enum.filter([Poison.Encoder, Jason.Encoder], &Code.ensure_loaded?/1)
	defstruct Schema.properties(@schema)
	@type t :: %__MODULE__{}

	Map.from_struct(@schema) \|> OpenApiSpex.validate_compiled_schema()
	end
	end

	@doc """
	Validate the compiled schema's properties to ensure the schema is not improperly
	defined. Only errors which would cause a given schema to _always_ fail should be
	raised here.
	"""
	def validate_compiled_schema(schema) do
	Enum.each(schema, fn prop_and_val ->
	:ok = validate_compiled_schema(prop_and_val, schema)
	end)
	end

	def validate_compiled_schema({_, %Schema{} = schema}, _parent) do
	validate_compiled_schema(schema)
	end

	@doc """
	Used for validating the schema at compile time, otherwise we're forced
	to raise errors for improperly defined schemas at runtime.
	"""
	def validate_compiled_schema({:discriminator, %{propertyName: property, mapping: _}}, %{
	anyOf: schemas
	})
	when is_list(schemas) do
	Enum.each(schemas, fn schema ->
	case schema do
	%Schema{title: title} when is_binary(title) -> :ok
	_ -> error!(:discriminator_schema_missing_title, schema, property_name: property)
	end
	end)
	end

	def validate_compiled_schema({:discriminator, %{propertyName: _, mapping: _}}, schema) do
	case {schema.anyOf, schema.allOf, schema.oneOf} do
	{nil, nil, nil} ->
	error!(:discriminator_missing_composite_key, schema)

	_ ->
	:ok
	end
	end

	def validate_compiled_schema({_property, _value}, _schema), do: :ok

	@doc """
	Raises compile time errors for improperly defined schemas.
	"""
	@spec error!(atom(), Schema.t(), keyword()) :: no_return()
	@spec error!(atom(), Schema.t()) :: no_return()
	def error!(error, schema, details \\ []) do
	raise SchemaException, %{error: error, schema: schema, details: details}
	end
	+
	+ @doc """
	+ Resolve a schema or reference to a schema.
	+ """
	+ @spec resolve_schema(Schema.t() \| Reference.t(), Components.schemas_map()) :: Schema.t()
	+ def resolve_schema(%Schema{} = schema, _), do: schema
	+ def resolve_schema(%Reference{} = ref, schemas), do: Reference.resolve_schema(ref, schemas)
	end
	diff --git a/lib/open_api_spex/cast/all_of.ex b/lib/open_api_spex/cast/all_of.ex
	index 2a38690..169d031 100644
	--- a/lib/open_api_spex/cast/all_of.ex
	+++ b/lib/open_api_spex/cast/all_of.ex
	@@ -1,20 +1,23 @@
	defmodule OpenApiSpex.Cast.AllOf do
	@moduledoc false
	alias OpenApiSpex.Cast

	def cast(ctx),
	do: cast_all_of(ctx, nil)

	defp cast_all_of(%{schema: %{type: _, allOf: [schema \| remaining]}} = ctx, result) do
	- with {:ok, value} <- Cast.cast(%{ctx \| schema: schema}) do
	+ schema = OpenApiSpex.resolve_schema(schema, ctx.schemas)
	+ relaxed_schema = %{schema \| additionalProperties: true}
	+
	+ with {:ok, value} <- Cast.cast(%{ctx \| schema: relaxed_schema}) do
	new_schema = %{ctx.schema \| allOf: remaining}
	cast_all_of(%{ctx \| schema: new_schema}, result \|\| {:ok, value})
	else
	_ -> Cast.error(ctx, {:all_of, to_string(schema.title \|\| schema.type)})
	end
	end

	defp cast_all_of(_, {:ok, result}) do
	{:ok, result}
	end
	end
	diff --git a/lib/open_api_spex/cast/any_of.ex b/lib/open_api_spex/cast/any_of.ex
	index fd19883..a0cc0b6 100644
	--- a/lib/open_api_spex/cast/any_of.ex
	+++ b/lib/open_api_spex/cast/any_of.ex
	@@ -1,42 +1,44 @@
	defmodule OpenApiSpex.Cast.AnyOf do
	@moduledoc false
	alias OpenApiSpex.Cast

	def cast(ctx, failed_schemas \\ [])

	def cast(%_{schema: %{type: _, anyOf: []}} = ctx, failed_schemas) do
	- Cast.error(ctx, {:any_of, error_message(failed_schemas)})
	+ Cast.error(ctx, {:any_of, error_message(failed_schemas, ctx.schemas)})
	end

	def cast(
	%{schema: %{type: _, anyOf: [schema \| schemas]}} = ctx,
	failed_schemas
	) do
	with {:ok, value} <- Cast.cast(%{ctx \| schema: schema}) do
	{:ok, value}
	else
	_ ->
	new_schema = %{ctx.schema \| anyOf: schemas}
	cast(%{ctx \| schema: new_schema}, [schema \| failed_schemas])
	end
	end

	## Private functions

	- defp error_message([]) do
	+ defp error_message([], _) do
	"[] (no schemas provided)"
	end

	- defp error_message(failed_schemas) do
	+ defp error_message(failed_schemas, schemas) do
	for schema <- failed_schemas do
	+ schema = OpenApiSpex.resolve_schema(schema, schemas)
	+
	case schema do
	%{title: title, type: type} when not is_nil(title) ->
	"Schema(title: #{inspect(title)}, type: #{inspect(type)})"

	%{type: type} ->
	"Schema(type: #{inspect(type)})"
	end
	end
	\|> Enum.join(", ")
	end
	end
	diff --git a/lib/open_api_spex/cast/object.ex b/lib/open_api_spex/cast/object.ex
	index 45b7bcc..9c83a93 100644
	--- a/lib/open_api_spex/cast/object.ex
	+++ b/lib/open_api_spex/cast/object.ex
	@@ -1,123 +1,128 @@
	defmodule OpenApiSpex.Cast.Object do
	@moduledoc false
	alias OpenApiSpex.Cast
	alias OpenApiSpex.Cast.Error

	def cast(%{value: value} = ctx) when not is_map(value) do
	Cast.error(ctx, {:invalid_type, :object})
	end

	def cast(%{value: value, schema: %{properties: nil}}) do
	{:ok, value}
	end

	def cast(%{value: value, schema: schema} = ctx) do
	schema_properties = schema.properties \|\| %{}

	with :ok <- check_unrecognized_properties(ctx, schema_properties),
	value = cast_atom_keys(value, schema_properties),
	ctx = %{ctx \| value: value},
	:ok <- check_required_fields(ctx, schema),
	:ok <- check_max_properties(ctx),
	:ok <- check_min_properties(ctx),
	{:ok, value} <- cast_properties(%{ctx \| schema: schema_properties}) do
	ctx = to_struct(%{ctx \| value: value})
	{:ok, ctx}
	end
	end

	+ # When additionalProperties is true, extra properties are allowed in input
	+ defp check_unrecognized_properties(%{schema: %{additionalProperties: true}}, _expected_keys) do
	+ :ok
	+ end
	+
	defp check_unrecognized_properties(%{value: value} = ctx, expected_keys) do
	input_keys = value \|> Map.keys() \|> Enum.map(&to_string/1)
	schema_keys = expected_keys \|> Map.keys() \|> Enum.map(&to_string/1)
	extra_keys = input_keys -- schema_keys

	if extra_keys == [] do
	:ok
	else
	[name \| _] = extra_keys
	ctx = %{ctx \| path: [name \| ctx.path]}
	Cast.error(ctx, {:unexpected_field, name})
	end
	end

	defp check_required_fields(%{value: input_map} = ctx, schema) do
	required = schema.required \|\| []
	input_keys = Map.keys(input_map)
	missing_keys = required -- input_keys

	if missing_keys == [] do
	:ok
	else
	errors =
	Enum.map(missing_keys, fn key ->
	ctx = %{ctx \| path: [key \| ctx.path]}
	Error.new(ctx, {:missing_field, key})
	end)

	{:error, ctx.errors ++ errors}
	end
	end

	defp check_max_properties(%{schema: %{maxProperties: max_properties}} = ctx)
	when is_integer(max_properties) do
	count = ctx.value \|> Map.keys() \|> length()

	if count > max_properties do
	Cast.error(ctx, {:max_properties, max_properties, count})
	else
	:ok
	end
	end

	defp check_max_properties(_ctx), do: :ok

	defp check_min_properties(%{schema: %{minProperties: min_properties}} = ctx)
	when is_integer(min_properties) do
	count = ctx.value \|> Map.keys() \|> length()

	if count < min_properties do
	Cast.error(ctx, {:min_properties, min_properties, count})
	else
	:ok
	end
	end

	defp check_min_properties(_ctx), do: :ok

	defp cast_atom_keys(input_map, properties) do
	Enum.reduce(properties, %{}, fn {key, _}, output ->
	string_key = to_string(key)

	case input_map do
	%{^key => value} -> Map.put(output, key, value)
	%{^string_key => value} -> Map.put(output, key, value)
	_ -> output
	end
	end)
	end

	defp cast_properties(%{value: object, schema: schema_properties} = ctx) do
	Enum.reduce(object, {:ok, %{}}, fn
	{key, value}, {:ok, output} ->
	cast_property(%{ctx \| key: key, value: value, schema: schema_properties}, output)

	_, error ->
	error
	end)
	end

	defp cast_property(%{key: key, schema: schema_properties} = ctx, output) do
	prop_schema = Map.get(schema_properties, key)
	path = [key \| ctx.path]

	with {:ok, value} <- Cast.cast(%{ctx \| path: path, schema: prop_schema}) do
	{:ok, Map.put(output, key, value)}
	end
	end

	defp to_struct(%{value: value = %_{}}), do: value
	defp to_struct(%{value: value, schema: %{"x-struct": nil}}), do: value

	defp to_struct(%{value: value, schema: %{"x-struct": module}}),
	do: struct(module, value)
	end
	diff --git a/lib/open_api_spex/cast/one_of.ex b/lib/open_api_spex/cast/one_of.ex
	index 5306f73..b5a7623 100644
	--- a/lib/open_api_spex/cast/one_of.ex
	+++ b/lib/open_api_spex/cast/one_of.ex
	@@ -1,46 +1,48 @@
	defmodule OpenApiSpex.Cast.OneOf do
	@moduledoc false
	alias OpenApiSpex.Cast

	def cast(%_{schema: %{type: _, oneOf: []}} = ctx) do
	error(ctx, [])
	end

	def cast(%{schema: %{type: _, oneOf: schemas}} = ctx) do
	castable_schemas =
	Enum.reduce(schemas, {[], 0}, fn schema, {results, count} ->
	+ schema = OpenApiSpex.resolve_schema(schema, ctx.schemas)
	+
	case Cast.cast(%{ctx \| schema: %{schema \| anyOf: nil}}) do
	{:ok, value} -> {[{:ok, value, schema} \| results], count + 1}
	_ -> {results, count}
	end
	end)

	case castable_schemas do
	{[{:ok, value, _schema}], 1} -> {:ok, value}
	{failed_schemas, _count} -> error(ctx, failed_schemas)
	end
	end

	## Private functions

	defp error(ctx, failed_schemas) do
	Cast.error(ctx, {:one_of, error_message(failed_schemas)})
	end

	defp error_message([]) do
	"[] (no schemas provided)"
	end

	defp error_message(failed_schemas) do
	for {:ok, _value, schema} <- failed_schemas do
	case schema do
	%{title: title, type: type} when not is_nil(title) ->
	"Schema(title: #{inspect(title)}, type: #{inspect(type)})"

	%{type: type} ->
	"Schema(type: #{inspect(type)})"
	end
	end
	\|> Enum.join(", ")
	end
	end
	diff --git a/lib/open_api_spex/components.ex b/lib/open_api_spex/components.ex
	index 2617f52..8a87878 100644
	--- a/lib/open_api_spex/components.ex
	+++ b/lib/open_api_spex/components.ex
	@@ -1,40 +1,51 @@
	defmodule OpenApiSpex.Components do
	@moduledoc """
	Defines the `OpenApiSpex.Components.t` type.
	"""
	alias OpenApiSpex.{
	- Schema, Reference, Response, Parameter, Example,
	- RequestBody, Header, SecurityScheme, Link, Callback,
	+ Schema,
	+ Reference,
	+ Response,
	+ Parameter,
	+ Example,
	+ RequestBody,
	+ Header,
	+ SecurityScheme,
	+ Link,
	+ Callback,
	Components
	}
	+
	defstruct [
	:schemas,
	:responses,
	:parameters,
	:examples,
	:requestBodies,
	:headers,
	:securitySchemes,
	:links,
	- :callbacks,
	+ :callbacks
	]

	+ @type schemas_map :: %{String.t() => Schema.t() \| Reference.t()}
	+
	@typedoc """
	[Components Object](https://swagger.io/specification/#componentsObject)

	Holds a set of reusable objects for different aspects of the OAS.
	All objects defined within the components object will have no effect on the API unless
	they are explicitly referenced from properties outside the components object.
	"""
	@type t :: %Components{
	- schemas: %{String.t => Schema.t \| Reference.t} \| nil,
	- responses: %{String.t => Response.t \| Reference.t} \| nil,
	- parameters: %{String.t => Parameter.t \| Reference.t} \| nil,
	- examples: %{String.t => Example.t \| Reference.t} \| nil,
	- requestBodies: %{String.t => RequestBody.t \| Reference.t} \| nil,
	- headers: %{String.t => Header.t \| Reference.t} \| nil,
	- securitySchemes: %{String.t => SecurityScheme.t \| Reference.t} \| nil,
	- links: %{String.t => Link.t \| Reference.t} \| nil,
	- callbacks: %{String.t => Callback.t \| Reference.t} \| nil
	- }
	+ schemas: schemas_map \| nil,
	+ responses: %{String.t() => Response.t() \| Reference.t()} \| nil,
	+ parameters: %{String.t() => Parameter.t() \| Reference.t()} \| nil,
	+ examples: %{String.t() => Example.t() \| Reference.t()} \| nil,
	+ requestBodies: %{String.t() => RequestBody.t() \| Reference.t()} \| nil,
	+ headers: %{String.t() => Header.t() \| Reference.t()} \| nil,
	+ securitySchemes: %{String.t() => SecurityScheme.t() \| Reference.t()} \| nil,
	+ links: %{String.t() => Link.t() \| Reference.t()} \| nil,
	+ callbacks: %{String.t() => Callback.t() \| Reference.t()} \| nil
	+ }
	end
	diff --git a/lib/open_api_spex/reference.ex b/lib/open_api_spex/reference.ex
	index b7ec073..d1069a2 100644
	--- a/lib/open_api_spex/reference.ex
	+++ b/lib/open_api_spex/reference.ex
	@@ -1,38 +1,40 @@
	defmodule OpenApiSpex.Reference do
	@moduledoc """
	Defines the `OpenApiSpex.Reference.t` type.
	"""

	- alias OpenApiSpex.Reference
	+ alias OpenApiSpex.{Components, Reference}

	@enforce_keys :"$ref"
	defstruct [
	:"$ref"
	]

	@typedoc """
	[Reference Object](https://swagger.io/specification/#referenceObject)

	A simple object to allow referencing other components in the specification, internally and externally.
	The Reference Object is defined by JSON Reference and follows the same structure, behavior and rules.
	"""
	@type t :: %Reference{
	- "$ref": String.t
	- }
	+ "$ref": String.t()
	+ }

	@doc """
	Resolve a `Reference` to the `Schema` it refers to.

	## Examples

	iex> alias OpenApiSpex.{Reference, Schema}
	...> schemas = %{"user" => %Schema{title: "user", type: :object}}
	...> Reference.resolve_schema(%Reference{"$ref": "#/components/schemas/user"}, schemas)
	%OpenApiSpex.Schema{type: :object, title: "user"}
	"""
	- @spec resolve_schema(Reference.t, %{String.t => Schema.t}) :: Schema.t \| nil
	- def resolve_schema(%Reference{"$ref": "#/components/schemas/" <> name}, schemas), do: schemas[name]
	+ @spec resolve_schema(Reference.t(), Components.schema_map()) :: Schema.t() \| nil
	+ def resolve_schema(%Reference{"$ref": "#/components/schemas/" <> name}, schemas),
	+ do: schemas[name]

	- @spec resolve_parameter(Reference.t, %{String.t => Parameter.t}) :: Parameter.t \| nil
	- def resolve_parameter(%Reference{"$ref": "#/components/parameters/" <> name}, parameters), do: parameters[name]
	+ @spec resolve_parameter(Reference.t(), %{String.t() => Parameter.t()}) :: Parameter.t() \| nil
	+ def resolve_parameter(%Reference{"$ref": "#/components/parameters/" <> name}, parameters),
	+ do: parameters[name]
	end
	diff --git a/lib/open_api_spex/schema.ex b/lib/open_api_spex/schema.ex
	index bf68fc5..4920d16 100644
	--- a/lib/open_api_spex/schema.ex
	+++ b/lib/open_api_spex/schema.ex
	@@ -1,868 +1,873 @@
	defmodule OpenApiSpex.Schema do
	@moduledoc """
	Defines the `OpenApiSpex.Schema.t` type and operations for casting and validating against a schema.

	The `OpenApiSpex.schema` macro can be used to declare schemas with an associated struct and JSON Encoder.

	## Examples

	defmodule MyApp.Schemas do
	defmodule EmailString do
	@behaviour OpenApiSpex.Schema
	def schema do
	%OpenApiSpex.Schema {
	title: "EmailString",
	type: :string,
	format: :email
	}
	end
	end

	defmodule Person do
	require OpenApiSpex
	alias OpenApiSpex.{Reference, Schema}

	OpenApiSpex.schema(%{
	type: :object,
	required: [:name],
	properties: %{
	name: %Schema{type: :string},
	address: %Reference{"$ref": "#/components/schemas/Address"},
	age: %Schema{type: :integer, format: :int32, minimum: 0}
	}
	})
	end

	defmodule StringDictionary do
	@behaviour OpenApiSpex.Schema

	def schema() do
	%OpenApiSpex.Schema{
	type: :object,
	additionalProperties: %{
	type: :string
	}
	}
	end
	end

	defmodule Pet do
	require OpenApiSpex
	alias OpenApiSpex.{Schema, Discriminator}

	OpenApiSpex.schema(%{
	title: "Pet",
	type: :object,
	discriminator: %Discriminator{
	propertyName: "petType"
	},
	properties: %{
	name: %Schema{type: :string},
	petType: %Schema{type: :string}
	},
	required: [:name, :petType]
	})
	end

	defmodule Cat do
	require OpenApiSpex
	alias OpenApiSpex.Schema

	OpenApiSpex.schema(%{
	title: "Cat",
	type: :object,
	description: "A representation of a cat. Note that `Cat` will be used as the discriminator value.",
	allOf: [
	Pet,
	%Schema{
	type: :object,
	properties: %{
	huntingSkill: %Schema{
	type: :string,
	description: "The measured skill for hunting",
	default: "lazy",
	enum: ["clueless", "lazy", "adventurous", "aggresive"]
	}
	},
	required: [:huntingSkill]
	}
	]
	})
	end

	defmodule Dog do
	require OpenApiSpex
	alias OpenApiSpex.Schema

	OpenApiSpex.schema(%{
	type: :object,
	title: "Dog",
	description: "A representation of a dog. Note that `Dog` will be used as the discriminator value.",
	allOf: [
	Pet,
	%Schema {
	type: :object,
	properties: %{
	packSize: %Schema{
	type: :integer,
	format: :int32,
	description: "the size of the pack the dog is from",
	default: 0,
	minimum: 0
	}
	},
	required: [
	:packSize
	]
	}
	]
	})
	end
	end
	"""

	alias OpenApiSpex.{
	Schema,
	Reference,
	Discriminator,
	Xml,
	ExternalDocumentation
	}

	@doc """
	A module implementing the `OpenApiSpex.Schema` behaviour should export a `schema/0` function
	that produces an `OpenApiSpex.Schema` struct.
	"""
	@callback schema() :: t

	defstruct [
	:title,
	:multipleOf,
	:maximum,
	:exclusiveMaximum,
	:minimum,
	:exclusiveMinimum,
	:maxLength,
	:minLength,
	:pattern,
	:maxItems,
	:minItems,
	:uniqueItems,
	:maxProperties,
	:minProperties,
	:required,
	:enum,
	:type,
	:allOf,
	:oneOf,
	:anyOf,
	:not,
	:items,
	:properties,
	:additionalProperties,
	:description,
	:format,
	:default,
	:nullable,
	:discriminator,
	:readOnly,
	:writeOnly,
	:xml,
	:externalDocs,
	:example,
	:deprecated,
	:"x-struct"
	]

	@typedoc """
	[Schema Object](https://swagger.io/specification/#schemaObject)

	The Schema Object allows the definition of input and output data types.
	These types can be objects, but also primitives and arrays.
	This object is an extended subset of the JSON Schema Specification Wright Draft 00.

	## Example
	alias OpenApiSpex.Schema

	%Schema{
	title: "User",
	type: :object,
	properties: %{
	id: %Schema{type: :integer, minimum: 1},
	name: %Schema{type: :string, pattern: "[a-zA-Z][a-zA-Z0-9_]+"},
	email: %Scheam{type: :string, format: :email},
	last_login: %Schema{type: :string, format: :"date-time"}
	},
	required: [:name, :email],
	example: %{
	"name" => "joe",
	"email" => "joe@gmail.com"
	}
	}
	"""
	@type t :: %__MODULE__{
	title: String.t() \| nil,
	multipleOf: number \| nil,
	maximum: number \| nil,
	exclusiveMaximum: boolean \| nil,
	minimum: number \| nil,
	exclusiveMinimum: boolean \| nil,
	maxLength: integer \| nil,
	minLength: integer \| nil,
	pattern: String.t() \| Regex.t() \| nil,
	maxItems: integer \| nil,
	minItems: integer \| nil,
	uniqueItems: boolean \| nil,
	maxProperties: integer \| nil,
	minProperties: integer \| nil,
	required: [atom] \| nil,
	enum: [String.t()] \| nil,
	type: data_type \| nil,
	allOf: [Schema.t() \| Reference.t() \| module] \| nil,
	oneOf: [Schema.t() \| Reference.t() \| module] \| nil,
	anyOf: [Schema.t() \| Reference.t() \| module] \| nil,
	not: Schema.t() \| Reference.t() \| module \| nil,
	items: Schema.t() \| Reference.t() \| module \| nil,
	properties: %{atom => Schema.t() \| Reference.t() \| module} \| nil,
	additionalProperties: boolean \| Schema.t() \| Reference.t() \| module \| nil,
	description: String.t() \| nil,
	format: String.t() \| atom \| nil,
	default: any,
	nullable: boolean \| nil,
	discriminator: Discriminator.t() \| nil,
	readOnly: boolean \| nil,
	writeOnly: boolean \| nil,
	xml: Xml.t() \| nil,
	externalDocs: ExternalDocumentation.t() \| nil,
	example: any,
	deprecated: boolean \| nil,
	"x-struct": module \| nil
	}

	@typedoc """
	The basic data types supported by openapi.

	[Reference](https://swagger.io/docs/specification/data-models/data-types/)
	"""
	@type data_type :: :string \| :number \| :integer \| :boolean \| :array \| :object

	@typedoc """
	Global schemas lookup by name.
	"""
	@type schemas :: %{String.t() => t()}

	@doc """
	Cast a simple value to the elixir type defined by a schema.

	By default, object types are cast to maps, however if the "x-struct" attribute is set in the schema,
	the result will be constructed as an instance of the given struct type.

	## Examples

	iex> OpenApiSpex.Schema.cast(%Schema{type: :integer}, "123", %{})
	{:ok, 123}

	iex> {:ok, dt = %DateTime{}} = OpenApiSpex.Schema.cast(%Schema{type: :string, format: :"date-time"}, "2018-04-02T13:44:55Z", %{})
	...> dt \|> DateTime.to_iso8601()
	"2018-04-02T13:44:55Z"

	## Casting Polymorphic Schemas

	Schemas using `discriminator`, `allOf`, `oneOf`, `anyOf` are cast using the following rules:

	- If a `discriminator` is present, cast the properties defined in the base schema, then
	cast the result using the schema identified by the discriminator. To avoid infinite recursion,
	the discriminator is only dereferenced if the discriminator property has not already been cast.

	- Cast the properties using each schema listing in `allOf`. When a property is defined in
	multiple `allOf` schemas, it will be cast using the first schema listed containing the property.

	- Cast the value using each schema listed in `oneOf`, stopping as soon as a sucessful cast is made.

	- Cast the value using each schema listed in `anyOf`, stopping as soon as a succesful cast is made.
	"""
	def cast(%Schema{type: :boolean}, value, _schemas) when is_boolean(value), do: {:ok, value}

	def cast(%Schema{type: :boolean}, value, _schemas) when is_binary(value) do
	case value do
	"true" -> {:ok, true}
	"false" -> {:ok, false}
	_ -> {:error, "Invalid boolean: #{inspect(value)}"}
	end
	end

	def cast(%Schema{type: :integer}, value, _schemas) when is_integer(value), do: {:ok, value}

	def cast(%Schema{type: :integer}, value, _schemas) when is_binary(value) do
	case Integer.parse(value) do
	{i, ""} -> {:ok, i}
	_ -> {:error, :bad_integer}
	end
	end

	def cast(%Schema{type: :number}, value, _schemas) when is_float(value), do: {:ok, value}

	def cast(%Schema{type: :number}, value, _schemas) when is_integer(value), do: {:ok, value / 1}

	def cast(%Schema{type: :number}, value, _schemas) when is_binary(value) do
	case Float.parse(value) do
	{x, ""} -> {:ok, x}
	_ -> {:error, :bad_float}
	end
	end

	def cast(%Schema{type: :string, format: :"date-time"}, value, _schemas) when is_binary(value) do
	case DateTime.from_iso8601(value) do
	{:ok, date_time = %DateTime{}, _offset} -> {:ok, date_time}
	error = {:error, _reason} -> error
	end
	end

	def cast(%Schema{type: :string, format: :date}, value, _schemas) when is_binary(value) do
	case Date.from_iso8601(value) do
	{:ok, date = %Date{}} -> {:ok, date}
	error = {:error, _reason} -> error
	end
	end

	def cast(%Schema{type: :string, format: :binary}, %Plug.Upload{} = value, _schemas) do
	{:ok, value}
	end

	def cast(%Schema{type: :string}, value, _schemas) when is_binary(value), do: {:ok, value}

	def cast(%Schema{type: :array, items: nil}, value, _schemas) when is_list(value),
	do: {:ok, value}

	def cast(%Schema{type: :array}, [], _schemas), do: {:ok, []}

	def cast(schema = %Schema{type: :array, items: items_schema}, [x \| rest], schemas) do
	with {:ok, x_cast} <- cast(items_schema, x, schemas),
	{:ok, rest_cast} <- cast(schema, rest, schemas) do
	{:ok, [x_cast \| rest_cast]}
	end
	end

	def cast(%Schema{type: :array}, value, _schemas) when not is_list(value) do
	{:error, "Invalid array: #{inspect(value)}"}
	end

	def cast(
	schema = %Schema{type: :object, discriminator: discriminator = %{}},
	value = %{},
	schemas
	) do
	discriminator_property = String.to_existing_atom(discriminator.propertyName)

	already_cast? =
	if Map.has_key?(value, discriminator_property) do
	{:error, :already_cast}
	else
	:ok
	end

	with :ok <- already_cast?,
	{:ok, partial_cast} <-
	cast(%Schema{type: :object, properties: schema.properties}, value, schemas),
	{:ok, derived_schema} <- Discriminator.resolve(discriminator, value, schemas),
	- {:ok, result} <- cast(derived_schema, partial_cast, schemas) do
	- {:ok, make_struct(result, schema)}
	+ {:ok, result} <- cast(derived_schema, partial_cast, schemas),
	+ {:ok, struct} <- make_struct(result, schema) do
	+ {:ok, struct}
	else
	{:error, :already_cast} -> {:ok, value}
	{:error, reason} -> {:error, reason}
	end
	end

	def cast(schema = %Schema{type: :object, allOf: [first \| rest]}, value = %{}, schemas) do
	with {:ok, cast_first} <- cast(first, value, schemas),
	{:ok, result} <- cast(%{schema \| allOf: rest}, cast_first, schemas) do
	{:ok, result}
	else
	{:error, reason} -> {:error, reason}
	end
	end

	def cast(schema = %Schema{type: :object, allOf: []}, value = %{}, schemas) do
	cast(%{schema \| allOf: nil}, value, schemas)
	end

	def cast(schema = %Schema{oneOf: [first \| rest]}, value, schemas) do
	case cast(first, value, schemas) do
	{:ok, result} ->
	- cast(%{schema \| oneOf: nil}, result, schemas)
	+ {:ok, result}

	{:error, _reason} ->
	cast(%{schema \| oneOf: rest}, value, schemas)
	end
	end

	def cast(%Schema{oneOf: []}, _value, _schemas) do
	{:error, "Failed to cast to any schema in oneOf"}
	end

	def cast(schema = %Schema{anyOf: [first \| rest]}, value, schemas) do
	case cast(first, value, schemas) do
	{:ok, result} ->
	cast(%{schema \| anyOf: nil}, result, schemas)

	{:error, _reason} ->
	cast(%{schema \| anyOf: rest}, value, schemas)
	end
	end

	def cast(%Schema{anyOf: []}, _value, _schemas) do
	{:error, "Failed to cast to any schema in anyOf"}
	end

	def cast(schema = %Schema{type: :object}, value, schemas) when is_map(value) do
	schema = %{schema \| properties: schema.properties \|\| %{}}

	{regular_properties, others} =
	value
	\|> no_struct()
	\|> Enum.split_with(fn {k, _v} -> is_binary(k) end)

	- with {:ok, props} <- cast_properties(schema, regular_properties, schemas) do
	- result = Map.new(others ++ props) \|> make_struct(schema)
	- {:ok, result}
	+ with {:ok, props} <- cast_properties(schema, regular_properties, schemas),
	+ {:ok, struct} <- Map.new(others ++ props) \|> make_struct(schema) do
	+ {:ok, struct}
	end
	end

	def cast(ref = %Reference{}, val, schemas),
	do: cast(Reference.resolve_schema(ref, schemas), val, schemas)

	def cast(_additionalProperties = false, val, _schemas) do
	{:error, "Unexpected field with value #{inspect(val)}"}
	end

	def cast(_additionalProperties, val, _schemas), do: {:ok, val}

	- defp make_struct(val = %_{}, _), do: val
	- defp make_struct(val, %{"x-struct": nil}), do: val
	+ defp make_struct(val = %_{}, _), do: {:ok, val}
	+ defp make_struct(val, %{"x-struct": nil}), do: {:ok, val}

	defp make_struct(val, %{"x-struct": mod}) do
	- Enum.reduce(val, struct(mod), fn {k, v}, acc ->
	- Map.put(acc, k, v)
	- end)
	+ keys = mod.schema \|> OpenApiSpex.Schema.properties() \|> Keyword.keys()
	+
	+ if Map.keys(val) -- keys == [] do
	+ {:ok, struct(mod, val)}
	+ else
	+ {:error, :bad_structure}
	+ end
	end

	defp no_struct(val), do: Map.delete(val, :__struct__)

	@spec cast_properties(Schema.t(), list, %{String.t() => Schema.t()}) ::
	{:ok, list} \| {:error, String.t()}
	defp cast_properties(%Schema{}, [], _schemas), do: {:ok, []}

	defp cast_properties(object_schema = %Schema{}, [{key, value} \| rest], schemas) do
	{name, schema} =
	Enum.find(
	object_schema.properties,
	{key, object_schema.additionalProperties},
	fn {name, _schema} -> to_string(name) == to_string(key) end
	)

	with {:ok, new_value} <- cast(schema, value, schemas),
	{:ok, cast_tail} <- cast_properties(object_schema, rest, schemas) do
	{:ok, [{name, new_value} \| cast_tail]}
	end
	end

	@doc ~S"""
	Validate a value against a Schema.

	This expects that the value has already been `cast` to the appropriate data type.

	## Examples

	iex> OpenApiSpex.Schema.validate(%OpenApiSpex.Schema{type: :integer, minimum: 5}, 3, %{})
	{:error, "#: 3 is smaller than minimum 5"}

	iex> OpenApiSpex.Schema.validate(%OpenApiSpex.Schema{type: :string, pattern: "(.)@(.)"}, "joe@gmail.com", %{})
	:ok

	iex> OpenApiSpex.Schema.validate(%OpenApiSpex.Schema{type: :string, pattern: "(.)@(.)"}, "joegmail.com", %{})
	{:error, "#: Value \"joegmail.com\" does not match pattern: (.)@(.)"}
	"""
	@spec validate(Schema.t() \| Reference.t(), any, %{String.t() => Schema.t() \| Reference.t()}) ::
	:ok \| {:error, String.t()}
	def validate(schema, val, schemas), do: validate(schema, val, "#", schemas)

	@spec validate(Schema.t() \| Reference.t(), any, String.t(), %{
	String.t() => Schema.t() \| Reference.t()
	}) :: :ok \| {:error, String.t()}
	def validate(ref = %Reference{}, val, path, schemas),
	do: validate(Reference.resolve_schema(ref, schemas), val, path, schemas)

	def validate(%Schema{nullable: true}, nil, _path, _schemas), do: :ok

	def validate(%Schema{type: type}, nil, path, _schemas) when not is_nil(type) do
	{:error, "#{path}: null value where #{type} expected"}
	end

	def validate(schema = %Schema{anyOf: valid_schemas}, value, path, schemas)
	when is_list(valid_schemas) do
	if Enum.any?(valid_schemas, &(validate(&1, value, path, schemas) == :ok)) do
	validate(%{schema \| anyOf: nil}, value, path, schemas)
	else
	{:error, "#{path}: Failed to validate against any schema"}
	end
	end

	def validate(schema = %Schema{oneOf: valid_schemas}, value, path, schemas)
	when is_list(valid_schemas) do
	case Enum.count(valid_schemas, &(validate(&1, value, path, schemas) == :ok)) do
	1 -> validate(%{schema \| oneOf: nil}, value, path, schemas)
	0 -> {:error, "#{path}: Failed to validate against any schema"}
	other -> {:error, "#{path}: Validated against #{other} schemas when only one expected"}
	end
	end

	def validate(schema = %Schema{allOf: required_schemas}, value, path, schemas)
	when is_list(required_schemas) do
	required_schemas
	\|> Enum.map(&validate(&1, value, path, schemas))
	\|> Enum.reject(&(&1 == :ok))
	\|> Enum.map(fn {:error, msg} -> msg end)
	\|> case do
	[] -> validate(%{schema \| allOf: nil}, value, path, schemas)
	errors -> {:error, Enum.join(errors, "\n")}
	end
	end

	def validate(schema = %Schema{not: not_schema}, value, path, schemas)
	when not is_nil(not_schema) do
	case validate(not_schema, value, path, schemas) do
	{:error, _} -> validate(%{schema \| not: nil}, value, path, schemas)
	:ok -> {:error, "#{path}: Value is valid for schema given in `not`"}
	end
	end

	def validate(%Schema{enum: options = [_ \| _]}, value, path, _schemas) do
	case Enum.member?(options, value) do
	true ->
	:ok

	_ ->
	{:error, "#{path}: Value not in enum: #{inspect(value)}"}
	end
	end

	def validate(schema = %Schema{type: :integer}, value, path, _schemas) when is_integer(value) do
	validate_number_types(schema, value, path)
	end

	def validate(schema = %Schema{type: :number}, value, path, _schemas) when is_number(value) do
	validate_number_types(schema, value, path)
	end

	def validate(schema = %Schema{type: :string}, value, path, _schemas) when is_binary(value) do
	validate_string_types(schema, value, path)
	end

	def validate(%Schema{type: :string, format: :"date-time"}, %DateTime{}, _path, _schemas) do
	:ok
	end

	def validate(%Schema{type: :string, format: :binary}, %Plug.Upload{}, _path, _schemas) do
	:ok
	end

	def validate(%Schema{type: expected_type}, %DateTime{}, path, _schemas) do
	{:error, "#{path}: invalid type DateTime where #{expected_type} expected"}
	end

	def validate(%Schema{type: :string, format: :date}, %Date{}, _path, _schemas) do
	:ok
	end

	def validate(%Schema{type: expected_type}, %Date{}, path, _schemas) do
	{:error, "#{path}: invalid type Date where #{expected_type} expected"}
	end

	def validate(%Schema{type: :boolean}, value, _path, _schemas) when is_boolean(value), do: :ok

	def validate(schema = %Schema{type: :array}, value, path, schemas) when is_list(value) do
	with :ok <- validate_max_items(schema, value, path),
	:ok <- validate_min_items(schema, value, path),
	:ok <- validate_unique_items(schema, value, path),
	:ok <- validate_array_items(schema, value, {path, 0}, schemas) do
	:ok
	end
	end

	def validate(schema = %Schema{type: :object}, value = %{}, path, schemas) do
	schema = %{schema \| properties: schema.properties \|\| %{}, required: schema.required \|\| []}

	with :ok <- validate_required_properties(schema, value, path),
	:ok <- validate_max_properties(schema, value, path),
	:ok <- validate_min_properties(schema, value, path),
	:ok <-
	validate_object_properties(
	schema.properties,
	MapSet.new(schema.required),
	value,
	path,
	schemas
	) do
	:ok
	end
	end

	def validate(%Schema{type: nil}, _value, _path, _schemas) do
	# polymorphic schemas will terminate here after validating against anyOf/oneOf/allOf/not
	:ok
	end

	def validate(%Schema{type: expected_type}, value, path, _schemas)
	when not is_nil(expected_type) do
	{:error, "#{path}: invalid type #{term_type(value)} where #{expected_type} expected"}
	end

	@spec term_type(term) :: data_type \| nil \| String.t()
	defp term_type(v) when is_list(v), do: :array
	defp term_type(v) when is_map(v), do: :object
	defp term_type(v) when is_binary(v), do: :string
	defp term_type(v) when is_boolean(v), do: :boolean
	defp term_type(v) when is_integer(v), do: :integer
	defp term_type(v) when is_number(v), do: :number
	defp term_type(v) when is_nil(v), do: nil
	defp term_type(v), do: inspect(v)

	@spec validate_number_types(Schema.t(), number, String.t()) :: :ok \| {:error, String.t()}
	defp validate_number_types(schema, value, path) do
	with :ok <- validate_multiple(schema, value, path),
	:ok <- validate_maximum(schema, value, path),
	:ok <- validate_minimum(schema, value, path) do
	:ok
	end
	end

	@spec validate_string_types(Schema.t(), String.t(), String.t()) :: :ok \| {:error, String.t()}
	defp validate_string_types(schema, value, path) do
	with :ok <- validate_max_length(schema, value, path),
	:ok <- validate_min_length(schema, value, path),
	:ok <- validate_pattern(schema, value, path) do
	:ok
	end
	end

	@spec validate_multiple(Schema.t(), number, String.t()) :: :ok \| {:error, String.t()}
	defp validate_multiple(%{multipleOf: nil}, _, _), do: :ok
	defp validate_multiple(%{multipleOf: n}, value, _) when round(value / n) * n == value, do: :ok

	defp validate_multiple(%{multipleOf: n}, value, path),
	do: {:error, "#{path}: #{value} is not a multiple of #{n}"}

	@spec validate_maximum(Schema.t(), number, String.t()) :: :ok \| {:error, String.t()}
	defp validate_maximum(%{maximum: nil}, _val, _path), do: :ok

	defp validate_maximum(%{maximum: n, exclusiveMaximum: true}, value, _path) when value < n,
	do: :ok

	defp validate_maximum(%{maximum: n, exclusiveMaximum: true}, value, path),
	do: {:error, "#{path}: #{value} is larger than the exclusive maximum #{n}"}

	defp validate_maximum(%{maximum: n}, value, _path) when value <= n, do: :ok

	defp validate_maximum(%{maximum: n}, value, path),
	do: {:error, "#{path}: #{value} is larger than maximum #{n}"}

	@spec validate_minimum(Schema.t(), number, String.t()) :: :ok \| {:error, String.t()}
	defp validate_minimum(%{minimum: nil}, _val, _path), do: :ok

	defp validate_minimum(%{minimum: n, exclusiveMinimum: true}, value, _path) when value > n,
	do: :ok

	defp validate_minimum(%{minimum: n, exclusiveMinimum: true}, value, path),
	do: {:error, "#{path}: #{value} is smaller than the exclusive minimum #{n}"}

	defp validate_minimum(%{minimum: n}, value, _path) when value >= n, do: :ok

	defp validate_minimum(%{minimum: n}, value, path),
	do: {:error, "#{path}: #{value} is smaller than minimum #{n}"}

	@spec validate_max_length(Schema.t(), String.t(), String.t()) :: :ok \| {:error, String.t()}
	defp validate_max_length(%{maxLength: nil}, _val, _path), do: :ok

	defp validate_max_length(%{maxLength: n}, value, path) do
	case String.length(value) <= n do
	true -> :ok
	_ -> {:error, "#{path}: String length is larger than maxLength: #{n}"}
	end
	end

	@spec validate_min_length(Schema.t(), String.t(), String.t()) :: :ok \| {:error, String.t()}
	defp validate_min_length(%{minLength: nil}, _val, _path), do: :ok

	defp validate_min_length(%{minLength: n}, value, path) do
	case String.length(value) >= n do
	true -> :ok
	_ -> {:error, "#{path}: String length is smaller than minLength: #{n}"}
	end
	end

	@spec validate_pattern(Schema.t(), String.t(), String.t()) :: :ok \| {:error, String.t()}
	defp validate_pattern(%{pattern: nil}, _val, _path), do: :ok

	defp validate_pattern(schema = %{pattern: regex}, val, path) when is_binary(regex) do
	with {:ok, regex} <- Regex.compile(regex) do
	validate_pattern(%{schema \| pattern: regex}, val, path)
	end
	end

	defp validate_pattern(%{pattern: regex = %Regex{}}, val, path) do
	case Regex.match?(regex, val) do
	true -> :ok
	_ -> {:error, "#{path}: Value #{inspect(val)} does not match pattern: #{regex.source}"}
	end
	end

	@spec validate_max_items(Schema.t(), list, String.t()) :: :ok \| {:error, String.t()}
	defp validate_max_items(%Schema{maxItems: nil}, _val, _path), do: :ok
	defp validate_max_items(%Schema{maxItems: n}, value, _path) when length(value) <= n, do: :ok

	defp validate_max_items(%Schema{maxItems: n}, value, path) do
	{:error, "#{path}: Array length #{length(value)} is larger than maxItems: #{n}"}
	end

	@spec validate_min_items(Schema.t(), list, String.t()) :: :ok \| {:error, String.t()}
	defp validate_min_items(%Schema{minItems: nil}, _val, _path), do: :ok
	defp validate_min_items(%Schema{minItems: n}, value, _path) when length(value) >= n, do: :ok

	defp validate_min_items(%Schema{minItems: n}, value, path) do
	{:error, "#{path}: Array length #{length(value)} is smaller than minItems: #{n}"}
	end

	@spec validate_unique_items(Schema.t(), list, String.t()) :: :ok \| {:error, String.t()}
	defp validate_unique_items(%Schema{uniqueItems: true}, value, path) do
	unique_size =
	value
	\|> MapSet.new()
	\|> MapSet.size()

	case unique_size == length(value) do
	true -> :ok
	_ -> {:error, "#{path}: Array items must be unique"}
	end
	end

	defp validate_unique_items(_schema, _value, _path), do: :ok

	@spec validate_array_items(Schema.t(), list, {String.t(), integer}, %{String.t() => Schema.t()}) ::
	:ok \| {:error, String.t()}
	defp validate_array_items(%Schema{type: :array, items: nil}, value, _path, _schemas)
	when is_list(value),
	do: :ok

	defp validate_array_items(%Schema{type: :array}, [], _path, _schemas), do: :ok

	defp validate_array_items(
	schema = %Schema{type: :array, items: item_schema},
	[x \| rest],
	{path, index},
	schemas
	) do
	with :ok <- validate(item_schema, x, "#{path}/#{index}", schemas) do
	validate_array_items(schema, rest, {path, index + 1}, schemas)
	end
	end

	@spec validate_required_properties(Schema.t(), %{}, String.t()) :: :ok \| {:error, String.t()}
	defp validate_required_properties(%Schema{type: :object, required: nil}, _val, _path), do: :ok

	defp validate_required_properties(%Schema{type: :object, required: required}, value = %{}, path) do
	missing = required -- Map.keys(value)

	case missing do
	[] -> :ok
	_ -> {:error, "#{path}: Missing required properties: #{inspect(missing)}"}
	end
	end

	@spec validate_max_properties(Schema.t(), %{}, String.t()) :: :ok \| {:error, String.t()}
	defp validate_max_properties(%Schema{type: :object, maxProperties: nil}, _val, _path), do: :ok

	defp validate_max_properties(%Schema{type: :object, maxProperties: n}, val, _path)
	when map_size(val) <= n,
	do: :ok

	defp validate_max_properties(%Schema{type: :object, maxProperties: n}, val, path) do
	{:error,
	"#{path}: Object property count #{map_size(val)} is greater than maxProperties: #{n}"}
	end

	@spec validate_min_properties(Schema.t(), %{}, String.t()) :: :ok \| {:error, String.t()}
	defp validate_min_properties(%Schema{type: :object, minProperties: nil}, _val, _path), do: :ok

	defp validate_min_properties(%Schema{type: :object, minProperties: n}, val, _path)
	when map_size(val) >= n,
	do: :ok

	defp validate_min_properties(%Schema{type: :object, minProperties: n}, val, path) do
	{:error, "#{path}: Object property count #{map_size(val)} is less than minProperties: #{n}"}
	end

	@spec validate_object_properties(Enumerable.t(), MapSet.t(), %{}, String.t(), %{
	String.t() => Schema.t() \| Reference.t()
	}) :: :ok \| {:error, String.t()}
	defp validate_object_properties(properties = %{}, required, value = %{}, path, schemas = %{}) do
	properties
	\|> Enum.filter(fn {name, _schema} -> Map.has_key?(value, name) end)
	\|> validate_object_properties(required, value, path, schemas)
	end

	defp validate_object_properties([], _required, _val, _path, _schemas), do: :ok

	defp validate_object_properties(
	[{name, schema} \| rest],
	required,
	value = %{},
	path,
	schemas = %{}
	) do
	property_required = MapSet.member?(required, name)
	property_value = Map.get(value, name)
	property_path = "#{path}/#{name}"

	with :ok <-
	validate_object_property(
	schema,
	property_required,
	property_value,
	property_path,
	schemas
	),
	:ok <- validate_object_properties(rest, required, value, path, schemas) do
	:ok
	end
	end

	defp validate_object_property(_schema, false, nil, _path, _schemas), do: :ok

	defp validate_object_property(schema, _required, value, path, schemas) do
	validate(schema, value, path, schemas)
	end

	@doc """
	Get the names of all properties definied for a schema.

	Includes all properties directly defined in the schema, and all schemas
	included in the `allOf` list.
	"""
	def properties(schema = %Schema{type: :object, properties: properties = %{}}) do
	for({name, property} <- properties, do: {name, default(property)}) ++
	properties(%{schema \| properties: nil})
	end

	def properties(%Schema{allOf: schemas}) when is_list(schemas) do
	Enum.flat_map(schemas, &properties/1) \|> Enum.uniq()
	end

	def properties(schema_module) when is_atom(schema_module) do
	properties(schema_module.schema())
	end

	def properties(_), do: []

	defp default(schema_module) when is_atom(schema_module), do: schema_module.schema().default
	defp default(%{default: default}), do: default
	end
	diff --git a/test/cast/all_of_test.exs b/test/cast/all_of_test.exs
	index 8a00b35..236a4ab 100644
	--- a/test/cast/all_of_test.exs
	+++ b/test/cast/all_of_test.exs
	@@ -1,30 +1,36 @@
	defmodule OpenApiSpex.CastAllOfTest do
	use ExUnit.Case
	alias OpenApiSpex.{Cast, Schema}
	alias OpenApiSpex.Cast.{Error, AllOf}
	+ alias OpenApiSpex.Test.Assertions2

	defp cast(ctx), do: AllOf.cast(struct(Cast, ctx))

	describe "cast/1" do
	test "allOf" do
	schema = %Schema{allOf: [%Schema{type: :integer}, %Schema{type: :string}]}
	assert {:ok, 1} = cast(value: "1", schema: schema)
	end

	test "allOf, uncastable schema" do
	schema = %Schema{allOf: [%Schema{type: :integer}, %Schema{type: :string}]}
	assert {:error, [error]} = cast(value: [:whoops], schema: schema)

	assert Error.message(error) ==
	"Failed to cast value as integer. Value must be castable using `allOf` schemas listed."

	schema_with_title = %Schema{allOf: [%Schema{title: "Age", type: :integer}]}

	assert {:error, [error_with_schema_title]} =
	cast(value: [:nopes], schema: schema_with_title)

	assert Error.message(error_with_schema_title) ==
	"Failed to cast value as Age. Value must be castable using `allOf` schemas listed."
	end
	+
	+ test "a more sophisticated example" do
	+ dog = %{"bark" => "woof", "pet_type" => "Dog"}
	+ Assertions2.assert_schema(dog, "Dog", OpenApiSpexTest.ApiSpec.spec())
	+ end
	end
	end
	diff --git a/test/cast/one_of_test.exs b/test/cast/one_of_test.exs
	index 284d72c..381e933 100644
	--- a/test/cast/one_of_test.exs
	+++ b/test/cast/one_of_test.exs
	@@ -1,31 +1,37 @@
	defmodule OpenApiSpex.CastOneOfTest do
	use ExUnit.Case
	alias OpenApiSpex.{Cast, Schema}
	alias OpenApiSpex.Cast.{Error, OneOf}
	+ alias OpenApiSpex.Test.Assertions2

	defp cast(ctx), do: OneOf.cast(struct(Cast, ctx))

	describe "cast/1" do
	test "oneOf" do
	schema = %Schema{oneOf: [%Schema{type: :integer}, %Schema{type: :string}]}
	assert {:ok, "hello"} = cast(value: "hello", schema: schema)
	end

	test "oneOf, more than one matching schema" do
	schema = %Schema{oneOf: [%Schema{type: :integer}, %Schema{type: :string}]}
	assert {:error, [error]} = cast(value: "1", schema: schema)
	assert error.reason == :one_of

	assert Error.message(error) ==
	"Failed to cast value to one of: Schema(type: :string), Schema(type: :integer)"
	end

	test "oneOf, no castable schema" do
	schema = %Schema{oneOf: [%Schema{type: :string}]}
	assert {:error, [error]} = cast(value: 1, schema: schema)
	assert error.reason == :one_of

	assert Error.message(error) == "Failed to cast value to one of: [] (no schemas provided)"
	end
	+
	+ test "a more sophisticated case" do
	+ dog = %{"bark" => "woof", "pet_type" => "Dog"}
	+ Assertions2.assert_schema(dog, "CatOrDog", OpenApiSpexTest.ApiSpec.spec())
	+ end
	end
	end
	diff --git a/test/schema_test.exs b/test/schema_test.exs
	index 965b8aa..8007155 100644
	--- a/test/schema_test.exs
	+++ b/test/schema_test.exs
	@@ -1,460 +1,474 @@
	defmodule OpenApiSpex.SchemaTest do
	use ExUnit.Case
	alias OpenApiSpex.Schema
	alias OpenApiSpexTest.{ApiSpec, Schemas}
	import OpenApiSpex.Test.Assertions

	doctest Schema

	describe "schema/1" do
	test "EntityWithDict Schema example matches schema" do
	api_spec = ApiSpec.spec()
	assert_schema(Schemas.EntityWithDict.schema().example, "EntityWithDict", api_spec)
	end

	test "User Schema example matches schema" do
	spec = ApiSpec.spec()

	assert_schema(Schemas.User.schema().example, "User", spec)
	assert_schema(Schemas.UserRequest.schema().example, "UserRequest", spec)
	assert_schema(Schemas.UserResponse.schema().example, "UserResponse", spec)
	assert_schema(Schemas.UsersResponse.schema().example, "UsersResponse", spec)
	end
	end

	describe "cast/3" do
	test "cast request schema" do
	api_spec = ApiSpec.spec()
	schemas = api_spec.components.schemas
	user_request_schema = schemas["UserRequest"]

	input = %{
	"user" => %{
	"id" => 123,
	"name" => "asdf",
	"email" => "foo@bar.com",
	"updated_at" => "2017-09-12T14:44:55Z"
	}
	}

	{:ok, output} = Schema.cast(user_request_schema, input, schemas)

	assert output == %OpenApiSpexTest.Schemas.UserRequest{
	user: %OpenApiSpexTest.Schemas.User{
	id: 123,
	name: "asdf",
	email: "foo@bar.com",
	updated_at: DateTime.from_naive!(~N[2017-09-12T14:44:55], "Etc/UTC")
	}
	}
	end

	test "cast request schema with unexpected fields returns error" do
	api_spec = ApiSpec.spec()
	schemas = api_spec.components.schemas
	user_request_schema = schemas["UserRequest"]

	input = %{
	"user" => %{
	"id" => 123,
	"name" => "asdf",
	"email" => "foo@bar.com",
	"updated_at" => "2017-09-12T14:44:55Z",
	"unexpected_field" => "unexpected value"
	}
	}

	assert {:error, _} = Schema.cast(user_request_schema, input, schemas)
	end

	test "Cast Cat from Pet schema" do
	api_spec = ApiSpec.spec()
	schemas = api_spec.components.schemas
	pet_schema = schemas["Pet"]

	input = %{
	"pet_type" => "Cat",
	"meow" => "meow"
	}

	assert {:ok, %Schemas.Cat{meow: "meow", pet_type: "Cat"}} =
	Schema.cast(pet_schema, input, schemas)
	end

	test "Cast Dog from oneOf [cat, dog] schema" do
	api_spec = ApiSpec.spec()
	schemas = api_spec.components.schemas
	cat_or_dog = Map.fetch!(schemas, "CatOrDog")

	+ input = %{
	+ "pet_type" => "Dog",
	+ "bark" => "bowow"
	+ }
	+
	+ assert {:ok, %Schemas.Dog{bark: "bowow", pet_type: "Dog"}} =
	+ Schema.cast(cat_or_dog, input, schemas)
	+ end
	+
	+ test "Cast Cat from oneOf [cat, dog] schema" do
	+ api_spec = ApiSpec.spec()
	+ schemas = api_spec.components.schemas
	+ cat_or_dog = Map.fetch!(schemas, "CatOrDog")
	+
	input = %{
	"pet_type" => "Cat",
	"meow" => "meow"
	}

	assert {:ok, %Schemas.Cat{meow: "meow", pet_type: "Cat"}} =
	Schema.cast(cat_or_dog, input, schemas)
	end

	test "Cast number to string or number" do
	schema = %Schema{
	oneOf: [
	%Schema{type: :number},
	%Schema{type: :string}
	]
	}

	result = Schema.cast(schema, "123", %{})

	assert {:ok, 123.0} = result
	end

	test "Cast integer to float" do
	schema = %Schema{type: :number}

	assert Schema.cast(schema, 123, %{}) === {:ok, 123.0}
	end

	test "Cast string to oneOf number or date-time" do
	schema = %Schema{
	oneOf: [
	%Schema{type: :number},
	%Schema{type: :string, format: :"date-time"}
	]
	}

	assert {:ok, %DateTime{}} = Schema.cast(schema, "2018-04-01T12:34:56Z", %{})
	end

	test "Cast string to anyOf number or date-time" do
	schema = %Schema{
	oneOf: [
	%Schema{type: :number},
	%Schema{type: :string, format: :"date-time"}
	]
	}

	assert {:ok, %DateTime{}} = Schema.cast(schema, "2018-04-01T12:34:56Z", %{})
	end
	end

	describe "Integer validation" do
	test "Validate schema type integer when value is object" do
	schema = %Schema{
	type: :integer
	}

	assert {:error, _} = Schema.validate(schema, %{}, %{})
	end
	end

	describe "Number validation" do
	test "Validate schema type number when value is object" do
	schema = %Schema{
	type: :integer
	}

	assert {:error, _} = Schema.validate(schema, %{}, %{})
	end

	test "Validate schema type number when value is exclusive" do
	schema = %Schema{
	type: :integer,
	minimum: -1,
	maximum: 1,
	exclusiveMinimum: true,
	exclusiveMaximum: true
	}

	assert {:error, _} = Schema.validate(schema, 1, %{})
	assert {:error, _} = Schema.validate(schema, -1, %{})
	end
	end

	describe "String validation" do
	test "Validate schema type string when value is object" do
	schema = %Schema{
	type: :string
	}

	assert {:error, _} = Schema.validate(schema, %{}, %{})
	end

	test "Validate schema type string when value is DateTime" do
	schema = %Schema{
	type: :string
	}

	assert {:error, _} = Schema.validate(schema, DateTime.utc_now(), %{})
	end

	test "Validate non-empty string with expected value" do
	schema = %Schema{type: :string, minLength: 1}
	assert :ok = Schema.validate(schema, "BLIP", %{})
	end
	end

	describe "DateTime validation" do
	test "Validate schema type string with format date-time when value is DateTime" do
	schema = %Schema{
	type: :string,
	format: :"date-time"
	}

	assert :ok = Schema.validate(schema, DateTime.utc_now(), %{})
	end
	end

	describe "Date Validation" do
	test "Validate schema type string with format date when value is Date" do
	schema = %Schema{
	type: :string,
	format: :date
	}

	assert :ok = Schema.validate(schema, Date.utc_today(), %{})
	end
	end

	describe "Enum validation" do
	test "Validate string enum with unexpected value" do
	schema = %Schema{
	type: :string,
	enum: ["foo", "bar"]
	}

	assert {:error, _} = Schema.validate(schema, "baz", %{})
	end

	test "Validate string enum with expected value" do
	schema = %Schema{
	type: :string,
	enum: ["foo", "bar"]
	}

	assert :ok = Schema.validate(schema, "bar", %{})
	end
	end

	describe "Object validation" do
	test "Validate schema type object when value is array" do
	schema = %Schema{
	type: :object
	}

	assert {:error, _} = Schema.validate(schema, [], %{})
	end

	test "Validate schema type object when value is DateTime" do
	schema = %Schema{
	type: :object
	}

	assert {:error, _} = Schema.validate(schema, DateTime.utc_now(), %{})
	end
	end

	describe "Array validation" do
	test "Validate schema type array when value is object" do
	schema = %Schema{
	type: :array
	}

	assert {:error, _} = Schema.validate(schema, %{}, %{})
	end
	end

	describe "Boolean validation" do
	test "Validate schema type boolean when value is object" do
	schema = %Schema{
	type: :boolean
	}

	assert {:error, _} = Schema.validate(schema, %{}, %{})
	end
	end

	describe "AnyOf validation" do
	test "Validate anyOf schema with valid value" do
	schema = %Schema{
	anyOf: [
	%Schema{type: :array},
	%Schema{type: :string}
	]
	}

	assert :ok = Schema.validate(schema, "a string", %{})
	end

	test "Validate anyOf with value matching more than one schema" do
	schema = %Schema{
	anyOf: [
	%Schema{type: :number},
	%Schema{type: :integer}
	]
	}

	assert :ok = Schema.validate(schema, 42, %{})
	end

	test "Validate anyOf schema with invalid value" do
	schema = %Schema{
	anyOf: [
	%Schema{type: :string},
	%Schema{type: :array}
	]
	}

	assert {:error, _} = Schema.validate(schema, 3.14159, %{})
	end
	end

	describe "OneOf validation" do
	test "Validate oneOf schema with valid value" do
	schema = %Schema{
	oneOf: [
	%Schema{type: :string},
	%Schema{type: :array}
	]
	}

	assert :ok = Schema.validate(schema, [1, 2, 3], %{})
	end

	test "Validate oneOf schema with invalid value" do
	schema = %Schema{
	oneOf: [
	%Schema{type: :string},
	%Schema{type: :array}
	]
	}

	assert {:error, _} = Schema.validate(schema, 3.14159, %{})
	end

	test "Validate oneOf schema when matching multiple schemas" do
	schema = %Schema{
	oneOf: [
	%Schema{type: :object, properties: %{a: %Schema{type: :string}}},
	%Schema{type: :object, properties: %{b: %Schema{type: :string}}}
	]
	}

	assert {:error, _} = Schema.validate(schema, %{a: "a", b: "b"}, %{})
	end
	end

	describe "AllOf validation" do
	test "Validate allOf schema with valid value" do
	schema = %Schema{
	allOf: [
	%Schema{type: :object, properties: %{a: %Schema{type: :string}}},
	%Schema{type: :object, properties: %{b: %Schema{type: :string}}}
	]
	}

	assert :ok = Schema.validate(schema, %{a: "a", b: "b"}, %{})
	end

	test "Validate allOf schema with invalid value" do
	schema = %Schema{
	allOf: [
	%Schema{type: :object, properties: %{a: %Schema{type: :string}}},
	%Schema{type: :object, properties: %{b: %Schema{type: :string}}}
	]
	}

	assert {:error, msg} = Schema.validate(schema, %{a: 1, b: 2}, %{})
	assert msg =~ "#/a"
	assert msg =~ "#/b"
	end

	test "Validate allOf with value matching not all schemas" do
	schema = %Schema{
	allOf: [
	%Schema{
	type: :integer,
	minimum: 5
	},
	%Schema{
	type: :integer,
	maximum: 40
	}
	]
	}

	assert {:error, _} = Schema.validate(schema, 42, %{})
	end
	end

	describe "Not validation" do
	test "Validate not schema with valid value" do
	schema = %Schema{
	not: %Schema{type: :object}
	}

	assert :ok = Schema.validate(schema, 1, %{})
	end

	test "Validate not schema with invalid value" do
	schema = %Schema{
	not: %Schema{type: :object}
	}

	assert {:error, _} = Schema.validate(schema, %{a: 1}, %{})
	end

	test "Verify 'not' validation" do
	schema = %Schema{not: %Schema{type: :boolean}}
	assert :ok = Schema.validate(schema, 42, %{})
	assert :ok = Schema.validate(schema, "42", %{})
	assert :ok = Schema.validate(schema, nil, %{})
	assert :ok = Schema.validate(schema, 4.2, %{})
	assert :ok = Schema.validate(schema, [4], %{})
	assert :ok = Schema.validate(schema, %{}, %{})
	assert {:error, _} = Schema.validate(schema, true, %{})
	assert {:error, _} = Schema.validate(schema, false, %{})
	end
	end

	describe "Nullable validation" do
	test "Validate nullable-ified with expected value" do
	schema = %Schema{
	nullable: true,
	type: :string,
	minLength: 1
	}

	assert :ok = Schema.validate(schema, "BLIP", %{})
	end

	test "Validate nullable with expected value" do
	schema = %Schema{type: :string, nullable: true}
	assert :ok = Schema.validate(schema, nil, %{})
	end

	test "Validate nullable with unexpected value" do
	schema = %Schema{type: :string, nullable: true}
	assert :ok = Schema.validate(schema, "bla", %{})
	end
	end

	describe "Default property value" do
	test "Available in structure" do
	size = %Schemas.Size{}
	assert "cm" == size.unit
	assert 100 == size.value
	end

	test "Available after cast" do
	api_spec = ApiSpec.spec()
	schemas = api_spec.components.schemas
	size = Map.fetch!(schemas, "Size")

	assert {:ok, %Schemas.Size{value: 100, unit: "cm"}} ==
	Schema.cast(size, %{}, schemas)

	assert {:ok, %Schemas.Size{value: 110, unit: "cm"}} ==
	Schema.cast(size, %{value: 110}, schemas)
	end
	end
	end

File Metadata

Mime Type: text/x-diff
Expires: Wed, Nov 27, 10:54 PM (1 d, 18 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 40765
Default Alt Text: (66 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions