Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.ObjectSyntax
Summary
Represents the MDX configuration for API pages generated from MDX files.Remarks
This configuration allows manual definition of API endpoints in individual MDX files rather than using an OpenAPI specification. It provides flexibility for custom content and is useful for documenting small APIs or prototyping.Constructors
.ctor
Syntax
.ctor Inherited
Inherited from
objectSyntax
Properties
Auth
Gets or sets the authentication configuration for MDX-based API requests.Syntax
Property Value
Type:Mintlify.Core.Models.MdxAuthConfig?
Remarks
Defines the authentication method and parameters required for API calls made from the documentation playground.Server
Gets or sets the base server URL(s) for API requests.Syntax
Property Value
Type:Mintlify.Core.Models.ServerConfig?
Examples
Remarks
Can be a single string URL or an array of URLs for multiple base endpoints. Used as the base URL for all API requests made from the playground.Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
obj | object? | - |
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?