bundle

type Action struct {
	// Modifies indicates whether this action modifies the release.
	//
	// If it is possible that an action modify a release, this must be set to true.
	Modifies bool `json:"modifies,omitempty" mapstructure:"modifies"`
	// Stateless indicates that the action is purely informational, that credentials are not required, and that the runtime should not keep track of its invocation
	Stateless bool `json:"stateless,omitempty" mapstructure:"stateless"`
	// Description describes the action as a user-readable string
	Description string `json:"description,omitempty" mapstructure:"description"`
}

type BaseImage struct {
	ImageType string         `json:"imageType" mapstructure:"imageType"`
	Image     string         `json:"image" mapstructure:"image"`
	Digest    string         `json:"digest,omitempty" mapstructure:"digest"`
	Size      uint64         `json:"size,omitempty" mapstructure:"size"`
	Platform  *ImagePlatform `json:"platform,omitempty" mapstructure:"platform"`
	MediaType string         `json:"mediaType,omitempty" mapstructure:"mediaType"`
}

type Bundle struct {
	SchemaVersion    string                 `json:"schemaVersion" mapstructure:"schemaVersion"`
	Name             string                 `json:"name" mapstructure:"name"`
	Version          string                 `json:"version" mapstructure:"version"`
	Description      string                 `json:"description" mapstructure:"description"`
	Keywords         []string               `json:"keywords,omitempty" mapstructure:"keywords"`
	Maintainers      []Maintainer           `json:"maintainers,omitempty" mapstructure:"maintainers"`
	InvocationImages []InvocationImage      `json:"invocationImages" mapstructure:"invocationImages"`
	Images           map[string]Image       `json:"images,omitempty" mapstructure:"images"`
	Actions          map[string]Action      `json:"actions,omitempty" mapstructure:"actions"`
	Parameters       *ParametersDefinition  `json:"parameters,omitempty" mapstructure:"parameters"`
	Credentials      map[string]Credential  `json:"credentials,omitempty" mapstructure:"credentials"`
	Outputs          *OutputsDefinition     `json:"outputs,omitempty" mapstructure:"outputs"`
	Definitions      definition.Definitions `json:"definitions,omitempty" mapstructure:"definitions"`

	// Custom extension metadata is a named collection of auxiliary data whose
	// meaning is defined outside of the CNAB specification.
	Custom map[string]interface{} `json:"custom,omitempty" mapstructure:"custom"`
}

type Credential struct {
	Location    `mapstructure:",squash"`
	Description string `json:"description,omitempty" mapstructure:"description"`
	Required    bool   `json:"required,omitempty" mapstructure:"required"`
}

type Image struct {
	BaseImage   `mapstructure:",squash"`
	Description string `json:"description" mapstructure:"description"` //TODO: change? see where it's being used? change to description?
}

type ImagePlatform struct {
	Architecture string `json:"architecture,omitempty" mapstructure:"architecture"`
	OS           string `json:"os,omitempty" mapstructure:"os"`
}

type InvocationImage struct {
	BaseImage `mapstructure:",squash"`
}

type Location struct {
	Path                string `json:"path,omitempty" mapstructure:"path"`
	EnvironmentVariable string `json:"env,omitempty" mapstructure:"env"`
}

type LocationRef struct {
	Path      string `json:"path" mapstructure:"path"`
	Field     string `json:"field" mapstructure:"field"`
	MediaType string `json:"mediaType" mapstructure:"mediaType"`
}

type Maintainer struct {
	// Name is a user name or organization name
	Name string `json:"name" mapstructure:"name"`
	// Email is an optional email address to contact the named maintainer
	Email string `json:"email,omitempty" mapstructure:"email"`
	// Url is an optional URL to an address for the named maintainer
	URL string `json:"url,omitempty" mapstructure:"url"`
}

type OutputDefinition struct {
	Definition  string   `json:"definition" mapstructure:"definition"`
	ApplyTo     []string `json:"applyTo,omitempty" mapstructure:"applyTo,omitempty"`
	Description string   `json:"description,omitempty" mapstructure:"description"`
	Path        string   `json:"path,omitemtpty" mapstructure:"path,omitempty"`
}

type OutputsDefinition struct {
	Fields map[string]OutputDefinition `json:"fields" mapstructure:"fields"`
}

type ParameterDefinition struct {
	Definition  string    `json:"definition" mapstructure:"definition"`
	ApplyTo     []string  `json:"applyTo,omitempty" mapstructure:"applyTo,omitempty"`
	Description string    `json:"description,omitempty" mapstructure:"description"`
	Destination *Location `json:"destination,omitemtpty" mapstructure:"destination"`
}

type ParametersDefinition struct {
	Fields   map[string]ParameterDefinition `json:"fields" mapstructure:"fields"`
	Required []string                       `json:"required,omitempty" mapstructure:"required,omitempty"`
}