Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tatomyr committed May 28, 2024
1 parent 8f87139 commit 8a59a0d
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions docs/rules/security-defined.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit 8a59a0d

Please sign in to comment.