Class IntegrityReportJson

Namespace

Typhon.Engine

Assembly

Typhon.Engine.dll

Renders an IntegrityReport as JSON for CI gates, scripts and the Workbench.

public static class IntegrityReportJson

Inheritance

object

IntegrityReportJson

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

The schema is versioned (ReportVersion) and finding codes are stable, because a finding code is an API — renaming one breaks somebody's alert. Written by hand rather than through a serializer so the shape is visible in one place and cannot drift when a property is added to a model type.

Methods

Render(IntegrityReport, bool)

Renders the report as JSON.

public static string Render(IntegrityReport report, bool indent = true)

Parameters

report IntegrityReport

The report to render.

indent bool

Whether to pretty-print.

Returns

string

Exceptions

ArgumentNullException

report is null.