add option for path param (#47)

WaleedAshraf · Mar 21, 2022 · 6c4e01c · 6c4e01c
1 parent 3770e55
commit 6c4e01c
Show file tree

Hide file tree

Showing 10 changed files with 1,662 additions and 2,145 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,10 @@
 Change Log
 ==========
 
+Version 3.2.0 *(2022-03-22)*
+----------------------------
+* Option to provide `path` parameter for relative file ref.
+
 Version 3.1.1 *(2021-09-30)*
 ----------------------------
 * Add TS types

diff --git a/README.md b/README.md
@@ -34,6 +34,7 @@ AsyncApiValidator.fromSource(source, options)
 |-----|----|----|---|
 | ignoreArray | boolean | optional | If `true`, then if schema is defined as an array and payload is an object, then payload will be placed inside an array before validation. |
 | msgIdentifier | string | required | Name of parameter whose value will be used as `"key"` in `.validate()` method. Recommendation is to use `"name"` as described in [message-object](https://asyncapi.io/docs/specifications/2.0.0/#a-name-messageobject-a-message-object). You can also use [Specification Extensions](https://asyncapi.io/docs/specifications/2.0.0/#specificationExtensions)|
+| path | string | optional |  Path to the AsyncAPI document. It will be used to resolve relative references. Defaults to current working dir. As [used in asyncapi-parser](https://github.com/asyncapi/parser-js/blob/master/lib/parser.js#L41) |
 
 ## Instance Methods