OpenApiInfo 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.

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

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

type OpenApiInfo = class
    interface IOpenApiSerializable
    interface IOpenApiElement
    interface IOpenApiExtensible

Public Class OpenApiInfo
Implements IOpenApiExtensible, IOpenApiSerializable

Inheritance: Object
OpenApiInfo

Implements: IOpenApiElement IOpenApiExtensible IOpenApiSerializable

Constructors

OpenApiInfo()	Parameter-less constructor
OpenApiInfo(OpenApiInfo)	Initializes a copy of an OpenApiInfo object

Properties

Contact	The contact information for the exposed API.
Description	A short description of the application.
Extensions	This object MAY be extended with Specification Extensions.
License	The license information for the exposed API.
TermsOfService	A URL to the Terms of Service for the API. MUST be in the format of a URL.
Title	REQUIRED. The title of the application.
Version	REQUIRED. The version of the OpenAPI document.

Methods

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

Extension Methods

Validate(IOpenApiElement, ValidationRuleSet)

Validate element and all child elements

Applies to