ICkSchemaValidator

Namespace: Meshmakers.Octo.ConstructionKit.Contracts.Serialization

Interface for schema validation of construction kit models

public interface ICkSchemaValidator

Methods

ValidateElementsInJson(Stream, String, OperationResult)

Validates the elements in the stream using JSON format.

bool ValidateElementsInJson(Stream stream, string locationReference, OperationResult operationResult)

Parameters

stream Stream
Stream containing construction kit model in JSON format.

locationReference String
A reference used in messages to signal the position of a file or resource

operationResult OperationResult
The result object that contains after call validation messages.

Returns

Boolean

ValidateMetaInJson(Stream, String, OperationResult)

Validates the meta data in the stream using JSON format.

bool ValidateMetaInJson(Stream stream, string locationReference, OperationResult operationResult)

Parameters

stream Stream
Stream containing construction kit model in JSON format.

locationReference String
A reference used in messages to signal the position of a file or resource

operationResult OperationResult
The result object that contains after call validation messages.

Returns

Boolean

ValidateCompiledModelInJson(Stream, String, OperationResult, Boolean)

Validates the compiled model in the stream using JSON format.

bool ValidateCompiledModelInJson(Stream stream, string locationReference, OperationResult operationResult, bool tolerantToUnknownProperties)

Parameters

stream Stream
Stream containing construction kit model in JSON format.

locationReference String
A reference used in messages to signal the position of a file or resource

operationResult OperationResult
The result object that contains after call validation messages.

tolerantToUnknownProperties Boolean
When true, `additionalProperties: false` violations are skipped. Other schema violations still fail. Use only when reading from persisted catalogs after schema changes that removed properties; do not use on the publish/compile path.

Returns

Boolean

ValidateElementsInYaml(Stream, String, OperationResult)

Validates the elements in the stream using YAML format.

bool ValidateElementsInYaml(Stream stream, string locationReference, OperationResult operationResult)

Parameters

stream Stream
Stream containing construction kit model in YAML format.

locationReference String
A reference used in messages to signal the position of a file or resource

operationResult OperationResult
The result object that contains after call validation messages.

Returns

Boolean

ValidateModelConfigInYaml(Stream, String, OperationResult)

Validates the construction kit model configuration in the stream using YAML format.

bool ValidateModelConfigInYaml(Stream stream, string locationReference, OperationResult operationResult)

Parameters

stream Stream
Stream containing construction kit model in YAML format.

locationReference String
A reference used in messages to signal the position of a file or resource

operationResult OperationResult
The result object that contains after call validation messages.

Returns

Boolean

ValidateMetaInYaml(Stream, String, OperationResult)

Validates the meta data in the stream using YAML format.

bool ValidateMetaInYaml(Stream stream, string locationReference, OperationResult operationResult)

Parameters

stream Stream
Stream containing construction kit model in YAML format.

locationReference String
A reference used in messages to signal the position of a file or resource

operationResult OperationResult
The result object that contains after call validation messages.

Returns

Boolean

ValidateCompiledModelInYaml(Stream, String, OperationResult, Boolean)

Validates the compiled model in the stream using YAML format.

bool ValidateCompiledModelInYaml(Stream stream, string locationReference, OperationResult operationResult, bool tolerantToUnknownProperties)

Parameters

stream Stream
Stream containing construction kit model in YAML format.

locationReference String
A reference used in messages to signal the position of a file or resource

operationResult OperationResult
The result object that contains after call validation messages.

tolerantToUnknownProperties Boolean
When true, `additionalProperties: false` violations are skipped. Other schema violations still fail. Use only when reading from persisted catalogs after schema changes that removed properties; do not use on the publish/compile path.

Returns

Boolean

ValidateMigrationMetaInYaml(Stream, String, OperationResult)

Validates a CK migration metadata file in YAML format.

bool ValidateMigrationMetaInYaml(Stream stream, string locationReference, OperationResult operationResult)

Parameters

stream Stream
Stream containing migration metadata in YAML format.

locationReference String
A reference used in messages to signal the position of a file or resource

operationResult OperationResult
The result object that contains after call validation messages.

Returns

Boolean

ValidateMigrationScriptInYaml(Stream, String, OperationResult)

Validates a CK migration script file in YAML format.

bool ValidateMigrationScriptInYaml(Stream stream, string locationReference, OperationResult operationResult)

Parameters

stream Stream
Stream containing migration script in YAML format.

locationReference String
A reference used in messages to signal the position of a file or resource

operationResult OperationResult
The result object that contains after call validation messages.

Returns

Boolean