schemas

type APIResponse[T any] struct {
	Success  bool     `json:"success"            yaml:"success"`
	Error    ErrorMsg `json:"error,omitempty"    yaml:"error,omitempty"`
	Response T        `json:"response,omitempty" yaml:"response,omitempty"`
}

type APIVersionResponse struct {
	Version   string `json:"version"             yaml:"version"`
	BuildTime string `json:"buildTime,omitempty" yaml:"buildTime,omitempty"`
	Commit    string `json:"commit,omitempty"    yaml:"commit,omitempty"`
}

type Crawler = UserContainerWithParameters

type Downloader = UserContainer

type EnvVar struct {
	Name  string `json:"name,omitempty"  yaml:"name,omitempty"`
	Value string `json:"value,omitempty" yaml:"value,omitempty"`
}

type ErrorMsg = string

type ExecutionID = uuid.UUID

type ParameterDefinition struct {
	// Description is the description of the parameter.
	Description string `json:"description,omitempty" yaml:"description,omitempty" description:"Description of the parameter."`
	// Required is true if the parameter is required.
	Required bool `` /* 184-byte string literal not displayed */
	// Default is the default value for the parameter.
	// It is only valid if Required is false.
	Default string `json:"default,omitempty"     yaml:"default,omitempty"`
}

type Pipeline struct {
	// ID is the unique identifier for the pipeline execution.
	ID ExecutionID `json:"ID" yaml:"ID" profile:"id" description:"The unique identifier for the pipeline execution."`

	Profile string `json:"profile" yaml:"profile" description:"The profile to use for the pipeline execution."`

	// Target represents the target that the pipeline will run against.
	Target       Target    `json:"target"       yaml:"target"       description:"The target that the pipeline will run against."`
	ScanStatus   RunStatus `json:"scanStatus"   yaml:"scanStatus"   description:"The status of the pipeline execution."`
	UploadStatus RunStatus `json:"uploadStatus" yaml:"uploadStatus" description:"The status of the upload job execution."`
}

type PipelineRequest struct {
	ProfileName string `json:"profileName" yaml:"profileName"`
	Target      Target `json:"target"      yaml:"target"`
}

type Profile struct {
	// Scanners is a list of [Scanner] that will all be run
	// in parallel, with their current working directory set to
	// the directory where the target has been downloaded to.
	Scanners []Scanner `json:"scanners"  yaml:"scanners"  description:"A list of scanners that will be run over the target."`
	// Artifacts is a list of paths to the artifacts that will be produced
	// by the scanners. These paths are relative to the results directory
	Artifacts []string `` /* 170-byte string literal not displayed */
	// Uploaders is a list of [UploaderRunRequest] that will be used to upload
	// the results of the scanners. An uploader will be passed each of the artifacts
	// as command line arguments, prefixed by the argument '--' . Each [UploaderRunRequest] must specify the
	// name of the uploader and any parameters that are required.
	Uploaders []UploaderRunRequest `` /* 331-byte string literal not displayed */
}

type ResourceName = string

type RunStatus uint8

type Scanner = UserContainer

type Schedule = string

type ScheduleRequest struct {
	CrawlerName string            `json:"crawlerName" yaml:"crawlerName"`
	Schedule    string            `json:"schedule"    yaml:"schedule"`
	Parameters  map[string]string `json:"parameters"  yaml:"parameters"`
}

type ScheduledSearch struct {
	ID          ExecutionID       `yaml:"id,omitempty"       json:"id,omitempty"         description:"The unique identifier for the scheduled search."`
	Schedule    Schedule          `` /* 141-byte string literal not displayed */
	CrawlerName string            `` /* 147-byte string literal not displayed */
	Parameters  map[string]string `yaml:"params,omitempty"   json:"parameters,omitempty" description:"The parameters to pass to the pipeline execution."`
}

type Search struct {
	CrawlerName string `json:"crawlerName"          yaml:"crawlerName"`
	// RunID is the ID of the run.
	ID ExecutionID `json:"runID"                yaml:"runID"`
	// Parameters is a map of parameter name to value.
	Parameters map[string]string `json:"parameters,omitempty" yaml:"parameters,omitempty"`
	// Status is the status of the run.
	Status RunStatus `json:"status"               yaml:"status"`
}

type SearchRequest struct {
	CrawlerName string            `json:"crawlerName" yaml:"crawlerName"`
	Parameters  map[string]string `json:"parameters"  yaml:"parameters"`
}

type Secret []byte

type SecretMountType = string

type SecretRef struct {
	Name        string          `json:"name"                  yaml:"name"                  description:"Name of the secret to reference."`
	MountType   SecretMountType `` /* 265-byte string literal not displayed */
	MountTarget string          `` /* 246-byte string literal not displayed */
	Required    bool            `` /* 175-byte string literal not displayed */
}

type Target struct {
	Downloader string `json:"downloader" yaml:"downloader"`
	Identifier string `json:"identifier" yaml:"identifier"`
	Version    string `json:"version"    yaml:"version"`
}

type Uploader = UserContainerWithParameters

type UploaderRunRequest struct {
	Name       string            `json:"name"                 yaml:"name"`
	Parameters map[string]string `json:"parameters,omitempty" yaml:"parameters,omitempty"`
}

type UserContainer struct {
	Image           string   `json:"image"                     yaml:"image"                     mapstructure:"image"`
	ImagePullPolicy string   `json:"imagePullPolicy,omitempty" yaml:"imagePullPolicy,omitempty" mapstructure:"imagePullPolicy"`
	Command         []string `json:"command,omitempty"         yaml:"command,omitempty,flow"    mapstructure:"command"`
	Args            []string `json:"args,omitempty"            yaml:"args,omitempty,flow"       mapstructure:"args"`

	Secrets []SecretRef `json:"secrets,omitempty" yaml:"secrets,omitempty"`
	Env     []EnvVar    `json:"env,omitempty"     yaml:"env,omitempty"`
}

type UserContainerWithParameters struct {
	UserContainer `                               yaml:",inline"`
	Parameters    map[string]ParameterDefinition `` /* 191-byte string literal not displayed */
}