OpenApiPrimaryErrorMessageExtension Class

Definition

Namespace:

Microsoft.OpenApi.MicrosoftExtensions

Assembly:

Microsoft.OpenApi.dll

Package:

Microsoft.OpenApi v3.1.1

Source:

OpenApiPrimaryErrorMessageExtension.cs

Extension element for OpenAPI to add tag the primary error message to use on error types. x-ms-primary-error-message

public class OpenApiPrimaryErrorMessageExtension : Microsoft.OpenApi.IOpenApiExtension

type OpenApiPrimaryErrorMessageExtension = class
    interface IOpenApiExtension

Public Class OpenApiPrimaryErrorMessageExtension
Implements IOpenApiExtension

Inheritance

Object

OpenApiPrimaryErrorMessageExtension

Implements

IOpenApiExtension

Constructors

Name	Description
OpenApiPrimaryErrorMessageExtension()

Properties

Name	Description
IsPrimaryErrorMessage	Whether this property is the primary error message to use on error types.
Name	Name of the extension as used in the description.

Methods

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