schema

Documentation

Index

• Constants
• func EmbeddedBytes(ref SchemaRef) ([]byte, error)
• func EmbeddedSchema() []byte
• func EmbeddedSchemaDigest() string
• func EmbeddedSnapshotSchema() []byte
• func EmbeddedSnapshotSchemaDigest() string
• func ResolveContractLine(version string) (SchemaRef, SchemaRef, error)
• func SupportedContractVersions() []string
• func ValidateArtifactJSON(raw []byte) error
• func ValidateJSON(raw []byte) error
• func ValidateJSONVersion(raw []byte, version string) error
• func ValidateSnapshotJSON(raw []byte) error
• func ValidateSnapshotJSONVersion(raw []byte, version string) error
• func ValidateSnapshotStrict(ref SchemaRef) error
• func ValidateStrict(ref SchemaRef) error
• type PublishedContract
  • func LookupContract(name, version string) (PublishedContract, bool)
  • func PublishedContracts() []PublishedContract
• type SchemaRef
  • func ExpectedRef() SchemaRef
  • func ExpectedSnapshotRef() SchemaRef
  • func ExtractSchemaRef(raw []byte) (SchemaRef, error)
  • func ModelRef(version string) (SchemaRef, bool)
  • func SnapshotRef(version string) (SchemaRef, bool)

Constants

const (
	ModelContractName    = "io.mb3r.bering.model"
	SnapshotContractName = "io.mb3r.bering.snapshot"

	ContractVersionV1_0_0 = "1.0.0"
	ContractVersionV1_1_0 = "1.1.0"
	LatestContractVersion = ContractVersionV1_1_0

	ExpectedSchemaName    = ModelContractName
	ExpectedSchemaVersion = LatestContractVersion
	ExpectedSchemaURI     = "https://mb3r-lab.github.io/Bering/schema/model/v1.1.0/model.schema.json"
	ExpectedSchemaDigest  = "sha256:bc9a60736c9e6bda9599243fd68f293b88f42ade65321d8267369a5c3214779a"

	ExpectedSnapshotSchemaName    = SnapshotContractName
	ExpectedSnapshotSchemaVersion = LatestContractVersion
	ExpectedSnapshotSchemaURI     = "https://mb3r-lab.github.io/Bering/schema/snapshot/v1.1.0/snapshot.schema.json"
	ExpectedSnapshotSchemaDigest  = "sha256:53b127608b2aaa4fabb352b998cd6b2c5ed558764729a09abea56f4f9b40fa01"
)

Functions

func EmbeddedBytes

func EmbeddedBytes(ref SchemaRef) ([]byte, error)

func EmbeddedSchema

func EmbeddedSchema() []byte

func EmbeddedSchemaDigest

func EmbeddedSchemaDigest() string

func EmbeddedSnapshotSchema

func EmbeddedSnapshotSchema() []byte

func EmbeddedSnapshotSchemaDigest

func EmbeddedSnapshotSchemaDigest() string

func ResolveContractLine

func ResolveContractLine(version string) (SchemaRef, SchemaRef, error)

func SupportedContractVersions

func SupportedContractVersions() []string

func ValidateArtifactJSON

func ValidateArtifactJSON(raw []byte) error

func ValidateJSON

func ValidateJSON(raw []byte) error

func ValidateJSONVersion

func ValidateJSONVersion(raw []byte, version string) error

func ValidateSnapshotJSON

func ValidateSnapshotJSON(raw []byte) error

func ValidateSnapshotJSONVersion

func ValidateSnapshotJSONVersion(raw []byte, version string) error

func ValidateSnapshotStrict

func ValidateSnapshotStrict(ref SchemaRef) error

func ValidateStrict

func ValidateStrict(ref SchemaRef) error

Types

type PublishedContract

type PublishedContract struct {
	Ref          SchemaRef
	Artifact     string
	APIPath      string
	EmbeddedPath string
}

func LookupContract

func LookupContract(name, version string) (PublishedContract, bool)

func PublishedContracts

func PublishedContracts() []PublishedContract

type SchemaRef

type SchemaRef struct {
	Name    string `json:"name"`
	Version string `json:"version"`
	URI     string `json:"uri"`
	Digest  string `json:"digest"`
}

func ExpectedRef

func ExpectedRef() SchemaRef

func ExpectedSnapshotRef

func ExpectedSnapshotRef() SchemaRef

func ExtractSchemaRef

func ExtractSchemaRef(raw []byte) (SchemaRef, error)

func ModelRef

func ModelRef(version string) (SchemaRef, bool)

func SnapshotRef

func SnapshotRef(version string) (SchemaRef, bool)