fix

- relative reference of Path Item Object
- #53

Author: mission-liao

pyswagger/scanner/cycle_detector.py

@@ -11,7 +11,7 @@
 import six
 
 def _out(app, prefix, path):
-    obj = app.resolve(normalize_jr(path, prefix))
+    obj = app.resolve(normalize_jr(path, prefix, app.url))
     r = getattr(obj, 'norm_ref')
     return [r] if r else []
 

pyswagger/scanner/v2_0/resolve.py

@@ -23,7 +23,7 @@ def _resolve(obj, app, prefix, parser):
         return
 
     r = getattr(obj, '$ref')
-    ro = app.resolve(normalize_jr(r, prefix), parser)
+    ro = app.resolve(normalize_jr(r, prefix, app.url), parser)
 
     if not ro:
         raise ReferenceError('Unable to resolve: {0}'.format(r))

pyswagger/tests/data/v2_0/ex/partial/path_item/swagger.json

@@ -1,12 +1,16 @@
 {
    "get":{
       "response":{
-         "description":"path_item, get, response"
+         "default":{
+            "description":"path_item, get, response"
+         }
       }
    },
    "put":{
       "response":{
-         "description":"path_item, put, response"
+         "default":{
+            "description":"path_item, put, response"
+         }
       }
    }
-}
+}

pyswagger/tests/data/v2_0/ex/root/path_item.json

@@ -0,0 +1,16 @@
+{
+   "get":{
+      "responses":{
+         "default":{
+            "description":"relative, path_item, get, response"
+         }
+      }
+   },
+   "put":{
+      "responses":{
+         "default":{
+            "description":"relative, path_item, put, response"
+         }
+      }
+   }
+}

pyswagger/tests/data/v2_0/ex/root/swagger.json

@@ -18,6 +18,9 @@
       },
       "/partial":{
          "$ref":"file:///partial/path_item/swagger.json"
+      },
+      "/relative":{
+         "$ref":"path_item.json"
       }
    },
    "definitions":{
@@ -37,4 +40,4 @@
          }
       }
    }
-}
+}

pyswagger/tests/v2_0/test_ex.py

@@ -90,3 +90,14 @@ def test_partial_schema(self):
         p_ = self.app.resolve('#/definitions/s3')
         self.assertEqual(p_.__repr__(), original_p.items.ref_obj.__repr__())
 
+    def test_relative_path_item(self):
+        """ make sure that relative file schema works
+           https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#relative-schema-file-example
+        """
+        def chk(obj):
+            self.assertEqual(obj.get.responses['default'].description, 'relative, path_item, get, response')
+            self.assertEqual(obj.put.responses['default'].description, 'relative, path_item, put, response')
+
+        chk(self.app.s('relative'))
+        chk(self.app.resolve('file:///root/path_item.json'))
+

pyswagger/utils.py

@@ -320,10 +320,15 @@ def normalize_jr(jr, prefix, url=None):
     if p.scheme != '':
         return jr
 
+    # fix implicit reference,
     # it's a JSON reference without url
-
-    # fix implicit reference
-    jr = jp_compose(jr, base=prefix) if jr.find('#') == -1 else jr
+    if jr.find('#') == -1:
+        if prefix == '#/paths':
+            # relative reference to files next to this one
+            p = six.moves.urllib.parse.urlparse(url)
+            return six.moves.urllib.parse.urlunparse(p[:2]+(os.path.join(os.path.dirname(p.path), jr),)+p[3:])
+        else:
+            jr = jp_compose(jr, base=prefix)
 
     # prepend url
     if url: