Class RuleAttributes

Details of a rule.

Hierarchy

  • RuleAttributes

Constructors

constructor

Properties

additionalProperties? category? createdAt? custom? description? enabled? level? modifiedAt? name? owner? scorecardName?

Constructors

constructor

Properties

Optional additionalProperties

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

Optional category

category?: string

The scorecard name to which this rule must belong.

Optional createdAt

createdAt?: Date

Creation time of the rule outcome.

Optional custom

custom?: boolean

Defines if the rule is a custom rule.

Optional description

description?: string

Explanation of the rule.

Optional enabled

enabled?: boolean

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

Optional level

level?: number

The maturity level of the rule (1, 2, or 3).

Optional modifiedAt

modifiedAt?: Date

Time of the last rule outcome modification.

Optional name

name?: string

Name of the rule.

Optional owner

owner?: string

Owner of the rule.

Optional scorecardName

scorecardName?: string

The scorecard name to which this rule must belong.

Settings

Member Visibility

Theme

Generated using TypeDoc