Skip to main content

Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Converters Inheritance: System.Text.Json.Serialization.JsonConverter<Mintlify.Core.Models.ApiSpecConfig>

Syntax

Summary

Handles JSON conversion for API configuration properties that can be strings, arrays, or objects.

Remarks

API configurations in Mintlify (OpenAPI and AsyncAPI) can be specified as:
  • String: Single URL to specification file
  • Array: Multiple URLs to specification files
  • Object: Complex configuration with source and directory properties

Constructors

.ctor

Syntax

Methods

CanConvert Override

Determines whether the specified type can be converted by this converter.

Syntax

Parameters

Returns

Type: bool True if the type is ApiSpecConfig; otherwise, false.

Read Override

Reads and converts the JSON to an ApiSpecConfig object.

Syntax

Parameters

Returns

Type: Mintlify.Core.Models.ApiSpecConfig? An ApiSpecConfig for all supported API configuration formats.

Exceptions

Write Override

Writes the ApiSpecConfig object to JSON.

Syntax

Parameters