Class ConfigObject

Namespace

Swashbuckle.AspNetCore.SwaggerUI

Assembly

Swashbuckle.AspNetCore.SwaggerUI.dll

public class ConfigObject

Inheritance

object

ConfigObject

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ConfigObject()

public ConfigObject()

Properties

AdditionalItems

[JsonExtensionData]
public Dictionary<string, object> AdditionalItems { get; set; }

Property Value

Dictionary<string, object>

DeepLinking

If set to true, enables deep linking for tags and operations

public bool DeepLinking { get; set; }

Property Value

bool

DefaultModelExpandDepth

The default expansion depth for the model on the model-example section

public int DefaultModelExpandDepth { get; set; }

Property Value

int

DefaultModelRendering

Controls how the model is shown when the API is first rendered. (The user can always switch the rendering for a given model by clicking the 'Model' and 'Example Value' links)

public ModelRendering DefaultModelRendering { get; set; }

Property Value

ModelRendering

DefaultModelsExpandDepth

The default expansion depth for models (set to -1 completely hide the models)

public int DefaultModelsExpandDepth { get; set; }

Property Value

int

DisplayOperationId

Controls the display of operationId in operations list

public bool DisplayOperationId { get; set; }

Property Value

bool

DisplayRequestDuration

Controls the display of the request duration (in milliseconds) for Try-It-Out requests

public bool DisplayRequestDuration { get; set; }

Property Value

bool

DocExpansion

Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing)

public DocExpansion DocExpansion { get; set; }

Property Value

DocExpansion

Filter

If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be an empty string or specific value, in which case filtering will be enabled using that value as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag

public string Filter { get; set; }

Property Value

string

MaxDisplayedTags

If set, limits the number of tagged operations displayed to at most this many. The default is to show all operations

public int? MaxDisplayedTags { get; set; }

Property Value

int?

OAuth2RedirectUrl

OAuth redirect URL

[JsonPropertyName("oauth2RedirectUrl")]
public string OAuth2RedirectUrl { get; set; }

Property Value

string

ShowCommonExtensions

Controls the display of extensions (pattern, maxLength, minLength, maximum, minimum) fields and values for Parameters

public bool ShowCommonExtensions { get; set; }

Property Value

bool

ShowExtensions

Controls the display of vendor extension (x-) fields and values for Operations, Parameters, and Schema

public bool ShowExtensions { get; set; }

Property Value

bool

SupportedSubmitMethods

List of HTTP methods that have the Try it out feature enabled. An empty array disables Try it out for all operations. This does not filter the operations from the display

public IEnumerable<SubmitMethod> SupportedSubmitMethods { get; set; }

Property Value

IEnumerable<SubmitMethod>

Urls

One or more Swagger JSON endpoints (url and name) to power the UI

public IEnumerable<UrlDescriptor> Urls { get; set; }

Property Value

IEnumerable<UrlDescriptor>

ValidatorUrl

By default, Swagger-UI attempts to validate specs against swagger.io's online validator. You can use this parameter to set a different validator URL, for example for locally deployed validators (Validator Badge). Setting it to null will disable validation

public string ValidatorUrl { get; set; }

Property Value

string