validator

Documentation

Index

• func ValidateJSONLD(doc string, options ...ValidateOpts) error
• func ValidateJSONLDMap(docMap map[string]interface{}, options ...ValidateOpts) error
• func ValidateJSONLDTypes(docMap map[string]interface{}, options ...ValidateOpts) error
• type Diff
• type ValidateOpts
  • func WithDocumentLoader(jsonldDocumentLoader ld.DocumentLoader) ValidateOpts
  • func WithExternalContext(externalContext []string) ValidateOpts
  • func WithJSONLDIncludeDetailedStructureDiffOnError() ValidateOpts
  • func WithStrictContextURIPosition(uri string) ValidateOpts
  • func WithStrictValidation(checkStructure bool) ValidateOpts

Functions

func ValidateJSONLD

func ValidateJSONLD(doc string, options ...ValidateOpts) error

ValidateJSONLD validates jsonld structure.

func ValidateJSONLDMap

func ValidateJSONLDMap(
	docMap map[string]interface{},
	options ...ValidateOpts,
) error

ValidateJSONLDMap validates jsonld structure.

func ValidateJSONLDTypes

func ValidateJSONLDTypes(
	docMap map[string]interface{},
	options ...ValidateOpts,
) error

ValidateJSONLDTypes validates JSON-LD types.

Types

type Diff

type Diff struct {
	OriginalValue  interface{}
	CompactedValue interface{}
}

Diff represents the difference between two objects.

type ValidateOpts

type ValidateOpts func(opts *validateOpts)

ValidateOpts sets jsonld validation options.

func WithDocumentLoader

func WithDocumentLoader(jsonldDocumentLoader ld.DocumentLoader) ValidateOpts

WithDocumentLoader option is for passing custom JSON-LD document loader.

func WithExternalContext

func WithExternalContext(externalContext []string) ValidateOpts

WithExternalContext option is for definition of external context when doing JSON-LD operations.

func WithJSONLDIncludeDetailedStructureDiffOnError

func WithJSONLDIncludeDetailedStructureDiffOnError() ValidateOpts

WithJSONLDIncludeDetailedStructureDiffOnError option is for including detailed structure diff in error message.

func WithStrictContextURIPosition

func WithStrictContextURIPosition(uri string) ValidateOpts

WithStrictContextURIPosition sets strict validation of URI position within context property. The index of uri in underlying slice represents the position of given uri in @context array. Can be used for verifiable credential base context validation.

func WithStrictValidation

func WithStrictValidation(checkStructure bool) ValidateOpts

WithStrictValidation sets if strict validation should be used.