-
Notifications
You must be signed in to change notification settings - Fork 14
feat(ipa): enable OperationID Validation with warning severity #871
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
Conversation
"license": "Apache-2.0", | ||
"author": "MongoDB", | ||
"main": "ipa-spectral.yaml", | ||
"type": "module", |
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.
Why this change?
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 got this error when regenerating the ReadMe
(node:58114) [MODULE_TYPELESS_PACKAGE_JSON] Warning: Module type of file:///Users/sophia.terry/openapi/tools/spectral/ipa/scripts/generateRulesetReadme.js is not specified and it doesn't parse as CommonJS.
Reparsing as ES module because module syntax was detected. This incurs a performance overhead.
To eliminate this warning, add "type": "module" to /Users/sophia.terry/openapi/tools/spectral/ipa/package.json.
(Use `node --trace-warnings ...` to show where the warning was created)
No impact on the package configuration that I know of
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.
Yes. We use ES format instead of commonjs.
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.
Feel free to create separate/small PRs for the changes like those in future.
Great to see this landing 🥇 |
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.
Could you add some test cases for:
- Valid/invalid op ID overrides for the different methods
- Usage of the verb override in standard and legacy custom methods
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.
Added, TY - anything missing ?
Co-authored-by: Lovisa Berggren <[email protected]>
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.
LGTM!
Proposed changes
The next PR on this ticket will be in MMS, updating the OpenAPI sha to this commit. A message will be sent to MMS developers beforehand. These rules are still on warning severity and will not impact anything until they are set to error.
Jira ticket: CLOUDP-329722