Definition

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

Syntax

Mintlify.Core.Models.GroupConfig

Summary

Represents a group configuration in Mintlify navigation.

Remarks

Groups organize pages into sections in your navigation. The group name is required.

Constructors

.ctor

Syntax

public GroupConfig()

Properties

AsyncApi

Gets or sets the AsyncAPI configuration for the group.

Syntax

public object AsyncApi { get; set; }

Property Value

Type: object?

Group

Gets or sets the name of the group.

Syntax

public string Group { get; set; }

Property Value

Type: string

Remarks

This is a required field that appears as the group title in navigation. Group names cannot be null. While empty string names are technically accepted, they are not recommended as Mintlify treats each empty group as a separate ungrouped navigation section rather than merging them together.

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>?

Icon

Gets or sets the icon to be displayed in the section.

Syntax

public object Icon { get; set; }

Property Value

Type: object?

OpenApi

Gets or sets the OpenAPI configuration for the group.

Syntax

public object OpenApi { get; set; }

Property Value

Type: object?

Pages

Gets or sets the pages in the group.

Syntax

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

Property Value

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

Remarks

Pages can be strings (page paths) or nested GroupConfig objects.

Root

Gets or sets the root page for the group.

Syntax

public string Root { get; set; }

Property Value

Type: string?

Tag

Gets or sets the tag for the group.

Syntax

public string Tag { get; set; }

Property Value

Type: string?