schema

Documentation

Index

• type ValidationError
  • func Validate(schemaType string, bytes []byte) ([]ValidationError, error)
  • func ValidateBundle(bytes []byte) ([]ValidationError, error)
  • func ValidateClaim(bytes []byte) ([]ValidationError, error)
• type Version
  • func GetSemver(schemaVersion string) (Version, error)
  • func (v Version) Validate() error

Types

type ValidationError

type ValidationError error

ValidationError is a validation error as defined by this package As of now, it simply equates to a stock Golang error

func Validate

func Validate(schemaType string, bytes []byte) ([]ValidationError, error)

Validate validates the provided bytes against the provided CNAB-Spec schemaType

func ValidateBundle

func ValidateBundle(bytes []byte) ([]ValidationError, error)

ValidateBundle validates the provided bundle bytes against the applicable CNAB-Spec schema

func ValidateClaim

func ValidateClaim(bytes []byte) ([]ValidationError, error)

ValidateClaim validates the provided claim bytes against the applicable CNAB-Spec schema

type Version

type Version string

Version represents the schema version of an object

func GetSemver

func GetSemver(schemaVersion string) (Version, error)

GetSemver returns a proper semver Version from the provided string, trimming the non-semver prefix according to schema versioning protocol in the cnabio/cnab-spec repo

func (Version) Validate

func (v Version) Validate() error

Validate the provided schema version is present and adheres to semantic versioning