package api

// DetectionResult indicates the result of an analysis against a given project.
// Analysis might be performed via the Alizer backend or non-interactively via the Flags backend.
// It contains detection analysis information such as the location of a devfile,
// either in a devfile registry or using a path or a URI or the application ports if any.
type DetectionResult struct {
	// name of the Devfile in Devfile registry (required if DevfilePath is not defined)
	Devfile string `json:"devfile,omitempty"`

	// name of the devfile registry (as configured in odo registry). It can be used in combination with Devfile, but not with DevfilePath (optional)
	DevfileRegistry string `json:"devfileRegistry,omitempty"`

	// path to a devfile. This is alternative to using devfile from Devfile registry. It can be local filesystem path or http(s) URL (required if Devfile is not defined)
	DevfilePath string `json:"devfilePath,omitempty"`

	// ApplicationPorts represents the list of ports detected
	ApplicationPorts []int  `json:"ports,omitempty"`
	DevfileVersion   string `json:"devfileVersion,omitempty"`
	// Name represents the project/application name as detected by alizer
	Name string `json:"name,omitempty"`
	// Architectures represent the architectures with which the Devfile must be compatible with.
	Architectures []string `json:"architectures,omitempty"`
}