LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-06 04:21:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: add ability to exclude some operations from security-defined rule (#1570)

Browse Source
This commit is contained in:
Andrew Tatomyr
2024-05-29 09:13:24 +03:00
committed by GitHub
parent a53bb35f00
commit f6cce633d0
4 changed files with 151 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/rules/security-defined.md
View File

@@ -34,9 +34,17 @@ security: []
## Configuration
| Option | Type | Description |
| -------- | ------ | ------------------------------------------------------------------------------------------ |
| severity | string | Possible values: `off`, `warn`, `error`. Default `error` (in `recommended` configuration). |
| Option | Type | Description |
| ---------- | --------------------------------------- | ------------------------------------------------------------------------------------------ |
| severity | string | Possible values: `off`, `warn`, `error`. Default `error` (in `recommended` configuration). |
| exceptions | [[Exception object](#exception-object)] | List of exceptions from the rule. |
### Exception object
| Option | Type | Description |
| ------- | -------- | ------------------------------------------------------------------------------------------- |
| path | string | **REQUIRED.** Excluded path. |
| methods | [string] | Optional list of operations to exclude. If not provided, the entire path is being excluded. |
An example configuration: