This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Grype.

Summary

Reads Grype JSON reports (-o json).

Assembly

Cake.Grype.dll

Namespace

Cake.Grype.Json

Base Types

Object

graph BT Type-->Base0["Object"] Type["GrypeReportReader"] class Type type-node

Syntax

public sealed class GrypeReportReader

Remarks

The report is deserialized from a stream using System.Text.Json's built-in (streaming) collection converters, so large arrays such as matches and ignoredMatches are read incrementally rather than buffered whole; fields the model does not map (for example matchDetails, artifact locations or descriptor.configuration) are skipped, which keeps memory low for large reports.

Constructors

Name	Summary
GrypeReportReader(IFileSystem, ICakeEnvironment)	Initializes a new instance of the `GrypeReportReader` class.

Methods

Name	Value	Summary
Parse(Stream)	GrypeReport	Parses a report from a stream of UTF-8 JSON (a byte order mark is allowed). static
Read(FilePath)	GrypeReport	Reads a report file.

Extension Methods