Improve accuracy of data types for numbers (#30)

Now when we know we will return a float, we declare `"format": "float"` which is an optional hint.

https://swagger.io/docs/specification/data-models/data-types/#numbers

closes: #5

Author: paulsturgess

lib/apia/open_api/helpers.rb

@@ -38,6 +38,14 @@ def convert_type_to_open_api_data_type(type)
         end
       end
 
+      def generate_scalar_schema(type)
+        schema = {
+          type: convert_type_to_open_api_data_type(type)
+        }
+        schema[:format] = "float" if type.klass == Apia::Scalars::Decimal
+        schema
+      end
+
       def generate_schema_ref(definition, id: nil, **schema_opts)
         id ||= generate_id_from_definition(definition.type.klass.definition)
         success = add_to_components_schemas(definition, id, **schema_opts)

lib/apia/open_api/objects/parameters.rb

@@ -39,7 +39,7 @@ def add_to_spec
             if @argument.type.enum? || @argument.type.object?
               items = generate_schema_ref(@argument)
             else
-              items = { type: convert_type_to_open_api_data_type(@argument.type) }
+              items = generate_scalar_schema(@argument.type)
             end
 
             param = {
@@ -64,9 +64,7 @@ def add_to_spec
             param = {
               name: @argument.name.to_s,
               in: "query",
-              schema: {
-                type: convert_type_to_open_api_data_type(@argument.type)
-              }
+              schema: generate_scalar_schema(@argument.type)
             }
             param[:required] = true if @argument.required?
             add_to_parameters(param)
@@ -84,9 +82,7 @@ def generate_argument_set_params
             param = {
               name: "#{@argument.name}[#{child_arg.name}]",
               in: "query",
-              schema: {
-                type: convert_type_to_open_api_data_type(child_arg.type)
-              }
+              schema: generate_scalar_schema(child_arg.type)
             }
             description = []
             description << formatted_description(child_arg.description) if child_arg.description.present?

lib/apia/open_api/objects/request_body.rb

@@ -38,7 +38,7 @@ def add_to_spec
               if arg.type.argument_set? || arg.type.enum?
                 items = generate_schema_ref(arg)
               else
-                items = { type: convert_type_to_open_api_data_type(arg.type) }
+                items = generate_scalar_schema(arg.type)
               end
 
               @properties[arg.name.to_s] = {
@@ -47,10 +47,8 @@ def add_to_spec
               }
             elsif arg.type.argument_set? || arg.type.enum?
               @properties[arg.name.to_s] = generate_schema_ref(arg)
-            else # scalar
-              @properties[arg.name.to_s] = {
-                type: convert_type_to_open_api_data_type(arg.type)
-              }
+            else
+              @properties[arg.name.to_s] = generate_scalar_schema(arg.type)
             end
           end
 

lib/apia/open_api/objects/response.rb

@@ -81,10 +81,8 @@ def generate_properties_for_field(field_name, field)
             build_properties_for_array(field_name, field, properties)
           elsif field.type.object? || field.type.enum?
             build_properties_for_object_or_enum(field_name, field, properties)
-          else # scalar
-            properties[field_name] = {
-              type: convert_type_to_open_api_data_type(field.type)
-            }
+          else
+            properties[field_name] = generate_scalar_schema(field.type)
           end
           properties[field_name][:nullable] = true if field.null?
           properties

lib/apia/open_api/objects/schema.rb

@@ -127,9 +127,7 @@ def generate_schema_for_child(schema, child, all_properties_included)
           else # scalar
             schema[:type] = "object"
             schema[:properties] ||= {}
-            schema[:properties][child.name.to_s] = {
-              type: convert_type_to_open_api_data_type(child.type)
-            }
+            schema[:properties][child.name.to_s] = generate_scalar_schema(child.type)
           end
 
           if child.try(:required?)

spec/support/fixtures/openapi.json

@@ -781,7 +781,8 @@
             }
           },
           "as_decimal": {
-            "type": "number"
+            "type": "number",
+            "format": "float"
           },
           "as_base64": {
             "type": "string"