Added 'path' reference context.

ollionorg · Apr 3, 2017 · e708f55 · e708f55
1 parent 0bb25c0
commit e708f55
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/app/lib/reference-contexts.js b/app/lib/reference-contexts.js
@@ -34,8 +34,19 @@ function definition(ref) {
   return responseSchemaDefinition(ref) || propertyArrayDefinition(ref);
 }
 
+/**
+ * Recognize URL paths.
+ * @param {String} ref the JSON reference.
+ * @return {Boolean} `true` if the current path is an OpenAPI `path`.
+*/
+function path(ref) {
+  var parts = ref.split("/");
+  return parts.length === 2 && parts.lastIndexOf("paths") === parts.length - 2 && parts[1].length > 0;
+}
+
 module.exports = {
   responseSchemaDefinition: responseSchemaDefinition,
   propertyArrayDefinition: propertyArrayDefinition,
   definition: definition,
+  path: path,
 };
diff --git a/test/test-reference-contexts.js b/test/test-reference-contexts.js
@@ -76,4 +76,20 @@ describe("reference-contexts.js", function() {
 
   });
 
+  describe("path()", function() {
+
+    success("path", [
+      "paths/index.html",
+      "paths/{part}",
+      "paths/{a}-{b}-{c}",
+    ]);
+
+    failure("path", [
+      "paths/",
+      "paths",
+      "paths/index.html/responses/",
+    ]);
+
+  });
+
 });