FixEnumsOptions - класс

Various configuration properties for fixing enums.

Definition

Пространство имён: Tessa.Web.Unchase.Swashbuckle.Options
Сборка: Tessa.Web (в Tessa.Web.dll) Версия: 4.0.5
C#
public class FixEnumsOptions
Inheritance
Object    FixEnumsOptions

Конструкторы

FixEnumsOptionsИнициализирует новый экземпляр класса FixEnumsOptions

Свойства

ApplyDocumentFilter Apply fix enum filter to OpenApi document. Default value is true.

Equivalent to "options.DocumentFilter<DisplayEnumsWithValuesDocumentFilter>();"

ApplyParameterFilter Apply fix enum filter to OpenApi parameters. Default value is true.

Equivalent to "options.ParameterFilter<XEnumNamesParameterFilter>();"

ApplySchemaFilter Apply fix enum filter to OpenApi schema. Default value is true.

Equivalent to "options.SchemaFilter<XEnumNamesSchemaFilter>();"

DescriptionSource Source to get descriptions. Default value is DescriptionAttributes.
IncludeDescriptions Include descriptions from DescriptionAttribute or xml comments. Default value is false.
IncludedXmlCommentsPaths Included file paths with XML comments.
IncludeXEnumRemarks Include remarks for descriptions from xml comments. Default value is false.
NewLine New line for enum values descriptions.
XEnumDescriptionsAlias Alias for replacing "x-enumDescriptions" in swagger documentation.
XEnumNamesAlias Alias for replacing "x-enumNames" in swagger documentation.

Методы

EqualsDetermines whether the specified object is equal to the current object.
(Унаследован от Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Унаследован от Object)
GetHashCodeServes as the default hash function.
(Унаследован от Object)
GetTypeGets the Type of the current instance.
(Унаследован от Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Унаследован от Object)
ToStringReturns a string that represents the current object.
(Унаследован от Object)

Методы расширения

Get
(Определяется ComHelper)
IncludeXmlComments
(Определяется WebExtensions)
IncludeXmlCommentsForTessa
(Определяется WebExtensions)
IncludeXmlCommentsForTessaClient
(Определяется WebClientExtensions)
IncludeXmlCommentsFrom Include XML comments from fullPath.
(Определяется FixEnumsOptionsExtensions)
Invoke
(Определяется ComHelper)
Set
(Определяется ComHelper)

См. также