Skip to main content

Definition

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

Syntax

Mintlify.Core.Models.ApiParamsConfig

Summary

Represents the display settings for API parameters in the documentation.

Remarks

Controls how API parameters are displayed in the interactive playground and documentation pages, including whether they are expanded by default.

Constructors

.ctor

Syntax

public ApiParamsConfig()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Expanded

Gets or sets whether to expand all parameters by default.

Syntax

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

Property Value

Type: System.Nullable<bool>

Examples

"params": {
  "expanded": true
}

Remarks

When true, all API parameters will be displayed in an expanded state. When false or null, parameters will be collapsed by default. Defaults to collapsed (false) when not specified.

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?