Skip to main content

Definition

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

Syntax

Summary

Represents the configuration for autogenerated API examples in the documentation.

Remarks

Controls which programming languages are shown in code examples and whether optional parameters are included in the generated examples.

Constructors

.ctor

Syntax

.ctor Inherited

Inherited from object

Syntax

Properties

Autogenerate

Gets or sets whether to automatically generate code samples for API endpoints.

Syntax

Property Value

Type: System.Nullable<bool>?

Remarks

When set to true (default), code samples are automatically generated for endpoints from API specifications. When set to false, only manually-written code samples (from x-codeSamples in OpenAPI specifications or RequestExample components in MDX) appear in the API playground.

Defaults

Gets or sets whether to show optional parameters in API examples.

Syntax

Property Value

Type: string?

Examples

Remarks

Valid values are:
  • “all”: Show all parameters including optional ones
  • “required”: Show only required parameters Defaults to “all” when not specified.

Languages

Gets or sets the programming languages for autogenerated API snippets.

Syntax

Property Value

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

Examples

Remarks

Specifies which programming languages should be included in the automatically generated code examples. Common values include: “javascript”, “python”, “curl”, “go”, “java”, “php”, “ruby”, etc.

Prefill

Gets or sets whether to prefill the API playground with data from schema examples.

Syntax

Property Value

Type: System.Nullable<bool>?

Examples

Remarks

When enabled, the playground automatically populates request fields with example values from your OpenAPI specification. This provides users with pre-populated data to help them understand the API structure and test endpoints more easily. Defaults to false when not specified.

Methods

Equals Inherited Virtual

Inherited from object

Syntax

Parameters

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

Returns

Type: string?