-
Notifications
You must be signed in to change notification settings - Fork 158
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(rules): update operation-tag-defined
rule
#1876
base: main
Are you sure you want to change the base?
Conversation
🦋 Changeset detectedLatest commit: 4ef0862 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
208a581
to
e8011cc
Compare
"@redocly/cli": patch | ||
--- | ||
|
||
Updated `operation-tag-defined` configurable rule. |
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.
what was was updated about the rule and why?
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.
The rule didn't check for a tags
definition at the operation level. I also added the tests for it.
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.
What was the issue you're trying to solve @jeremyfiel? Was the linter failing? Or just not reporting the problem?
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.
the rule was not reporting if operation tags are not defined, it only reports if operation tags are defined but the global tag is missing.
e8011cc
to
6f4484c
Compare
6f4484c
to
8b1a1ae
Compare
check for `tags` existence in `Operation` node`
8b1a1ae
to
4ef0862
Compare
"@redocly/cli": patch | ||
--- | ||
|
||
Updated `operation-tag-defined` configurable rule. |
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.
Updated `operation-tag-defined` configurable rule. | |
Updated the `operation-tag-defined` built-in rule to check that the globally defined tags are used at the operation level. |
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 was only able to find the built-in rule operation-tag-defined
. I also think it would be helpful to add some information to the rule's documentation with this update - https://redocly.com/docs/cli/rules/oas/operation-tag-defined
adds a check for
tags
existence inOperation
nodeWhat/Why/How?
Reference
Testing
Screenshots (optional)
Check yourself
Security