Skip to main content

Definition

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

Syntax

Summary

Represents an API specification configuration for OpenAPI or AsyncAPI.

Remarks

API specifications can be specified as simple URLs, multiple URLs, or detailed configurations with source and directory properties. This matches the official Mintlify schema.

Constructors

.ctor

Syntax

.ctor Inherited

Inherited from object

Syntax

Properties

Directory

Gets or sets the directory path for API specifications.

Syntax

Property Value

Type: string?

Remarks

Specifies a directory containing API specification files. Used in conjunction with Source for complex configurations.

Source

Gets or sets the source URL or path for API specifications.

Syntax

Property Value

Type: string?

Remarks

Can be an absolute URL or relative path to an API specification file.

Urls

Gets or sets the list of URLs when multiple specifications are provided.

Syntax

Property Value

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

Remarks

Used internally when the API config represents multiple URL strings. Not serialized directly as it’s handled by the converter.

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 Override

Returns the string representation of the API specification configuration.

Syntax

Returns

Type: string The source URL, first URL, or empty string.

ToString Inherited Virtual

Inherited from object

Syntax

Returns

Type: string?