Receiving warning: oasOpParams expects a resolved object about spectral HOT 10 CLOSED

Hi @cbetta - great question, and this is something that we could certainly be more clear about (will open a separate PR for readme).

Certain rules (like those param rules you mentioned above) need both the resolved and unresolved document in order to function. Since you don't have any $refs in your document, you should be able to supply it as the resolved version like so:

const results = spectral.run(specification, { resolvedTarget: specification });

You can find the run signature here: https://github.com/stoplightio/spectral/blob/next/src/spectral.ts#L21.

I'm now wondering if we shouldn't just default resolvedTarget to the passed in document if resolvedTarget is not explicitly set.

Let me know if the above works for you for now!

from spectral.

Ah yes that works. The documentation wasn't quite up to date on this indeed.

from spectral.

I'm adding a FAQ (or maybe putting it in the code sample) for this right now.

from spectral.

Did I miss something? I don't see anything added.

from spectral.

PR #89 isn't merged yet, but that should help some. We might be adding one more thing to it.

from spectral.

Ah excellent, just confused cause you said "right now". I hadn't spotted the PR.

from spectral.

Hey folks, just to give you an update: the release/2.0 is getting more mature, so if you would like to check it out your troubles should be over. run now returns a promise, so make sure you add await. It is no longer an object with .results, it just an array.

Before

const spectral = new Spectral();
results = spectral.run(obj);
console.log(results.results);

v2.0

const spectral = new Spectral();
results = await spectral.run(obj);
console.log(results);

Please post new issues with any new bugs you find in there, but this is considered done (and will be closed when v2.0 is merged).

from spectral.

🎉 This issue has been resolved in version 2.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

from spectral.

Upgraded and all works 👍

from spectral.

@cbetta Glad to hear the improvements worked.

from spectral.