owaspCheckSecurity
owaspCheckSecurity will check global or operation level security has been defined.
How do I use this function?
This function is configured by the following functionOptions
.
NAME | TYPE | REQUIRED? | DESCRIPTION |
---|---|---|---|
schemesPath | []string |
yes | The key to look for (defaults to securitySchemes) |
nullable | boolean |
yes | Can be empty or not |
methods | []string |
yes | Which http methods to look through |
Example ruleset configuration
my-security-rule:
description: API should be protected by a `security` rule either at global or operation level.
type: validation
given: $
then:
function: owaspCheckSecurity
functionOptions:
schemesPath:
- securitySchemes
nullable: true
methods:
- post
- put
- delete
- patch
Used by the following rules: