path-ruleset.yaml

functions:
  [
    parameter-example-check,
    parameter-filter-description-check,
    parameter-sorter-description-check,
    word-count,
    deprecation,
    path-parameter-integer-number-formats,
    response-validator,
    path-query-parameter-check,
    path-descriptions-check,
    path-oauth-scope-check,
    path-user-levels-check,
    path-operation-check,
    ascii,
    path-reserved-keywords-check,
    summary-check
    ]
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.*
    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.*
    severity: error
    then:
      field: description
      function: length
      functionOptions:
        min: 8
  path-filter-parameter-must-follow-format:
    message: "{{error}}: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#324"
    given: $.[*].parameters[?(@.in == "query" && @.name == "filters")].description
    severity: error
    then:
      function: parameter-filter-description-check
      functionOptions:
        rule: 324
  path-sorter-parameter-must-follow-format:
    message: "{{error}}: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#325"
    given: $.[*].parameters[?(@.in == "query" && @.name == "sorters")].description
    severity: error
    then:
      function: parameter-sorter-description-check
      functionOptions:
        rule: 325
  path-parameters-must-have-example:
    message: "{{error}}: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304"
    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.*
    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
    severity: warn
    then:
      function: word-count
      functionOptions:
        maxWordCount: 5
        rule: 305
  path-description-html-chars:
    message: "{{error}}"
    given: $.*.description
    severity: error
    then:
      function: path-descriptions-check
      functionOptions:
        rule: 405
  path-must-have-security-defined:
    message: "{{error}}: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#104"
    given: $.*
    severity: error
    then:
      function: path-oauth-scope-check
      functionOptions:
        rule: 104
  path-must-have-user-levels-defined:
    message: "{{error}}: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#321"
    given: $.*
    severity: error
    then:
      function: path-user-levels-check
      functionOptions:
        rule: 321

  # # path-deprecated-apis-should-have-deprecation-and-sunset-dates:
  # #   message: "{{error}}: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#189"
  # #   given: $[*]
  # #   severity: warn
  # #   then:
  # #     function: deprecation
  # #     functionOptions:
  # #       rule: 189

  path-must-have-required-key-on-all-parameters:
    description: "Rule 317: Operations must have required key on all parameters: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#317"
    given: $.*.parameters.*
    severity: error
    then:
      field: required
      function: defined
  path-must-define-specific-response-codes:
    message: "{{error}}: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#151"
    given: $.*.responses
    severity: error
    then:
      function: response-validator
      functionOptions:
        rule: 151
  path-boolean-parameters-must-have-default:
    message: "Rule 310: Optional boolean values must have a default https://sailpoint-oss.github.io/sailpoint-api-guidelines/#310"
    given: $.*.parameters.[?(@.$ref == null && @.required == false && @.schema.type == 'boolean')].schema
    severity: error
    then:
      field: default
      function: defined
  path-operation-check:
    message: "{{error}}: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#400"
    given: $
    severity: error
    then:
      function: path-operation-check
      functionOptions:
        rule: 400
  ascii-characters:
    message: "{{error}}: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#401"
    given: $
    severity: error
    then:
      function: ascii
      functionOptions:
        rule: 401
  path-summary-check:
    message: "{{error}}: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#305"
    given: $
    severity: error
    then:
      function: summary-check
      functionOptions:
        rule: 305
  # path-tag-check:
  #   message: "{{error}}: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#402"
  #   given: $
  #   severity: error
  #   then:
  #     function: tag-check
  #     functionOptions:
  #       rule: 402
  # path-parameters-must-not-use-reserved-keywords:
  #   message: "{{error}}: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#504"
  #   given: $.[*].parameters[?(@.$ref == null)]
  #   severity: error
  #   then:
  #     function: path-reserved-keywords-check
  #     functionOptions:
  #       rule: 504
  # path-parameters-should-have-query-parameter-fields:
  #   given: $.[get]
  #   severity: warn
  #   then:
  #     function: path-query-parameter-check
  #     functionOptions:
  #       field: fields
  #       rule: 157
  # path-parameters-should-have-query-parameter-embed:
  #   given: $.[get]
  #   severity: warn
  #   then:
  #     function: path-query-parameter-check
  #     functionOptions:
  #       field: embed
  #       rule: 158