OpenApiVisitorBase Class

Definition

Namespace:

Microsoft.OpenApi.Services

Assembly:

Microsoft.OpenApi.dll

Package:

Microsoft.OpenApi v1.6.0

Open API visitor base provides common logic for concrete visitors

public abstract class OpenApiVisitorBase

type OpenApiVisitorBase = class

Public MustInherit Class OpenApiVisitorBase

Inheritance

Object

OpenApiVisitorBase

Derived

Microsoft.OpenApi.Services.OpenApiReferenceResolver

Microsoft.OpenApi.Services.OperationSearch

Microsoft.OpenApi.Validations.OpenApiValidator

Constructors

OpenApiVisitorBase()

Properties

CurrentKeys	Properties available to identify context of where an object is within OpenAPI Document
PathString	Pointer to source of validation error in document

Methods

Enter(String)	Allow Rule to indicate validation error occured at a deeper context level.
Exit()	Exit from path context elevel. Enter and Exit calls should be matched.
Visit(IDictionary<OperationType,OpenApiOperation>)	Visits the operations.
Visit(IDictionary<String,OpenApiCallback>)	Visits callbacks.
Visit(IDictionary<String,OpenApiEncoding>)	Visits a dictionary of encodings
Visit(IDictionary<String,OpenApiExample>)	Visits the examples.
Visit(IDictionary<String,OpenApiHeader>)	Visits headers.
Visit(IDictionary<String,OpenApiLink>)	Visits the links.
Visit(IDictionary<String,OpenApiMediaType>)	Visits media type content.
Visit(IDictionary<String,OpenApiServerVariable>)	Visits a dictionary of server variables
Visit(IList<OpenApiExample>)	Visits list of OpenApiExample
Visit(IList<OpenApiParameter>)	Visits list of OpenApiParameter
Visit(IList<OpenApiSecurityRequirement>)	Visits list of OpenApiSecurityRequirement
Visit(IList<OpenApiServer>)	Visits list of OpenApiServer
Visit(IList<OpenApiTag>)	Visits list of OpenApiTag
Visit(IOpenApiExtensible)	Visits IOpenApiExtensible
Visit(IOpenApiExtension)	Visits IOpenApiExtension
Visit(IOpenApiReferenceable)	Visits IOpenApiReferenceable instances that are references and not in components
Visit(OpenApiCallback)	Visits OpenApiCallback
Visit(OpenApiComponents)	Visits OpenApiComponents
Visit(OpenApiContact)	Visits OpenApiContact
Visit(OpenApiDocument)	Visits OpenApiDocument
Visit(OpenApiEncoding)	Visits OpenApiEncoding
Visit(OpenApiExample)	Visits OpenApiExample
Visit(OpenApiExternalDocs)	Visits OpenApiComponents
Visit(OpenApiHeader)	Visits OpenApiHeader
Visit(OpenApiInfo)	Visits OpenApiInfo
Visit(OpenApiLicense)	Visits OpenApiLicense
Visit(OpenApiLink)	Visits OpenApiLink
Visit(OpenApiMediaType)	Visits OpenApiMediaType
Visit(OpenApiOAuthFlow)	Visits OpenApiOAuthFlow
Visit(OpenApiOperation)	Visits OpenApiOperation
Visit(OpenApiParameter)	Visits OpenApiParameter
Visit(OpenApiPathItem)	Visits OpenApiPathItem
Visit(OpenApiPaths)	Visits OpenApiPaths
Visit(OpenApiRequestBody)	Visits OpenApiRequestBody
Visit(OpenApiResponse)	Visits OpenApiResponse
Visit(OpenApiResponses)	Visits OpenApiResponses
Visit(OpenApiSchema)	Visits OpenApiSchema
Visit(OpenApiSecurityRequirement)	Visits OpenApiSecurityRequirement
Visit(OpenApiSecurityScheme)	Visits OpenApiSecurityScheme
Visit(OpenApiServer)	Visits OpenApiServer
Visit(OpenApiServerVariable)	Visits OpenApiServerVariable
Visit(OpenApiTag)	Visits OpenApiTag