Skip to main content

Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.Object

Syntax

Mintlify.Core.Models.VersionConfig

Summary

Represents a version configuration in Mintlify navigation.

Remarks

Versions allow you to maintain multiple documentation versions. The version name is required.

Constructors

.ctor

Syntax

public VersionConfig()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Anchors

Gets or sets the anchors for the version.

Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.AnchorConfig> Anchors { get; set; }

Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.AnchorConfig>?

AsyncApi

Gets or sets the AsyncAPI configuration.

Syntax

public object AsyncApi { get; set; }

Property Value

Type: object?

Default

Gets or sets whether this version is the default version.

Syntax

public System.Nullable<bool> Default { get; set; }

Property Value

Type: System.Nullable<bool>? Gets or sets the dropdowns for the version.

Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.DropdownConfig> Dropdowns { get; set; }

Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.DropdownConfig>?

Global

Gets or sets the global navigation configuration.

Syntax

public Mintlify.Core.Models.GlobalNavigationConfig Global { get; set; }

Property Value

Type: Mintlify.Core.Models.GlobalNavigationConfig?

Groups

Gets or sets the groups for the version.

Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.GroupConfig> Groups { get; set; }

Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.GroupConfig>?

Hidden

Gets or sets whether the current option is default hidden.

Syntax

public System.Nullable<bool> Hidden { get; set; }

Property Value

Type: System.Nullable<bool>?

Href

Gets or sets the URL or path for the version.

Syntax

public string Href { get; set; }

Property Value

Type: string?

Languages

Gets or sets the languages for the version.

Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.LanguageConfig> Languages { get; set; }

Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.LanguageConfig>?

OpenApi

Gets or sets the OpenAPI configuration.

Syntax

public object OpenApi { get; set; }

Property Value

Type: object?

Pages

Gets or sets the pages for the version.

Syntax

public System.Collections.Generic.List<object> Pages { get; set; }

Property Value

Type: System.Collections.Generic.List<object>?

Tabs

Gets or sets the tabs for the version.

Syntax

public System.Collections.Generic.List<Mintlify.Core.Models.TabConfig> Tabs { get; set; }

Property Value

Type: System.Collections.Generic.List<Mintlify.Core.Models.TabConfig>?

Version

Gets or sets the name of the version.

Syntax

public string Version { get; set; }

Property Value

Type: string

Remarks

This is a required field that identifies the version.

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

NameTypeDescription
objobject?-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?