Share via


DiagnosticItem interface

A diagnostic is a message associated with an NGINX config. The Analyzer returns diagnostics with a level indicating the importance of the diagnostic with optional category.

Properties

category

Category of warning like Best-practices, Recommendation, Security etc.

description
directive
file

The filepath of the most relevant config file.

id

Unique identifier for the diagnostic.

level

Warning or Info

line
message
rule

Property Details

category

Category of warning like Best-practices, Recommendation, Security etc.

category?: string

Property Value

string

description

description: string

Property Value

string

directive

directive: string

Property Value

string

file

The filepath of the most relevant config file.

file: string

Property Value

string

id

Unique identifier for the diagnostic.

id?: string

Property Value

string

level

Warning or Info

level: string

Property Value

string

line

line: number

Property Value

number

message

message: string

Property Value

string

rule

rule: string

Property Value

string