Merge pull request #388 from AdWerx/bugfix/apidoc-optional-parameters

oestrich · web-flow · commit 88f28379b3fd · 2018-08-14T09:40:43.000-04:00
API Blueprint view object respects required: false for parameters now
diff --git a/features/api_blueprint_documentation.feature b/features/api_blueprint_documentation.feature
@@ -354,12 +354,12 @@ Feature: Generate API Blueprint documentation from test examples
 
     + Parameters
       + id: 1 (required, string) - Order id
-      + optional
+      + optional (optional)
 
     + Attributes (object)
       + name: a name (required) - The order name
-      + amount
-      + description: a description (string) - The order description
+      + amount (optional)
+      + description: a description (optional, string) - The order description
 
     ### Deletes a specific order [DELETE]
 
diff --git a/lib/rspec_api_documentation/views/api_blueprint_index.rb b/lib/rspec_api_documentation/views/api_blueprint_index.rb
@@ -74,7 +74,11 @@ def fields(property_name, examples)
           .uniq { |property| property[:name] }
           .map do |property|
             properties = []
-            properties << "required"      if property[:required]
+            if property[:required] == true
+              properties << 'required'
+            else
+              properties << 'optional'
+            end
             properties << property[:type] if property[:type]
             if properties.count > 0
               property[:properties_description] = properties.join(", ")
diff --git a/spec/views/api_blueprint_index_spec.rb b/spec/views/api_blueprint_index_spec.rb
@@ -143,7 +143,7 @@
         }, {
           name: "option",
           description: nil,
-          properties_description: nil
+          properties_description: 'optional'
         }]
         expect(post_route_with_optionals[:has_attributes?]).to eq false
         expect(post_route_with_optionals[:attributes]).to eq []
@@ -159,7 +159,7 @@
           required: false,
           name: "description",
           description: nil,
-          properties_description: nil
+          properties_description: "optional"
         }]
       end
     end
