CLOUDP-301224: Generate README with IPA rules #451
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wtrocki
reviewed
Feb 24, 2025
|
|
||
| | Rule Name | Description | Severity | | ||
| | ---------------------------------------------- | ------------------------------------------------------------------------- | -------- | | ||
| | xgen-IPA-109-custom-method-must-be-GET-or-POST | The HTTP method for custom methods must be GET or POST. http://go/ipa/109 | warn | |
There was a problem hiding this comment.
[nit] Golink to internal site. Might be better to have actions self explanatory. Then downstream can link upstream instead.
There was a problem hiding this comment.
IMO I think it's nice to have a link to the IPA itself for each rule, as it will show up when a validation fails. We do use golinks pretty widely in the openapi repo
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Adds a script to generate a README file in
tools/spectral/ipa/rulesets. The file shows tables of all available rules (based on theipa-spectral.yamlruleset), and can be automatically updated when a new rule is added to the IPA validation by running:Also, a test is added to fail if the file is not updated, it looks like this when failed:
Jira ticket: CLOUDP-301224