Skip to content
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

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

Open
adamaltman opened this issue Mar 24, 2024 · 4 comments
Open

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

adamaltman opened this issue Mar 24, 2024 · 4 comments
Labels
good first issue Good for newcomers governance Issues relating to problems with or requests for API governance/linting/decorating p3 Type: Enhancement

Comments

@adamaltman
Copy link
Member

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

@lornajane lornajane added the governance Issues relating to problems with or requests for API governance/linting/decorating label Mar 25, 2024
@tatomyr
Copy link
Contributor

tatomyr commented Apr 1, 2024

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?

@tatomyr tatomyr added the p3 label Apr 1, 2024
@lornajane
Copy link
Collaborator

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

@tatomyr tatomyr added the good first issue Good for newcomers label Apr 3, 2024
@Ayush9026
Copy link

/assign i will solve this issue.

@tatomyr
Copy link
Contributor

tatomyr commented Apr 3, 2024

@Ayush9026 sure, please go ahead!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers governance Issues relating to problems with or requests for API governance/linting/decorating p3 Type: Enhancement
Projects
None yet
Development

No branches or pull requests

4 participants