model

type ActionEnum string

type EligibleEnum string

type Error struct {

	// Identifier code for the reason of the error
	Code string `json:"code,omitempty"`

	// Log correlation ID
	Logref string `json:"logref,omitempty"`

	// Error message
	Message string `json:"message,omitempty"`
}

type ErrorResponse struct {

	// errors
	// Max Items: 128
	Errors []*Error `json:"errors"`
}

type Group struct {

	// description
	// Example: Description of the group
	Description string `json:"description,omitempty"`

	// name
	// Example: OPEN
	// Required: true
	Name string `json:"name"`

	// A list of states belonging to this group
	// Required: true
	// Max Items: 4096
	// Min Items: 1
	States []string `json:"states"`
}

type History struct {

	// definition
	// Example: { \"userDefined\": {} }\n
	Definition map[string]interface{} `json:"definition,omitempty"`

	// Date and time (ISO8601) when the job was modified (set by wfx)
	// Read Only: true
	// Format: date-time
	Mtime strfmt.DateTime `json:"mtime,omitempty"`

	// A previous job status
	Status *JobStatus `json:"status,omitempty"`
}

type Job struct {

	// client Id
	// Example: client42
	ClientID string `json:"clientId,omitempty"`

	// definition
	// Example: { \"userDefined\": {} }\n
	Definition map[string]interface{} `json:"definition,omitempty"`

	// The job's history. Last in, first out (LIFO). Array is truncated if its length exceeds the maximum allowed length.
	// By default, the job history is omitted from responses unless explicitly requested by the client (see the `history` URL parameter).
	//
	// Max Items: 8192
	History []*History `json:"history,omitempty"`

	// Unique job ID (wfx-generated)
	// Example: 3307e5cb-074c-49b7-99d4-5e61839a4c2d
	// Read Only: true
	// Max Length: 36
	ID string `json:"id,omitempty"`

	// Date and time (ISO8601) when the job was last modified (set by wfx)
	// Read Only: true
	// Format: date-time
	Mtime *strfmt.DateTime `json:"mtime,omitempty"`

	// status
	Status *JobStatus `json:"status,omitempty"`

	// Date and time (ISO8601) when the job was created (set by wfx). Although stime conceptually always exists, it's nullable because we don't want to serialize stime in some cases (e.g. for job events).
	// Read Only: true
	// Format: date-time
	Stime *strfmt.DateTime `json:"stime,omitempty"`

	// tags
	Tags []string `json:"tags,omitempty"`

	// workflow
	Workflow *Workflow `json:"workflow,omitempty"`
}

type JobRequest struct {

	// Create job for the given client ID
	// Example: client42
	// Required: true
	ClientID string `json:"clientId"`

	// The existing job definition will be replaced with this if this property is not empty.
	// Example: { \"userDefined\": {} }\n
	Definition map[string]interface{} `json:"definition,omitempty"`

	// tags
	// Max Items: 16
	Tags []string `json:"tags"`

	// Workflow name
	// Example: wfx.workflow.dau.direct
	// Required: true
	Workflow string `json:"workflow"`
}

type JobStatus struct {

	// Client which sent the status update
	// Example: client42
	ClientID string `json:"clientId,omitempty"`

	// Client-specific JSON object to report additional context information such as error details, stack traces, etc
	// Example: {\n  \"lines\": [ \"line1\", \"line2\" ]\n}\n
	Context map[string]interface{} `json:"context,omitempty"`

	// Job definition hash
	// Read Only: true
	// Max Length: 64
	DefinitionHash string `json:"definitionHash,omitempty"`

	// Reason message/info, free text from client
	// Max Length: 1024
	Message string `json:"message,omitempty"`

	// Current job progress percentage
	// Maximum: 100
	Progress int32 `json:"progress,omitempty"`

	// Name of the new workflow state
	// Example: END
	// Required: true
	State string `json:"state"`
}

type PaginatedJobList struct {

	// content
	Content []*Job `json:"content"`

	// pagination
	Pagination *PaginatedJobListPagination `json:"pagination,omitempty"`
}

type PaginatedJobListPagination struct {

	// the maximum number of items to return
	// Example: 20
	Limit int32 `json:"limit,omitempty"`

	// the number of items to skip before starting to return results
	// Example: 0
	Offset int64 `json:"offset,omitempty"`

	// the total number of items
	// Example: 1000
	Total int64 `json:"total,omitempty"`
}

type PaginatedWorkflowList struct {

	// content
	Content []*Workflow `json:"content"`

	// pagination
	Pagination *PaginatedWorkflowListPagination `json:"pagination,omitempty"`
}

type PaginatedWorkflowListPagination struct {

	// the maximum number of items to return
	// Example: 20
	Limit int32 `json:"limit,omitempty"`

	// the number of items to skip before starting to return results
	// Example: 0
	Offset int64 `json:"offset,omitempty"`

	// the total number of items
	// Example: 1000
	Total int64 `json:"total,omitempty"`
}

type State struct {

	// description
	// Example: Description of the state
	Description string `json:"description,omitempty"`

	// name
	// Example: START
	// Required: true
	Name string `json:"name"`
}

type Transition struct {

	// The transition execution action (default: WAIT)
	// Example: WAIT
	Action ActionEnum `json:"action,omitempty"`

	// description
	// Example: Description of the transition
	Description string `json:"description,omitempty"`

	// The entity that may execute the transition
	// Example: CLIENT
	// Required: true
	Eligible EligibleEnum `json:"eligible"`

	// from
	// Example: START
	// Required: true
	From string `json:"from"`

	// to
	// Example: END
	// Required: true
	To string `json:"to"`
}

type Workflow struct {

	// Description of the workflow
	// Example: This is a workflow
	// Max Length: 1024
	Description string `json:"description,omitempty"`

	// groups
	// Max Items: 1024
	Groups []*Group `json:"groups,omitempty"`

	// User provided unique workflow name
	// Example: wfx.workflow.dau.direct
	// Required: true
	// Max Length: 64
	// Min Length: 1
	// Pattern: ^[a-zA-Z0-9\-\.]+$
	Name string `json:"name"`

	// states
	// Max Items: 4096
	States []*State `json:"states,omitempty"`

	// transitions
	// Max Items: 16384
	Transitions []*Transition `json:"transitions,omitempty"`
}