Class OpenApiCoverageCollector

Namespace

ProtoTest.OpenApi

Assembly

ProtoTest.OpenApi.dll

public sealed class OpenApiCoverageCollector : ProtoCoverageCollector, IProtoCollector, IProtoReportSource

Inheritance

object

ProtoCoverageCollector

OpenApiCoverageCollector

Implements

IProtoCollector

IProtoReportSource

Inherited Members

ProtoCoverageCollector.TargetName

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

SheetModelAssertions.ShouldMatchShape<TRow>(TRow, object, JsonSerializerOptions?)

Constructors

OpenApiCoverageCollector(string, IConfiguration, IEnumerable<ProtoApplicationTarget>)

public OpenApiCoverageCollector(string targetName, IConfiguration configuration, IEnumerable<ProtoApplicationTarget> applicationTargets)

Parameters

targetName string

configuration IConfiguration

applicationTargets IEnumerable<ProtoApplicationTarget>

OpenApiCoverageCollector(string, OpenApiDocument)

public OpenApiCoverageCollector(string targetName, OpenApiDocument document)

Parameters

targetName string

document OpenApiDocument

OpenApiCoverageCollector(string, string)

public OpenApiCoverageCollector(string targetName, string openApiSpecSource)

Parameters

targetName string

openApiSpecSource string

Properties

Category

public override string Category { get; }

Property Value

string

Methods

CanCollect(ProtoObservation)

Determines whether this collector accepts an observation.

public override bool CanCollect(ProtoObservation observation)

Parameters

observation ProtoObservation

Returns

bool

Collect(ProtoObservation)

Records an incoming observation. Implementations should support concurrent calls when tests or requests execute in parallel.

public override void Collect(ProtoObservation observation)

Parameters

observation ProtoObservation

GetReportItems()

Generates hierarchical coverage items based on the loaded OpenAPI spec contract. Maps endpoints, response status codes, and schema properties to coverage nodes.

public override IEnumerable<ProtoReportItem> GetReportItems()

Returns

IEnumerable<ProtoReportItem>