DocsJsonValidator - DotNetDocs

Definition

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

Syntax

Mintlify.Core.DocsJsonValidator

Summary

Validates Mintlify docs.json configuration against the official schema requirements.

Remarks

This class provides comprehensive validation of the docs.json configuration to ensure it complies with the Mintlify schema and will work correctly when deployed.

Constructors

.ctor

Syntax

public DocsJsonValidator()

.ctor Inherited

Inherited from object

Syntax

public Object()

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

Validate

Validates a docs.json configuration against the Mintlify schema.

Syntax

public System.Collections.Generic.List<string> Validate(Mintlify.Core.Models.DocsJsonConfig config)

Parameters

Name	Type	Description
`config`	`Mintlify.Core.Models.DocsJsonConfig`	The configuration to validate.

Returns

Type: System.Collections.Generic.List<string> A list of validation errors. Empty if configuration is valid.

ValidateApi

Validates the API configuration.

Syntax

public void ValidateApi(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

Parameters

Name	Type	Description
`config`	`Mintlify.Core.Models.DocsJsonConfig`	The configuration to validate.
`errors`	`System.Collections.Generic.List<string>`	The list to add errors to.

ValidateAppearance

Validates the appearance configuration.

Syntax

public void ValidateAppearance(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

Parameters

Name	Type	Description
`config`	`Mintlify.Core.Models.DocsJsonConfig`	The configuration to validate.
`errors`	`System.Collections.Generic.List<string>`	The list to add errors to.

ValidateColors

Validates the color configuration.

Syntax

public void ValidateColors(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

Parameters

Name	Type	Description
`config`	`Mintlify.Core.Models.DocsJsonConfig`	The configuration to validate.
`errors`	`System.Collections.Generic.List<string>`	The list to add errors to.

ValidateGroups

Validates group configurations in navigation.

Syntax

public void ValidateGroups(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

Parameters

Name	Type	Description
`config`	`Mintlify.Core.Models.DocsJsonConfig`	The configuration to validate.
`errors`	`System.Collections.Generic.List<string>`	The list to add errors to.

ValidateIcons

Validates the icons configuration.

Syntax

public void ValidateIcons(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

Parameters

Name	Type	Description
`config`	`Mintlify.Core.Models.DocsJsonConfig`	The configuration to validate.
`errors`	`System.Collections.Generic.List<string>`	The list to add errors to.

ValidateLogo

Validates the logo configuration.

Syntax

public void ValidateLogo(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

Parameters

Name	Type	Description
`config`	`Mintlify.Core.Models.DocsJsonConfig`	The configuration to validate.
`errors`	`System.Collections.Generic.List<string>`	The list to add errors to.

ValidateNavigation

Validates the navigation configuration.

Syntax

public void ValidateNavigation(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

Parameters

Name	Type	Description
`config`	`Mintlify.Core.Models.DocsJsonConfig`	The configuration to validate.
`errors`	`System.Collections.Generic.List<string>`	The list to add errors to.

ValidateRequired

Validates that the configuration has all required properties.

Syntax

public void ValidateRequired(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

Parameters

Name	Type	Description
`config`	`Mintlify.Core.Models.DocsJsonConfig`	The configuration to validate.
`errors`	`System.Collections.Generic.List<string>`	The list to add errors to.

ValidateSeo

Validates the SEO configuration.

Syntax

public void ValidateSeo(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

Parameters

Name	Type	Description
`config`	`Mintlify.Core.Models.DocsJsonConfig`	The configuration to validate.
`errors`	`System.Collections.Generic.List<string>`	The list to add errors to.

ValidateTheme

Validates the theme configuration.

Syntax

public void ValidateTheme(Mintlify.Core.Models.DocsJsonConfig config, System.Collections.Generic.List<string> errors)

Parameters

Name	Type	Description
`config`	`Mintlify.Core.Models.DocsJsonConfig`	The configuration to validate.
`errors`	`System.Collections.Generic.List<string>`	The list to add errors to.

​Definition

​Syntax

​Summary

​Remarks

​Constructors

​ .ctor

​Syntax

​ .ctor Inherited

​Syntax

​Methods

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

​ Validate

​Syntax

​Parameters

​Returns

​ ValidateApi

​Syntax

​Parameters

​ ValidateAppearance

​Syntax

​Parameters

​ ValidateColors

​Syntax

​Parameters

​ ValidateGroups

​Syntax

​Parameters

​ ValidateIcons

​Syntax

​Parameters

​ ValidateLogo

​Syntax

​Parameters

​ ValidateNavigation

​Syntax

​Parameters

​ ValidateRequired

​Syntax

​Parameters

​ ValidateSeo

​Syntax

​Parameters

​ ValidateTheme

​Syntax

​Parameters

Definition

Syntax

Summary

Remarks

Constructors

.ctor

Syntax

.ctor Inherited

Syntax

Methods

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

MemberwiseClone Inherited

Syntax

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

ToString Inherited Virtual

Syntax

Returns

Validate

Syntax

Parameters

Returns

ValidateApi

Syntax

Parameters

ValidateAppearance

Syntax

Parameters

ValidateColors

Syntax

Parameters

ValidateGroups

Syntax

Parameters

ValidateIcons

Syntax

Parameters

ValidateLogo

Syntax

Parameters

ValidateNavigation

Syntax

Parameters

ValidateRequired

Syntax

Parameters

ValidateSeo

Syntax

Parameters

ValidateTheme

Syntax

Parameters