Request: Adding new configurable rule: operation-operationId-exclude-OPTIONS
#52
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
nickcorby
changed the title
operation-operationId-exclude-OPTIONSoperation-operationId-exclude-OPTIONS
|
@nickcorby Thanks for the feedback and contribution! We will review it and merge as soon as possible, |
tatomyr
reviewed
Oct 27, 2025
|
|
||
| ## Code | ||
|
|
||
| > If you are using a ruleset that includes the `operation-operationId` rule (like `recommended`), you will need to disable this rule in order for the configurable rule to apply. |
There was a problem hiding this comment.
Technically, the configurable rule will be applied anyway, but it just doesn't make any sense to use both built-in and the configurable rule 🙂.
| > operation-operationId: off | ||
| > ``` | ||
|
|
||
| This rule is added to your `redocly.yaml` file: |
There was a problem hiding this comment.
Suggested change
| This rule is added to your `redocly.yaml` file: | |
| This rule is added to the `rules` section of your `redocly.yaml` file: |
| With the rule configured with `severity: error`, the following snippet of a `GET` operation will trigger this rule & display an error: | ||
|
|
||
| ```yaml | ||
| get: |
There was a problem hiding this comment.
Could you make your examples smaller just to contain the needed data to showcase the rule, and start from the root?
openapi: 3.2.0
paths:
/example:
get: ...| However, the following snippet of an `OPTIONS` operation **won't** trigger the rule: | ||
|
|
||
| ```yaml | ||
| options: |
There was a problem hiding this comment.
Perhaps you can combine the examples into one endpoint, but with different methods, and leave hints what's correct and what's wrong in summaries or descriptions.
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.
As suggested by AlbinaBlazhko17, I've added a configurable rule to the cookbook to allow you to emulate the
operation-operationIdrule with the added capability of filtering by operation type (in this case,OPTIONS).Please let me know if anything needs to be tweaked, and thank you again for being so responsive & offering assistance! We're starting a new IaC project at work and Redocly CLI has been instrumental in defining our APIs. This is just one feature that has provided huge benefit for us.