Skip to main content

IBlueprintSchemaValidator

Namespace: Meshmakers.Octo.ConstructionKit.Contracts.BlueprintCatalogs.Serialization

Interface for schema validation of blueprint models

public interface IBlueprintSchemaValidator

Methods​

ValidateMetaInJson(Stream, String, OperationResult)​

Validates the blueprint metadata in the stream using JSON format.

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

Parameters​

stream Stream
Stream containing blueprint metadata 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
True if valid, false otherwise

ValidateMetaInYaml(Stream, String, OperationResult)​

Validates the blueprint metadata in the stream using YAML format.

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

Parameters​

stream Stream
Stream containing blueprint 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
True if valid, false otherwise

ValidateCatalogIndexInJson(Stream, String, OperationResult)​

Validates the blueprint catalog index in the stream using JSON format.

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

Parameters​

stream Stream
Stream containing catalog index 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
True if valid, false otherwise

ValidateLibraryVersionsInJson(Stream, String, OperationResult)​

Validates the blueprint library versions in the stream using JSON format.

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

Parameters​

stream Stream
Stream containing library versions 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
True if valid, false otherwise

ValidateCacheInJson(Stream, String, OperationResult)​

Validates the embedded-blueprint cache (produced by the BlueprintEmbed MSBuild task and consumed by the BlueprintSourceGenerator) using JSON format.

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

Parameters​

stream Stream
Stream containing the cache JSON.

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
True if valid, false otherwise.