Merge pull request #162 from mbta/nullable

add nullable as a property
xerions · Feb 13, 2018 · e35c5c0 · e35c5c0
2 parents dc481a0 + 0b2638b
commit e35c5c0
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/lib/phoenix_swagger/schema.ex b/lib/phoenix_swagger/schema.ex
@@ -36,7 +36,9 @@ defmodule PhoenixSwagger.Schema do
     :properties,
     :additionalProperties,
     :discriminator,
-    :example]
+    :example,
+    :'x-nullable'
+  ]
 
   @doc """
   Construct a new %Schema{} struct using the schema DSL.
@@ -177,7 +179,9 @@ defmodule PhoenixSwagger.Schema do
   end
   def property(model = %Schema{type: :object}, name, type = %Schema{}, description, opts) do
     {required?, opts} = Keyword.pop(opts, :required)
+    {nullable?, opts} = Keyword.pop(opts, :nullable)
     property_schema = struct!(type, [description: type.description || description] ++ opts)
+    property_schema = if nullable?, do: %{property_schema | :'x-nullable' => true}, else: property_schema
     properties = (model.properties || %{}) |> Map.put(name, property_schema)
     model = %{model | properties: properties}
     if required?, do: required(model, name), else: model
@@ -215,7 +219,7 @@ defmodule PhoenixSwagger.Schema do
       [do: {:__block__, _, exprs}] -> exprs
       [do: expr] -> [expr]
     end
-    
+
     body =
       exprs
       |> Enum.map(fn {name, line, args} -> {:property, line, [name | args]} end)

diff --git a/test/path_test.exs b/test/path_test.exs
@@ -66,6 +66,7 @@ defmodule PhoenixSwagger.PathTest do
           properties do
             subscribe_to_mailing_list :boolean, "mailing list subscription", default: true
             send_special_offers :boolean, "special offers list subscription", default: true
+            phone_number :string, "specified phone", nullable: true
           end
         end)
       end
@@ -231,7 +232,12 @@ defmodule PhoenixSwagger.PathTest do
                         "default" => true,
                         "description" => "mailing list subscription",
                         "type" => "boolean"
-                      }
+                      },
+                      "phone_number" => %{
+                        "description" => "specified phone",
+                        "type" => "string",
+                        "x-nullable" => true
+                      },
                     },
                     "type" => "object"
                   }