Various utilities for JSON References (http://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03).
I cannot guarantee it's not got any bugs but based on the test suite, everything works as expected. Performance was also a huge improvement.
Time spent (name-omitted): 43544 ms
Time spent (json-refs): 831 ms
That's only ~53 times faster.
Since there are no rewrites, only updating deps and fixing bugs/features, it should be a much quicker cycle.
I hope this is the last time I rewrite the
json-refs resolver. ;)
I do have to say the results are awesome. I'm not saying there won't be bugs or feature requests but it's the fastest, most accurate resolver
json-refs has ever had.
Is anybody here?
Im currently working on Swagger Spec(Its of JSON format)
I was loooking to solve cicular references in it
Will this npm module be of help?
Could someone please suggest the right way to solve circular references in the swagger file and then parse it?
@whitlockjc could you please help me /
*?
@whitlockjc
can I get the ref pointers that contain circular reference?
Yep. Whenever you resolve references, the reference metadata will contain whether or not the reference is circular. Here is the API documentation: https://github.com/whitlockjc/json-refs/blob/master/docs/API.md#jsonrefsresolvedrefdetails--unresolvedrefdetails
Thank you for taking the time.
While working on OpenAPI tooling and even some direct consumers, it has been requested the ability to merge values resolved via
$ref. Simple merging would mean allowing neighboring properties beside the $ref and merging the properties of the JSON Reference object and the resolved object. That use case seems simple, of course some ruling for conflicts where both have the same property.
But I could see more complex use cases where the JSON Reference object had some excludes/includes capability and/or other things giving the author more control over the resulting object.
Instead of doing this in a vacuum, I figured I'd reach out.
So, something like JSON Patch, but with somewhat different rules, such as how to handle conflicts, for example.
I don't know that trying to "reference" merging two (or more?) documents makes sense without some structure outside of JSON Reference itself.
I like the idea of a JSON Merge document, whose purpose is to express the requirements around merging two documents.
It could then presumably reference the documents to be merged.
Another thought would be to say, reference such a merge document, with arguments containing documents (or references to documents) to be merged.
Or, even more general purpose, like document composition, where merge is but one feature.
$compose