Merge pull request #10 from civisanalytics/check_param_in_has_not_changed

Detect if a parameter's location (*i.e.*, `in` value) changes

Author: jeffreyc

CHANGELOG.md

@@ -11,6 +11,8 @@
 
 * [#8](https://github.com/civisanalytics/swagger-diff/pull/8)
   fixed parsing of header and formData parameters
+* [#10](https://github.com/civisanalytics/swagger-diff/pull/10)
+  detect if a parameter's location (*i.e.*, `in` value) changes
 
 ## 1.0.2 (2015-10-08)
 

lib/swagger/diff/specification.rb

@@ -111,7 +111,7 @@ def nested(ref, prefix, name, list = false)
         if prefix == "#{name}/" || prefix =~ %r{/#{name}(\[\])?/}
           # Anonymizing the reference in case the name changed (e.g.,
           # generated Swagger).
-          { all: ["#{key} (type: reference)"] }
+          { all: ["#{key} (in: body, type: reference)"] }
         else
           refs(ref, "#{key}/")
         end
@@ -124,7 +124,7 @@ def properties_for_ref(prefix, name, schema, required, list = false)
           merge_refs!(ret, nested(schema['$ref'], prefix, name, list))
         else
           ret[:required].add(key) if required && required.include?(name)
-          ret[:all].add("#{key} (type: #{schema.type}#{'[]' if list})")
+          ret[:all].add("#{key} (in: body, type: #{schema.type}#{'[]' if list})")
         end
         ret
       end
@@ -148,7 +148,7 @@ def properties(properties, required, prefix = '')
                      else
                        '*'
                      end
-              ret[:all].add("#{prefix}#{name} (type: Hash[string, #{type}])")
+              ret[:all].add("#{prefix}#{name} (in: body, type: Hash[string, #{type}])")
             end
           else
             merge_refs!(ret, properties_for_ref(prefix, name, schema, required))
@@ -165,7 +165,7 @@ def request_params_inner(params)
             merge_refs!(ret, refs(param.schema['$ref']))
           else
             ret[:required].add(param.name) if param.required
-            ret[:all].add("#{param.name} (type: #{param.type})")
+            ret[:all].add("#{param.name} (in: #{param.in}, type: #{param.type})")
           end
         end
         ret

spec/swagger/diff/diff_spec.rb

@@ -23,21 +23,21 @@
     expect(incompat_diff.incompatibilities)
       .to eq(endpoints: ['post /b/', 'put /a/{}'],
              request_params: {
-               'get /a/' => ['missing request param: limit (type: integer)'],
+               'get /a/' => ['missing request param: limit (in: query, type: integer)'],
                'post /a/' => ['new required request param: extra'],
-               'patch /a/{}' => ['missing request param: name (type: ["string", "null"])',
-                                 'missing request param: obj/thing (type: integer)',
-                                 'missing request param: str (type: string)'
+               'patch /a/{}' => ['missing request param: name (in: body, type: ["string", "null"])',
+                                 'missing request param: obj/thing (in: body, type: integer)',
+                                 'missing request param: str (in: body, type: string)'
                                 ],
                'put /b/{}' => ['new required request param: extra'],
                'post /c/' => ['new required request param: existing/b'] },
              response_attributes: {
-               'post /a/' => ['missing attribute from 200 response: description (type: string)'],
-               'get /a/{}' => ['missing attribute from 200 response: description (type: string)'],
-               'patch /a/{}' => ['missing attribute from 200 response: obj/thing (type: integer)',
-                                 'missing attribute from 200 response: objs[]/thing (type: integer)'],
-               'put /b/{}' => ['missing attribute from 200 response: description (type: string)'],
-               'get /c/' => ['missing attribute from 200 response: []/name (type: string)',
+               'post /a/' => ['missing attribute from 200 response: description (in: body, type: string)'],
+               'get /a/{}' => ['missing attribute from 200 response: description (in: body, type: string)'],
+               'patch /a/{}' => ['missing attribute from 200 response: obj/thing (in: body, type: integer)',
+                                 'missing attribute from 200 response: objs[]/thing (in: body, type: integer)'],
+               'put /b/{}' => ['missing attribute from 200 response: description (in: body, type: string)'],
+               'get /c/' => ['missing attribute from 200 response: []/name (in: body, type: string)',
                              'missing 201 response'] })
   end
 
@@ -48,11 +48,11 @@
   - put /a/{}
 - incompatible request params
   - get /a/
-    - missing request param: limit (type: integer)
+    - missing request param: limit (in: query, type: integer)
   - patch /a/{}
-    - missing request param: name (type: ["string", "null"])
-    - missing request param: obj/thing (type: integer)
-    - missing request param: str (type: string)
+    - missing request param: name (in: body, type: ["string", "null"])
+    - missing request param: obj/thing (in: body, type: integer)
+    - missing request param: str (in: body, type: string)
   - post /a/
     - new required request param: extra
   - post /c/
@@ -61,17 +61,17 @@
     - new required request param: extra
 - incompatible response attributes
   - get /a/{}
-    - missing attribute from 200 response: description (type: string)
+    - missing attribute from 200 response: description (in: body, type: string)
   - get /c/
-    - missing attribute from 200 response: []/name (type: string)
+    - missing attribute from 200 response: []/name (in: body, type: string)
     - missing 201 response
   - patch /a/{}
-    - missing attribute from 200 response: obj/thing (type: integer)
-    - missing attribute from 200 response: objs[]/thing (type: integer)
+    - missing attribute from 200 response: obj/thing (in: body, type: integer)
+    - missing attribute from 200 response: objs[]/thing (in: body, type: integer)
   - post /a/
-    - missing attribute from 200 response: description (type: string)
+    - missing attribute from 200 response: description (in: body, type: string)
   - put /b/{}
-    - missing attribute from 200 response: description (type: string)
+    - missing attribute from 200 response: description (in: body, type: string)
 '
     end
 

spec/swagger/diff/rspec_matchers_spec.rb

@@ -20,11 +20,11 @@
   - put /a/{}
 - incompatible request params
   - get /a/
-    - missing request param: limit (type: integer)
+    - missing request param: limit (in: query, type: integer)
   - patch /a/{}
-    - missing request param: name (type: ["string", "null"])
-    - missing request param: obj/thing (type: integer)
-    - missing request param: str (type: string)
+    - missing request param: name (in: body, type: ["string", "null"])
+    - missing request param: obj/thing (in: body, type: integer)
+    - missing request param: str (in: body, type: string)
   - post /a/
     - new required request param: extra
   - post /c/
@@ -33,17 +33,17 @@
     - new required request param: extra
 - incompatible response attributes
   - get /a/{}
-    - missing attribute from 200 response: description (type: string)
+    - missing attribute from 200 response: description (in: body, type: string)
   - get /c/
-    - missing attribute from 200 response: []/name (type: string)
+    - missing attribute from 200 response: []/name (in: body, type: string)
     - missing 201 response
   - patch /a/{}
-    - missing attribute from 200 response: obj/thing (type: integer)
-    - missing attribute from 200 response: objs[]/thing (type: integer)
+    - missing attribute from 200 response: obj/thing (in: body, type: integer)
+    - missing attribute from 200 response: objs[]/thing (in: body, type: integer)
   - post /a/
-    - missing attribute from 200 response: description (type: string)
+    - missing attribute from 200 response: description (in: body, type: string)
   - put /b/{}
-    - missing attribute from 200 response: description (type: string)
+    - missing attribute from 200 response: description (in: body, type: string)
       EOM
       expect do
         expect('spec/fixtures/dummy.v2.json')