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.

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

Jump to bottom

Fixed JSONpath in the path rulesets #14

Merged
merged 1 commit into from
Oct 26, 2023
Merged

Fixed JSONpath in the path rulesets #14

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
12 changes: 6 additions & 6 deletions nerm-path-ruleset.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ functions:
rules:
path-parameters-must-have-description:
description: "Rule 303: Path/Query parameters must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303"
given: $.[*].parameters[?(@.$ref == null)]
given: $.*.parameters.*
severity: error
then:
field: description
function: truthy
path-parameters-must-have-a-lengthy-description:
description: "Rule 303: The description of parameters must be at least 8 characters: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303"
type: style
given: $.[*].parameters[?(@.$ref == null)]
given: $.*.parameters.*
severity: error
then:
field: description
Expand All @@ -30,23 +30,23 @@ rules:
min: 8
path-parameters-must-have-example:
message: "{{error}}: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304"
given: $.[*].parameters[?(@.$ref == null)]
given: $.*.parameters.*
severity: error
then:
function: parameter-example-check
functionOptions:
rule: 304
path-parameters-must-have-valid-formats-for-numbers-and-integers:
message: "{{error}}: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#171"
given: $.[*].parameters[?(@.$ref == null)]
given: $.*.parameters.*
severity: error
then:
function: path-parameter-integer-number-formats
functionOptions:
rule: 171
path-summary-length:
message: "{{error}}: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#305"
given: $[*].summary
given: $.*.summary
severity: warn
then:
function: word-count
Expand All @@ -55,7 +55,7 @@ rules:
rule: 305
path-description-html-chars:
message: "{{error}}"
given: $[*].description
given: $.*.description
severity: error
then:
function: path-descriptions-check
Expand Down
Loading
Loading