Definition

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

Syntax

Mintlify.Core.Models.ApiSpecConfig

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

public ApiSpecConfig()

Properties

Directory

Gets or sets the directory path for API specifications.

Syntax

public string Directory { get; set; }

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

public string Source { get; set; }

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

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

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

ToString

Returns the string representation of the API specification configuration.

Syntax

public override string ToString()

Returns

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