OpenApiDeprecationExtension Class

Definition

Namespace:: Microsoft.OpenApi.MicrosoftExtensions

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

Source:: OpenApiDeprecationExtension.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.

Extension element for OpenAPI to add deprecation information. x-ms-deprecation

public class OpenApiDeprecationExtension : Microsoft.OpenApi.IOpenApiExtension

type OpenApiDeprecationExtension = class
    interface IOpenApiExtension

Public Class OpenApiDeprecationExtension
Implements IOpenApiExtension

Inheritance: Object
OpenApiDeprecationExtension

Implements: IOpenApiExtension

Constructors

Name	Description
OpenApiDeprecationExtension()

Properties

Name	Description
Date	The date at which the element has been/will be deprecated.
Description	The description of the revision.
Name	Name of the extension as used in the description.
RemovalDate	The date at which the element has been/will be removed entirely from the service.
Version	The version this revision was introduced.

Methods

Name	Description
Parse(JsonNode)	Parses the JsonNodeExtension to OpenApiDeprecationExtension.
Write(IOpenApiWriter, OpenApiSpecVersion)	Write out contents of custom extension

Applies to