-
-
Notifications
You must be signed in to change notification settings - Fork 241
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add API descriptor with API_SPECTRAL with AsyncAPI/OpenAPI support #3474
Conversation
ce90a49
to
24dc4bf
Compare
@@ -206,6 +206,7 @@ WORKDIR /node-deps | |||
RUN npm --no-cache install --ignore-scripts --omit=dev \ | |||
@salesforce/cli \ | |||
typescript \ | |||
@stoplight/spectral-cli \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nvuillam idea for improvement here: sort the required packages, to not have the order changed uselessly like here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
100% agreed, can be done in another PR :)
I think there's a bit of CI issues, in part with the new eslint release, so it might not get merged today, but I think it's good overall here ;) |
24dc4bf
to
66abc09
Compare
I guess I cannot make lychee happy
as these files don't exist at the main branch, yet. |
However three tests for api spectral report failure : https://github.com/oxsecurity/megalinter/actions/runs/8694444485/job/23843361154#step:11:1 |
@pjungermann test classes are failing ^^ |
fea251b
to
b6603a4
Compare
b6603a4
to
19e95ed
Compare
Add API descriptor as modified copy of the OPENAPI descriptor. Deprecate the contained linter OPENAPI_SPECTRAL. Add `.spectral.yaml` as default config file to `TEMPLATE/` as modified copy of `.openapirc.yml` with rulesets for AsyncAPI and OpenAPI (previously, only OpenAPI). Closes: oxsecurity#3387
19e95ed
to
4f4d60e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I won't merge now, since two issues on GitHub status makes the workflows on my other repo all fail since a couple hours. Now tests don't fail. The only error is the docs not yet published for the contents of this PR
In fact it will take @nvuillam to force the merge later on since it is required but fails. |
Thank you! |
Add
API
descriptor as modified copy of theOPENAPI
descriptor. Deprecate the contained linterOPENAPI_SPECTRAL
.Add
.spectral.yaml
as default config file toTEMPLATE/
as modified copy of.openapirc.yml
with rulesets for AsyncAPI and OpenAPI (previously, only OpenAPI).Fixes #3387
Proposed Changes
API_SPECTRAL
as modified copy ofOPENAPI_SPECTRAL
..spectral.yaml
as config filename and provides a default file atTEMPLATE/
with rulesets for AsyncAPI and OpenAPI.OPENAPI_SPECTRAL
(and therefore,OPENAPI
)Readiness Checklist
Author/Contributor
Reviewing Maintainer
breaking
if this is a large fundamental changeautomation
,bug
,documentation
,enhancement
,infrastructure
, orperformance