Allow resolving only relative and absolute refs and leave local refs unresolved

[mohsen1]

Per requests here and here users want to resolve a multi-file JSON file into one file without resolving local (fragment URIs) refs. If we can specify which of these types of refs to resolve it would be perfect:

• Fragment URIs
• Relative URIs
• Absolute URIs

[arnaud-deprez]

+1 :-)

[whitlockjc]

I've been thinking of doing this for a while. My plan is to add two new options:

• remoteRefsOnly
• localRefsOnly

Then you can resolve all locals only, all remotes only or all of them.

[mohsen1]

We also need to allow only resolving relative remotte refs and leave absolute ones. This could be the case for a multi-file JSON Schema that uses absolute refs for default/base JSON Schemas from http://json-schema.org/

[whitlockjc]

Works for me. I'm sure this seem simple...I look forward to how painful the implementation becomes. ;)

[NadavK]

+1
(its a sign of an experienced programmer who realizes in advance that nothing is as simple as it looks)

[whitlockjc]

I thought about this some today working on #30. I've not forgotten.

[tobad357]

+1 this would be great as currently using allOf in swagger definitions and then processing through json-ref prduces an error.

If you don't have time I could have a look at it

[whitlockjc]

If there is an error with allOf, we should fix that so feel free to file a bug. Other than that, I do have plans on implementing this but I've been working on other things the past few weeks at work. Feel free to submit a PR and I'm always available to guide/help.

[arnaud-deprez]

Hi,
Could someone tell me what is the status of this ?
Rgds,

[whitlockjc]

I've not started yet but I can bump it up in priority.

[arnaud-deprez]

Ok no problem ! If you can it's nice otherwise I'm already doing a workaround (but I must use some copy/paste right now :-( to avoid using allOf)

[marcelaraujo]

+1

[sobit]

+1

@whitlockjc any updates on that issue? need it very much

[marcobrinkmann]

+1

[whitlockjc]

Sorry for the delay. I'll work on it over the weekend. If you've not heard from me, feel free to reply here to throw it in my inbox.

[xhochn]

+1

[sobit]

@whitlockjc just as you suggested, reminding you about the issue. :) thanks a ton for the great work btw!

[whitlockjc]

I'm working on it as we speak.

[pleerock]

+1 would be nice to have this feature

[htimur]

+1 for this feature

[arabold]

We're running into the same problem here. We want to resolve only relative local file paths to consolidate our different files into a single one, but keep all absolute URLs (https://...) and #/definitions/.. (Swagger) intact.

[sobit]

@whitlockjc is there any progress done on this front? if you're under time pressure, maybe you could point in the right direction so someone else can pick it up instead?

[arabold]

Here's a pull request a colleague of mine just released: #41

[whitlockjc]

I'll take a peek. I apologize for the delay, I've been traveling.

[mohsen1]

👍

[aktwang]

Hi...Can you show me how to use the new option(s)? I'm using the code from: http://azimi.me/2015/07/16/split-swagger-into-smaller-files.html, and I don't like the fact it expanded the $ref inline for me for the definitions..Thanks!

var resolve = require('json-refs').resolveRefs;
var YAML = require('js-yaml');
var fs = require('fs');

var root = YAML.load(fs.readFileSync('index.yaml').toString());
var options = {
processContent: function (content) {
return YAML.load(content);
}
};
resolve(root, options).then(function (results) {
console.log(YAML.dump(results.resolved));
});

[whitlockjc]

The API documentation is located here: https://github.com/whitlockjc/json-refs/blob/master/docs/API.md#resolveRefs Depending on which reference type(s) you want to resolve, update the options you created appropriately.