OpenApiXml Class

Reference

Definition

Namespace:: Microsoft.OpenApi.Models

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v1.6.0

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.

XML Object.

public class OpenApiXml : Microsoft.OpenApi.Interfaces.IOpenApiExtensible, Microsoft.OpenApi.Interfaces.IOpenApiSerializable

type OpenApiXml = class
    interface IOpenApiSerializable
    interface IOpenApiElement
    interface IOpenApiExtensible

Public Class OpenApiXml
Implements IOpenApiExtensible, IOpenApiSerializable

Inheritance: Object
OpenApiXml

Implements: IOpenApiElement IOpenApiExtensible IOpenApiSerializable

Constructors

OpenApiXml()	Parameterless constructor
OpenApiXml(OpenApiXml)	Initializes a copy of an OpenApiXml object

Properties

Attribute	Declares whether the property definition translates to an attribute instead of an element. Default value is false.
Extensions	Specification Extensions.
Name	Replaces the name of the element/attribute used for the described schema property.
Namespace	The URI of the namespace definition. Value MUST be in the form of an absolute URI.
Prefix	The prefix to be used for the name
Wrapped	Signifies whether the array is wrapped. Default value is false.

Methods

SerializeAsV2(IOpenApiWriter)	Serialize OpenApiXml to Open Api v2.0
SerializeAsV3(IOpenApiWriter)	Serialize OpenApiXml to Open Api v3.0

Extension Methods

Validate(IOpenApiElement, ValidationRuleSet)

Validate element and all child elements

Applies to

Share via