feat: validate x-sdk-operations extension

[barrett-schonefeld]

Description:

• This PR uses a provided Spectral function to do JSON Schema validation. This is a positive because it is a well-defined way to invoke the AJV validator.
• The one drawback is that we need to dynamically convert the relative path to an absolute path before loading the default config into STATIC_ASSETS because we need to ensure Spectral can always find the schema regardless of the current working directory.
• The Spectral schema function has the same problem we observed (in Spectral 5.8.1 and below) in the oas3-schema rule where only one error is returned at a time. We will want to follow up on this implementation by raising this issue to Spectral and fixing the schema function.

Purpose:

• Validate that the x-sdk-operations extension is used correctly.

Changes:

• Load the absolute path to the JSON Schema into static assets, so when the ibm:oas ruleset is extended, still able to find the JSON Schema
• Replace relative references to ./schema in .defaultsforspectral.yaml with their absolute path using regex replace

Tests:

• Ensure ibm-sdk-operations rule catches errors

Docs:

• Document the ibm-sdk-operations rule

[codecov]

Codecov Report

Merging #290 (2f73cd2) into main (ba00a8d) will increase coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head 2f73cd2 differs from pull request most recent head 11ddb36. Consider uploading reports for the commit 11ddb36 to get more accurate results

@@           Coverage Diff           @@
##             main     #290   +/-   ##
=======================================
  Coverage   92.00%   92.00%           
=======================================
  Files          73       73           
  Lines        2376     2377    +1     
  Branches      605      605           
=======================================
+ Hits         2186     2187    +1     
  Misses        157      157           
  Partials       33       33           

Impacted Files	Coverage Δ
src/spectral/utils/spectral-validator.js	98.21% <100.00%> (+0.03%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 83c8993...11ddb36. Read the comment docs.

[mkistler]

I think the doc changes are a bit messed up.

And I had an idea about using regex replace to update the paths.

[mkistler]

Looks good! 👍

[dpopp07]

Looks good to me

[ibm-devx-sdk]

🎉 This PR is included in version 0.46.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀