OpenApiValidator Class

Definition

Namespace:: Microsoft.OpenApi

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

Source:: OpenApiValidator.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Class containing dispatchers to execute validation rules on for Open API document.

public class OpenApiValidator : Microsoft.OpenApi.OpenApiVisitorBase, Microsoft.OpenApi.IValidationContext

type OpenApiValidator = class
    inherit OpenApiVisitorBase
    interface IValidationContext

Public Class OpenApiValidator
Inherits OpenApiVisitorBase
Implements IValidationContext

Inheritance: Object

OpenApiVisitorBase
OpenApiValidator

Implements: IValidationContext

Constructors

Name	Description
OpenApiValidator(ValidationRuleSet)	Create a visitor that will validate an OpenAPIDocument

Properties

Name	Description
CurrentKeys	Properties available to identify context of where an object is within OpenAPI Document (Inherited from OpenApiVisitorBase)
Errors	Gets the validation errors.
PathString	Pointer to source of validation error in document (Inherited from OpenApiVisitorBase)
Warnings	Gets the validation warnings.

Methods

Name	Description
AddError(OpenApiValidatorError)	Register an error with the validation context.
AddWarning(OpenApiValidatorWarning)	Register an error with the validation context.
Enter(String)	Allow Rule to indicate validation error occurred at a deeper context level. (Inherited from OpenApiVisitorBase)
Exit()	Exit from path context level. Enter and Exit calls should be matched. (Inherited from OpenApiVisitorBase)
Visit(IDictionary<HttpMethod,OpenApiOperation>)	Visits the operations.
Visit(IDictionary<String,IOpenApiCallback>)	Visits callbacks.
Visit(IDictionary<String,IOpenApiExample>)	Visits the examples.
Visit(IDictionary<String,IOpenApiHeader>)	Visits headers.
Visit(IDictionary<String,IOpenApiLink>)	Visits the links.
Visit(IDictionary<String,IOpenApiMediaType>)	Visits media type content.
Visit(IDictionary<String,IOpenApiPathItem>)	Visits Webhooks> (Inherited from OpenApiVisitorBase)
Visit(IDictionary<String,OpenApiEncoding>)	Visits a dictionary of encodings
Visit(IDictionary<String,OpenApiServerVariable>)	Visits a dictionary of server variables
Visit(IList<IOpenApiParameter>)	Visits list of OpenApiParameter (Inherited from OpenApiVisitorBase)
Visit(IList<OpenApiSecurityRequirement>)	Visits list of OpenApiSecurityRequirement (Inherited from OpenApiVisitorBase)
Visit(IList<OpenApiServer>)	Visits list of OpenApiServer (Inherited from OpenApiVisitorBase)
Visit(IOpenApiCallback)	Visits IOpenApiCallback
Visit(IOpenApiExample)	Visits IOpenApiExample
Visit(IOpenApiExtensible)	Visits IOpenApiExtensible
Visit(IOpenApiExtension)	Visits IOpenApiExtension
Visit(IOpenApiHeader)	Visits OpenApiHeader
Visit(IOpenApiLink)	Visits IOpenApiLink
Visit(IOpenApiMediaType)	Visits IOpenApiMediaType
Visit(IOpenApiParameter)	Visits OpenApiParameter
Visit(IOpenApiPathItem)	Visits OpenApiPathItem
Visit(IOpenApiReferenceHolder)	Visits IOpenApiReferenceable instances that are references and not in components (Inherited from OpenApiVisitorBase)
Visit(IOpenApiRequestBody)	Visits IOpenApiRequestBody
Visit(IOpenApiResponse)	Visits OpenApiResponse
Visit(IOpenApiSchema)	Visits IOpenApiSchema
Visit(IOpenApiSecurityScheme)	Visits IOpenApiSecurityScheme
Visit(ISet<OpenApiTag>)	Visits list of OpenApiTag (Inherited from OpenApiVisitorBase)
Visit(ISet<OpenApiTagReference>)	Visits list of OpenApiTagReference (Inherited from OpenApiVisitorBase)
Visit(JsonNode)	Visits JsonNode (Inherited from OpenApiVisitorBase)
Visit(List<IOpenApiExample>)	Visits list of IOpenApiExample
Visit(OpenApiComponents)	Visits OpenApiComponents
Visit(OpenApiContact)	Visits OpenApiContact
Visit(OpenApiDocument)	Visits OpenApiDocument
Visit(OpenApiEncoding)	Visits OpenApiEncoding
Visit(OpenApiExternalDocs)	Visits OpenApiComponents
Visit(OpenApiInfo)	Visits OpenApiInfo
Visit(OpenApiLicense)	Visits OpenApiLicense
Visit(OpenApiOAuthFlow)	Visits OpenApiOAuthFlow
Visit(OpenApiOperation)	Visits OpenApiOperation
Visit(OpenApiPaths)	Visits OpenApiPaths
Visit(OpenApiResponses)	Visits OpenApiResponses
Visit(OpenApiSecurityRequirement)	Visits OpenApiSecurityRequirement
Visit(OpenApiServer)	Visits OpenApiServer
Visit(OpenApiServerVariable)	Visits OpenApiServerVariable
Visit(OpenApiTag)	Visits OpenApiTag
Visit(OpenApiTagReference)	Visits OpenApiTagReference (Inherited from OpenApiVisitorBase)

Extension Methods

Name	Description
CreateError(IValidationContext, String, String)	Helper method to simplify validation rules
CreateWarning(IValidationContext, String, String)	Helper method to simplify validation rules

Applies to

Share via