Table of Contents

Class OpenApiValidationResult

Namespace
Refitter.Core.Validation
Assembly
Refitter.Core.dll

Represents the result of an OpenAPI document validation.

[ExcludeFromCodeCoverage]
public record OpenApiValidationResult : IEquatable<OpenApiValidationResult>
Inheritance
OpenApiValidationResult
Implements
Inherited Members

Constructors

OpenApiValidationResult(OpenApiDiagnostic, OpenApiStats)

Represents the result of an OpenAPI document validation.

public OpenApiValidationResult(OpenApiDiagnostic Diagnostics, OpenApiStats Statistics)

Parameters

Diagnostics OpenApiDiagnostic

The diagnostics collected during validation.

Statistics OpenApiStats

The element counts collected during validation.

Properties

Diagnostics

The diagnostics collected during validation.

public OpenApiDiagnostic Diagnostics { get; init; }

Property Value

OpenApiDiagnostic

IsValid

Gets whether the validation passed with no errors.

public bool IsValid { get; }

Property Value

bool

Statistics

The element counts collected during validation.

public OpenApiStats Statistics { get; init; }

Property Value

OpenApiStats

Methods

ThrowIfInvalid()

Throws an OpenApiValidationException if validation failed.

public void ThrowIfInvalid()

Exceptions

OpenApiValidationException

Thrown when IsValid is false.