head

type CorrectionOptions struct {
	Head *Header `json:"-"` // copy of the original document header
}

type Header struct {
	// Unique UUIDv1 identifier for the envelope.
	UUID uuid.UUID `json:"uuid" jsonschema:"title=UUID"`

	// Digest of the canonical JSON body.
	Digest *dsig.Digest `json:"dig" jsonschema:"title=Digest"`

	// Seals of approval from other organisations that can only be added to
	// non-draft envelopes.
	Stamps []*Stamp `json:"stamps,omitempty" jsonschema:"title=Stamps"`

	// Links provide URLs to other resources that are related to this envelope
	// and unlike stamps can be added even in the draft state.
	Links []*Link `json:"links,omitempty" jsonschema:"title=Links"`

	// Set of labels that describe but have no influence on the data.
	Tags []string `json:"tags,omitempty" jsonschema:"title=Tags"`

	// Additional semi-structured information about this envelope.
	Meta cbc.Meta `json:"meta,omitempty" jsonschema:"title=Meta"`

	// Any information that may be relevant to other humans about this envelope
	Notes string `json:"notes,omitempty" jsonschema:"title=Notes"`
}

type Link struct {
	uuid.Identify
	// Category helps classify the link according to a fixed list. This is optional
	// but highly recommended as it helps receivers better understand the purpose
	// of the link and potentially how it should be presented.
	Category cbc.Key `json:"category,omitempty" jsonschema:"title=Category"`
	// Key is a unique identifier for the link within the header and category
	// if provided.
	Key cbc.Key `json:"key"`
	// Code used to identify the contents of the link.
	Code cbc.Code `json:"code,omitempty" jsonschema:"title=Code"`
	// Title of the resource to use when presenting to users.
	Title string `json:"title,omitempty" jsonschema:"title=Title"`
	// Description of the resource to use when presenting to users.
	Description string `json:"description,omitempty" jsonschema:"title=Description"`
	// Expected MIME type of the link's content when the content is a file. Can only
	// be one of the allowed types defined by EN 16931-1:2017 plus XML itself.
	MIME string `json:"mime,omitempty" jsonschema:"title=MIME Type,format=mime"`
	// Digest is used to verify the integrity of the destination document
	// when downloaded from the URL.
	Digest *dsig.Digest `json:"digest,omitempty" jsonschema:"title=Digest"`
	// URL of the resource.
	URL string `json:"url" jsonschema:"title=URL,format=uri"`
	// Meta contains additional metadata about the link.
	Meta cbc.Meta `json:"meta,omitempty" jsonschema:"title=Metadata"`
}

type Stamp struct {
	// Identity of the agency used to create the stamp usually defined by each region.
	Provider cbc.Key `json:"prv" jsonschema:"title=Provider"`
	// The serialized stamp value generated for or by the external agency
	Value string `json:"val" jsonschema:"title=Value"`
}

type StampsHasRule struct {
	// contains filtered or unexported fields
}