Skip to content

docs: update the no-http-verbs-in-paths rule docs #2725

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.

Sign up for GitHub

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

Merged
tatomyr merged 1 commit into from
Apr 8, 2026
+4 −3
Merged

docs: update the no-http-verbs-in-paths rule docs #2725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .changeset/warm-paths-glow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
"@redocly/cli": minor
"@redocly/openapi-core": minor
---

Expand Down
6 changes: 3 additions & 3 deletions docs/@v2/rules/oas/no-http-verbs-in-paths.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ With the `splitIntoWords` option enabled, "posters" is identified as a resource
| -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------- |
| severity | string | Possible values: `off`, `warn`, `error`. Default `off` (in `recommended` configuration). |
| splitIntoWords | boolean | Matches http verbs when the string is split into words based on casing. This can reduce false positives. Default **false**. |
| excludedPaths | [string] | List of paths to exclude from the check. Use exact path strings (e.g. `/token`). Default **[]**. |
| excludedPaths | [string] | List of paths to exclude from the check. Use exact path strings (e.g. `/get-signed-url` ). Default **[]**. |

An example configuration:

Expand All @@ -74,8 +74,8 @@ rules:
no-http-verbs-in-paths:
severity: error
excludedPaths:
- /token
- /oauth/callback
- /get-signed-url
- /oauth/postback
```

## Examples
Expand Down
Loading