​
Definition

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

​
Syntax

Mintlify.Core.Models.ApiExamplesConfig

​
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

public ApiExamplesConfig()

​
Properties

​
Defaults

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

​
Syntax

public string Defaults { get; set; }

​
Property Value

Type: string?

​
Examples

"examples": {
  "defaults": "required"
}

​
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

public System.Collections.Generic.List<string> Languages { get; set; }

​
Property Value

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

​
Examples

"examples": {
  "languages": ["javascript", "python", "curl"]
}

​
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.