Microsoft.OpenApi Namespace

A simple object to allow referencing other components in the specification, internally and externally.

Base class for OpenApiReferenceHolder.

Body expression.

String literal with embedded expressions

Object containing contextual information based on where the walker is currently referencing in an OpenApiDocument

Represents the Open Api Data type metadata attribute.

Enumeration type extension methods.

A custom StreamWriter which supports setting a IFormatProvider.

Header expression, The token identifier in header is case-insensitive.

A wrapper class for JsonNode

A sentinel value representing JSON null. This can only be used for OpenAPI properties of type JsonNode

JSON pointer.

Schema reference information that includes metadata annotations from JSON Schema 2020-12. This class extends OpenApiReference to provide schema-specific metadata override capabilities.

Method expression.

Callback Object: A map of possible out-of band callbacks related to the parent operation.

Callback Object Reference: A reference to a map of possible out-of band callbacks related to the parent operation.

Components Object.

The validation rules for OpenApiComponents.

Constants used in the Open API document.

Contact Object.

The validation rules for OpenApiContact.

Discriminator object.

Describes an OpenAPI object (OpenAPI document). See: https://spec.openapis.org

The validation rules for OpenApiDocument.

Extension methods that apply across all OpenAPIElements

ExternalDocs object.

Error related to the Open API Document.

Example Object.

Example Object Reference.

Exception type representing exceptions in the Open API library.

Generic dictionary type for Open API dictionary element.

Extension methods to verify validity and add an extension to Extensions property.

The validation rules for IOpenApiExtensible.

ExternalDocs object.

The validation rules for OpenApiExternalDocs.

A service that slices an OpenApiDocument into a subset document

Header Object. The Header Object follows the structure of the Parameter Object.

Header Object Reference.

Open API Info Object, it provides the metadata about the Open API.

The validation rules for OpenApiInfo.

JSON Writer.

Configuration settings to control how OpenAPI Json documents are written

License Object.

The validation rules for OpenApiLicense.

Link Object.

Link Object Reference.

Media Type Object.

Media Type Object Reference.

Defines a non-default set of rules for validating examples in header, media type and parameter objects against the schema

OAuth Flow Object.

The validation rules for OpenApiOAuthFlow.

OAuth Flows Object.

Operation Object.

Parameter Object.

Parameter Object Reference.

The validation rules for OpenApiParameter.

Path Item Object: to describe the operations available on a single path.

Path Item Object Reference: to describe the operations available on a single path.

Paths object.

The validation rules for OpenApiPaths.

Defines an exception indicating OpenAPI Reader encountered an issue while reading.

Additional recommended validation rules for OpenAPI.

OpenApiReferenceWithSummary is a reference to an OpenAPI component that includes a description.

OpenApiReferenceWithSummary is a reference to an OpenAPI component that includes a summary.

Request Body Object

Request Body Object Reference.

Response object.

Response Object Reference.

The validation rules for OpenApiResponse.

Responses object.

The validation rules for OpenApiResponses.

The Validator attribute.

The Schema Object allows the definition of input and output data types.

Schema reference object

The validation rules for OpenApiSchema.

Security Requirement Object. Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. If the security scheme is of type "oauth2" or "openIdConnect", then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty.

Security Scheme Object.

Security Scheme Object Reference.

Extension methods for IOpenApiSerializable serialization.

Server Object: an object representing a Server.

Extension methods for OpenApiServer serialization.

The validation rules for OpenApiServer.

Server Variable Object.

Tag Object.

Tag Object Reference

The validation rules for OpenApiTag.

Extension methods for Type.

Defines an exception indicating OpenAPI Reader encountered an unsupported specification version while reading.

A directory structure representing the paths of an OpenAPI document.

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

Errors detected when validating an OpenAPI Element

Warnings detected when validating an OpenAPI Element

Open API visitor base provides common logic for concrete visitors

The walker to visit multiple Open API elements.

Contains a set of OpenApi documents and document fragments that reference each other

Extensions methods for writing the JsonNodeExtension

Base class for Open API writer.

Exception type representing exceptions in the OpenAPI writer.

Extension methods for writing Open API documentation.

Configuration settings to control how OpenAPI documents are written

XML Object.

YAML writer.

Visits OpenApi operations and parameters.

Path expression, the name in path is case-sensitive.

Query expression, the name in query is case-sensitive.

$request. expression.

$response. expression.

Base class for the Open API runtime expression.

The wrapper either for JsonNode or RuntimeExpression

Class representing scope information.

Defines a search result model for visited operations.

Source expression.

Extensions class for strings to handle special characters.

StatusCode expression.

Url expression.

Helper methods to simplify creating validation rules

Class containing validation rule logic.

Class containing validation rule logic for IOpenApiElement.

The rule set of the validation.

Represents an Open API element that can be annotated with non-serializable properties in a property bag.

Defines the base properties for the callback object. This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.

Describes an element that has a description.

Represents an Open API element.

Defines the base properties for the example object. This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.

Represents an Extensible Open API element.

Interface required for implementing any custom extension

Defines the base properties for the headers object. This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.

Defines the base properties for the link object. This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.

Defines the base properties for the media type object. This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.

Defines the base properties for the parameter object. This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.

Defines the base properties for the path item object. This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.

Interface for Open API readers.

Describes an element that has a description.

Represents an Extensible Open API element elements can be rad from.

Represents an Open API element is referenceable.

A generic interface for OpenApiReferenceable objects that have a target.

A generic interface for OpenApiReferenceable objects that have a target.

A generic interface for OpenApiReferenceable objects that have a target.

Defines the base properties for the request body object. This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.

Defines the base properties for the response object. This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.

Defines the base properties for the schema object. This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.

Defines the base properties for the security scheme object. This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.

Represents an Open API element that comes with serialization functionality.

Describes an element that has a summary.

Defines the base properties for the path item object. This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.

Interface for writing Open API documentation.

Interface for shallow copyable objects.

Interface for service that translates a URI into a stream that can be loaded by a Reader

Constrained interface used to provide context to rule implementation

Represents the type of a JSON schema.

Represents versions of OpenAPI specification.

The type of the XML node

The location of the parameter.

The style of the parameter.

The reference type.

Various scope types for Open API writer.

The type of the security scheme