Details of a rule.

Hierarchy

  • RuleAttributes

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any
category?: string

The scorecard name to which this rule must belong.

createdAt?: Date

Creation time of the rule outcome.

custom?: boolean

Defines if the rule is a custom rule.

description?: string

Explanation of the rule.

enabled?: boolean

If enabled, the rule is calculated as part of the score.

modifiedAt?: Date

Time of the last rule outcome modification.

name?: string

Name of the rule.

owner?: string

Owner of the rule.

scorecardName?: string

The scorecard name to which this rule must belong.

Generated using TypeDoc