Redocly/redocly-cli

enhance no-http-verbs-in-paths with excludedPaths option

adamaltman opened this issue · 4 comments

adamaltman commented

Is your feature request related to a problem? Please describe.

https://redocly.com/docs/cli/rules/no-http-verbs-in-paths/

Invariably, there are going to be false positives. Rather than adding them to the Redocly ignore file (which I tend to use more as an API design debt log) I want to be able to list excluded paths as a rule configuration.

Describe the solution you'd like

rules:
  no-http-verbs-in-paths:
    splitIntoWords: true
    excludedPaths:
      - /foo/profile-options/
Option Type Description
excludedPaths [string] List of paths to exclude from evaluation by this rule.

Describe alternatives you've considered

Doing nothing and using the Redocly ignore file (but it feels noisy to me).

Additional context

n/a

tatomyr commented

Should the name of the option be past tense (excluded) or present tense (exclude)? I see that some options are past tense and some are present (allowedValues vs ignoreCase, allowAdditionalProperties). Does it make sense to use one naming pattern, at least for new options?

lornajane commented

I think present tense makes sense, so excludePaths in this case.

Ayush9026 commented

/assign i will solve this issue.

  • ❤️1
tatomyr commented

@Ayush9026 sure, please go ahead!

  • 👍1