apimodels

type AuthnRequest struct {
	BaseRequest
	Name       string
	MethodData []byte
}

type AuthnResponse struct {
	BaseResponse
	Authentication authn.Authentication
}

type BaseGetRequest struct {
	BaseRequest
}

type BaseGetResponse struct {
	BaseResponse `json:",omitempty,inline" yaml:",omitempty,inline"`
}

type BaseListRequest struct {
	BaseGetRequest
	Limit     uint32 `query:"limit"`
	NextToken string `query:"next_token"`
	OrderBy   string `query:"order_by"`
	Reverse   bool   `query:"reverse"`
}

type BaseListResponse struct {
	BaseGetResponse `json:",omitempty,inline" yaml:",omitempty,inline"`
	NextToken       string
}

type BasePostRequest struct {
	BaseRequest
	IdempotencyToken string `query:"idempotency_token"`
}

type BasePostResponse struct {
	BaseResponse `json:",omitempty,inline" yaml:",omitempty,inline"`
}

type BasePutRequest struct {
	BaseRequest
	IdempotencyToken string `query:"idempotency_token"`
}

type BasePutResponse struct {
	BaseResponse `json:",omitempty,inline" yaml:",omitempty,inline"`
}

type BaseRequest struct {
	Namespace  string            `query:"namespace"`
	Headers    map[string]string `query:"-" json:"-"`
	Credential *HTTPCredential   `header:"Authorization"`
}

type BaseResponse struct {
}

type GetAgentNodeRequest struct {
	BaseGetRequest
}

type GetAgentNodeResponse struct {
	BaseGetResponse
	*models.NodeInfo
}

type GetJobRequest struct {
	BaseGetRequest
	JobID   string
	Include string `query:"include" validate:"omitempty,oneof=history executions"`
	Limit   uint32 `query:"limit"`
}

type GetJobResponse struct {
	BaseGetResponse
	Job        *models.Job                `json:"Job"`
	History    *ListJobHistoryResponse    `json:"History,omitempty"`
	Executions *ListJobExecutionsResponse `json:"Executions,omitempty"`
}

type GetLogsRequest struct {
	BaseGetRequest
	JobID       string `query:"-"`
	ExecutionID string `query:"execution_id" validate:"omitempty"`
	Tail        bool   `query:"tail"`
	Follow      bool   `query:"follow"`
}

type GetNodeRequest struct {
	BaseGetRequest
	NodeID string
}

type GetNodeResponse struct {
	BaseGetResponse
	Node *models.NodeInfo
}

type GetRequest interface {
	Request
}

type GetResponse interface {
	Response
}

type GetVersionResponse struct {
	BaseGetResponse
	*models.BuildVersionInfo
}

type HTTPCredential struct {
	// An HTTP authorization scheme, such as one registered with IANA
	// https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml
	Scheme string

	// For authorization schemes that only provide a single value, such as
	// Basic, the single string value providing the credential
	Value string

	// For authorization schemes that provide multiple values, a map of names to
	// values providing the credential
	Params map[string]string
}

type HTTPRequest struct {
	Params  url.Values
	Body    io.Reader
	BodyObj interface{}
	Ctx     context.Context
	Header  http.Header
}

type IsAliveResponse struct {
	BaseGetResponse `json:",omitempty,inline" yaml:",omitempty,inline"`
	Status          string
}

type ListAuthnMethodsRequest struct {
	BaseListRequest
}

type ListAuthnMethodsResponse struct {
	BaseListResponse
	Methods map[string]authn.Requirement
}

type ListJobExecutionsRequest struct {
	BaseListRequest
	JobID string `query:"-"`
}

type ListJobExecutionsResponse struct {
	BaseListResponse
	Executions []*models.Execution
}

type ListJobHistoryRequest struct {
	BaseListRequest
	JobID       string `query:"-"`
	Since       int64  `query:"since" validate:"min=0"`
	EventType   string `query:"event_type" validate:"omitempty,oneof=all job execution"`
	ExecutionID string `query:"execution_id" validate:"omitempty"`
	NodeID      string `query:"node_id" validate:"omitempty"`
}

type ListJobHistoryResponse struct {
	BaseListResponse
	History []*models.JobHistory
}

type ListJobResultsRequest struct {
	BaseListRequest
	JobID string `query:"-"`
}

type ListJobResultsResponse struct {
	BaseListResponse
	Results []*models.SpecConfig
}

type ListJobsRequest struct {
	BaseListRequest
	Labels []labels.Requirement `query:"-"` // don't auto bind as it requires special handling
}

type ListJobsResponse struct {
	BaseListResponse
	Jobs []*models.Job `json:"Jobs"`
}

type ListNodesRequest struct {
	BaseListRequest
	Labels         []labels.Requirement `query:"-"` // don't auto bind as it requires special handling
	FilterByStatus string               `query:"filter-status"`
}

type ListNodesResponse struct {
	BaseListResponse
	Nodes []*models.NodeInfo
}

type ListRequest interface {
	GetRequest
}

type ListResponse interface {
	GetResponse

	// GetNextToken is the token used to indicate where to start paging
	// for queries that support paginated lists. To resume paging from
	// this point, pass this token in the next request
	GetNextToken() string
}

type NodeAction string

type PostRequest interface {
	Request
}

type PostResponse interface {
	Response
}

type PutJobRequest struct {
	BasePutRequest
	Job *models.Job `json:"Job"`
}

type PutJobResponse struct {
	BasePutResponse
	JobID        string   `json:"JobID"`
	EvaluationID string   `json:"EvaluationID"`
	Warnings     []string `json:"Warnings"`
}

type PutNodeRequest struct {
	BasePutRequest
	Action  string
	Message string
	NodeID  string
}

type PutNodeResponse struct {
	BasePutResponse
	Success bool
	Error   string
}

type PutRequest interface {
	Request
}

type PutResponse interface {
	Response
}

type Request interface {
	// SetCredential is used to set the authorization token for the request
	SetCredential(*HTTPCredential)
	// ToHTTPRequest is used to convert the request to an HTTP request
	ToHTTPRequest() *HTTPRequest
}

type Response interface {
	// Normalize normalizes the response
	Normalize()
}

type StopJobRequest struct {
	BasePutRequest
	JobID  string `json:"-"`
	Reason string `json:"reason"`
}

type StopJobResponse struct {
	BasePutResponse
	EvaluationID string `json:"EvaluationID"`
}