Documentation
¶
Overview ¶
Package openapi provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen/v2 version v2.1.0 DO NOT EDIT.
Index ¶
- type Artifact
- type CancelRequest
- type FieldType
- type FieldValidation
- type FormContext
- type FormField
- type FormResponse
- type GlobPattern
- type InputFormConfig
- type InputSSECancelledData
- type InputSSEConnectedData
- type InputSSEErrorData
- type InputSSEEvent
- type InputSSEEventType
- type InputSSEEvent_Data
- func (t InputSSEEvent_Data) AsInputSSECancelledData() (InputSSECancelledData, error)
- func (t InputSSEEvent_Data) AsInputSSEConnectedData() (InputSSEConnectedData, error)
- func (t InputSSEEvent_Data) AsInputSSEErrorData() (InputSSEErrorData, error)
- func (t InputSSEEvent_Data) AsInputSSEHeartbeatData() (InputSSEHeartbeatData, error)
- func (t InputSSEEvent_Data) AsInputSSEPendingData() (InputSSEPendingData, error)
- func (t *InputSSEEvent_Data) FromInputSSECancelledData(v InputSSECancelledData) error
- func (t *InputSSEEvent_Data) FromInputSSEConnectedData(v InputSSEConnectedData) error
- func (t *InputSSEEvent_Data) FromInputSSEErrorData(v InputSSEErrorData) error
- func (t *InputSSEEvent_Data) FromInputSSEHeartbeatData(v InputSSEHeartbeatData) error
- func (t *InputSSEEvent_Data) FromInputSSEPendingData(v InputSSEPendingData) error
- func (t InputSSEEvent_Data) MarshalJSON() ([]byte, error)
- func (t *InputSSEEvent_Data) MergeInputSSECancelledData(v InputSSECancelledData) error
- func (t *InputSSEEvent_Data) MergeInputSSEConnectedData(v InputSSEConnectedData) error
- func (t *InputSSEEvent_Data) MergeInputSSEErrorData(v InputSSEErrorData) error
- func (t *InputSSEEvent_Data) MergeInputSSEHeartbeatData(v InputSSEHeartbeatData) error
- func (t *InputSSEEvent_Data) MergeInputSSEPendingData(v InputSSEPendingData) error
- func (t *InputSSEEvent_Data) UnmarshalJSON(b []byte) error
- type InputSSEHeartbeatData
- type InputSSEPendingData
- type LinearScale
- type OkResponse
- type Option
- type PendingInput
- type PostApiProjectsProjectIdUserInputsJobIdCancelJSONRequestBody
- type PostApiProjectsProjectIdUserInputsJobIdRespondJSONRequestBody
- type UserInputDetails
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Artifact ¶
type Artifact struct {
Path string `json:"path"`
}
Artifact defines model for Artifact.
type CancelRequest ¶
type CancelRequest struct {
// Reason Human-readable cancellation reason
Reason *string `json:"reason,omitempty"`
}
CancelRequest defines model for CancelRequest.
type FieldType ¶
type FieldType string
FieldType defines model for FieldType.
const ( FieldTypeCheckboxGrid FieldType = "checkbox_grid" FieldTypeCheckboxes FieldType = "checkboxes" FieldTypeDate FieldType = "date" FieldTypeDropdown FieldType = "dropdown" FieldTypeFileUpload FieldType = "file_upload" FieldTypeLinearScale FieldType = "linear_scale" FieldTypeMultipleChoice FieldType = "multiple_choice" FieldTypeMultipleChoiceGrid FieldType = "multiple_choice_grid" FieldTypeParagraphText FieldType = "paragraph_text" FieldTypeShortAnswer FieldType = "short_answer" FieldTypeTime FieldType = "time" )
Defines values for FieldType.
type FieldValidation ¶
type FieldValidation struct {
Max *int `json:"max,omitempty"`
MaxLength *int `json:"max_length,omitempty"`
Min *int `json:"min,omitempty"`
MinLength *int `json:"min_length,omitempty"`
Pattern *string `json:"pattern,omitempty"`
}
FieldValidation defines model for FieldValidation.
type FormContext ¶
type FormContext struct {
Artifacts *[]Artifact `json:"artifacts,omitempty"`
ArtifactsFromOutput *string `json:"artifacts_from_output,omitempty"`
ArtifactsGlob *[]GlobPattern `json:"artifacts_glob,omitempty"`
}
FormContext defines model for FormContext.
type FormField ¶
type FormField struct {
Id string `json:"id"`
Options *[]Option `json:"options,omitempty"`
Placeholder *string `json:"placeholder,omitempty"`
Question string `json:"question"`
Required *bool `json:"required,omitempty"`
Scale *LinearScale `json:"scale,omitempty"`
Type FieldType `json:"type"`
Validation *FieldValidation `json:"validation,omitempty"`
}
FormField defines model for FormField.
type FormResponse ¶
type FormResponse struct {
ActivityId *string `json:"activity_id,omitempty"`
// Fields Field responses for multi-field forms
Fields map[string]interface{} `json:"fields"`
Hash *string `json:"hash,omitempty"`
// Response Single-question response value
Response *interface{} `json:"response,omitempty"`
SubmittedAt *time.Time `json:"submitted_at,omitempty"`
TimeToComplete *int `json:"time_to_complete,omitempty"`
UserId *string `json:"user_id,omitempty"`
}
FormResponse defines model for FormResponse.
type GlobPattern ¶
type GlobPattern struct {
Pattern string `json:"pattern"`
}
GlobPattern defines model for GlobPattern.
type InputFormConfig ¶
type InputFormConfig struct {
Context *FormContext `json:"context,omitempty"`
// DefaultOnTimeout Default value to return if input times out
DefaultOnTimeout *interface{} `json:"default_on_timeout,omitempty"`
Fields *[]FormField `json:"fields,omitempty"`
Options *[]Option `json:"options,omitempty"`
Question *string `json:"question,omitempty"`
Scale *LinearScale `json:"scale,omitempty"`
// Timeout Timeout in seconds
Timeout *int `json:"timeout,omitempty"`
Title *string `json:"title,omitempty"`
Type *FieldType `json:"type,omitempty"`
}
InputFormConfig Configuration for a single- or multi-question input form.
type InputSSECancelledData ¶
type InputSSECancelledData struct {
JobId string `json:"jobId"`
Reason *string `json:"reason,omitempty"`
}
InputSSECancelledData defines model for InputSSECancelledData.
type InputSSEConnectedData ¶
type InputSSEConnectedData struct {
ClientId string `json:"client_id"`
}
InputSSEConnectedData defines model for InputSSEConnectedData.
type InputSSEErrorData ¶
type InputSSEErrorData struct {
Error string `json:"error"`
}
InputSSEErrorData defines model for InputSSEErrorData.
type InputSSEEvent ¶
type InputSSEEvent struct {
Data InputSSEEvent_Data `json:"data"`
// Type Input SSE event type emitted by /api/projects/{projectId}/user-inputs/stream.
Type InputSSEEventType `json:"type"`
}
InputSSEEvent Event envelope emitted by /api/projects/{projectId}/user-inputs/stream.
type InputSSEEventType ¶
type InputSSEEventType string
InputSSEEventType Input SSE event type emitted by /api/projects/{projectId}/user-inputs/stream.
const ( Connected InputSSEEventType = "connected" Error InputSSEEventType = "error" Heartbeat InputSSEEventType = "heartbeat" InputCancelled InputSSEEventType = "input_cancelled" InputPending InputSSEEventType = "input_pending" )
Defines values for InputSSEEventType.
type InputSSEEvent_Data ¶
type InputSSEEvent_Data struct {
// contains filtered or unexported fields
}
InputSSEEvent_Data defines model for InputSSEEvent.Data.
func (InputSSEEvent_Data) AsInputSSECancelledData ¶
func (t InputSSEEvent_Data) AsInputSSECancelledData() (InputSSECancelledData, error)
AsInputSSECancelledData returns the union data inside the InputSSEEvent_Data as a InputSSECancelledData
func (InputSSEEvent_Data) AsInputSSEConnectedData ¶
func (t InputSSEEvent_Data) AsInputSSEConnectedData() (InputSSEConnectedData, error)
AsInputSSEConnectedData returns the union data inside the InputSSEEvent_Data as a InputSSEConnectedData
func (InputSSEEvent_Data) AsInputSSEErrorData ¶
func (t InputSSEEvent_Data) AsInputSSEErrorData() (InputSSEErrorData, error)
AsInputSSEErrorData returns the union data inside the InputSSEEvent_Data as a InputSSEErrorData
func (InputSSEEvent_Data) AsInputSSEHeartbeatData ¶
func (t InputSSEEvent_Data) AsInputSSEHeartbeatData() (InputSSEHeartbeatData, error)
AsInputSSEHeartbeatData returns the union data inside the InputSSEEvent_Data as a InputSSEHeartbeatData
func (InputSSEEvent_Data) AsInputSSEPendingData ¶
func (t InputSSEEvent_Data) AsInputSSEPendingData() (InputSSEPendingData, error)
AsInputSSEPendingData returns the union data inside the InputSSEEvent_Data as a InputSSEPendingData
func (*InputSSEEvent_Data) FromInputSSECancelledData ¶
func (t *InputSSEEvent_Data) FromInputSSECancelledData(v InputSSECancelledData) error
FromInputSSECancelledData overwrites any union data inside the InputSSEEvent_Data as the provided InputSSECancelledData
func (*InputSSEEvent_Data) FromInputSSEConnectedData ¶
func (t *InputSSEEvent_Data) FromInputSSEConnectedData(v InputSSEConnectedData) error
FromInputSSEConnectedData overwrites any union data inside the InputSSEEvent_Data as the provided InputSSEConnectedData
func (*InputSSEEvent_Data) FromInputSSEErrorData ¶
func (t *InputSSEEvent_Data) FromInputSSEErrorData(v InputSSEErrorData) error
FromInputSSEErrorData overwrites any union data inside the InputSSEEvent_Data as the provided InputSSEErrorData
func (*InputSSEEvent_Data) FromInputSSEHeartbeatData ¶
func (t *InputSSEEvent_Data) FromInputSSEHeartbeatData(v InputSSEHeartbeatData) error
FromInputSSEHeartbeatData overwrites any union data inside the InputSSEEvent_Data as the provided InputSSEHeartbeatData
func (*InputSSEEvent_Data) FromInputSSEPendingData ¶
func (t *InputSSEEvent_Data) FromInputSSEPendingData(v InputSSEPendingData) error
FromInputSSEPendingData overwrites any union data inside the InputSSEEvent_Data as the provided InputSSEPendingData
func (InputSSEEvent_Data) MarshalJSON ¶
func (t InputSSEEvent_Data) MarshalJSON() ([]byte, error)
func (*InputSSEEvent_Data) MergeInputSSECancelledData ¶
func (t *InputSSEEvent_Data) MergeInputSSECancelledData(v InputSSECancelledData) error
MergeInputSSECancelledData performs a merge with any union data inside the InputSSEEvent_Data, using the provided InputSSECancelledData
func (*InputSSEEvent_Data) MergeInputSSEConnectedData ¶
func (t *InputSSEEvent_Data) MergeInputSSEConnectedData(v InputSSEConnectedData) error
MergeInputSSEConnectedData performs a merge with any union data inside the InputSSEEvent_Data, using the provided InputSSEConnectedData
func (*InputSSEEvent_Data) MergeInputSSEErrorData ¶
func (t *InputSSEEvent_Data) MergeInputSSEErrorData(v InputSSEErrorData) error
MergeInputSSEErrorData performs a merge with any union data inside the InputSSEEvent_Data, using the provided InputSSEErrorData
func (*InputSSEEvent_Data) MergeInputSSEHeartbeatData ¶
func (t *InputSSEEvent_Data) MergeInputSSEHeartbeatData(v InputSSEHeartbeatData) error
MergeInputSSEHeartbeatData performs a merge with any union data inside the InputSSEEvent_Data, using the provided InputSSEHeartbeatData
func (*InputSSEEvent_Data) MergeInputSSEPendingData ¶
func (t *InputSSEEvent_Data) MergeInputSSEPendingData(v InputSSEPendingData) error
MergeInputSSEPendingData performs a merge with any union data inside the InputSSEEvent_Data, using the provided InputSSEPendingData
func (*InputSSEEvent_Data) UnmarshalJSON ¶
func (t *InputSSEEvent_Data) UnmarshalJSON(b []byte) error
type InputSSEHeartbeatData ¶
InputSSEHeartbeatData defines model for InputSSEHeartbeatData.
type InputSSEPendingData ¶
type InputSSEPendingData struct {
// Id Workflow job ID
Id string `json:"id"`
}
InputSSEPendingData defines model for InputSSEPendingData.
type LinearScale ¶
type LinearScale struct {
Max int `json:"max"`
MaxLabel *string `json:"max_label,omitempty"`
Min int `json:"min"`
MinLabel *string `json:"min_label,omitempty"`
}
LinearScale defines model for LinearScale.
type OkResponse ¶
type OkResponse struct {
Ok *bool `json:"ok,omitempty"`
}
OkResponse defines model for OkResponse.
type PendingInput ¶
type PendingInput struct {
// Id Workflow job ID
Id string `json:"id"`
}
PendingInput defines model for PendingInput.
type PostApiProjectsProjectIdUserInputsJobIdCancelJSONRequestBody ¶
type PostApiProjectsProjectIdUserInputsJobIdCancelJSONRequestBody = CancelRequest
PostApiProjectsProjectIdUserInputsJobIdCancelJSONRequestBody defines body for PostApiProjectsProjectIdUserInputsJobIdCancel for application/json ContentType.
type PostApiProjectsProjectIdUserInputsJobIdRespondJSONRequestBody ¶
type PostApiProjectsProjectIdUserInputsJobIdRespondJSONRequestBody = FormResponse
PostApiProjectsProjectIdUserInputsJobIdRespondJSONRequestBody defines body for PostApiProjectsProjectIdUserInputsJobIdRespond for application/json ContentType.
type UserInputDetails ¶
type UserInputDetails struct {
// Form Configuration for a single- or multi-question input form.
Form InputFormConfig `json:"form"`
Hash *string `json:"hash,omitempty"`
JobId string `json:"jobId"`
StartTime time.Time `json:"startTime"`
Status string `json:"status"`
}
UserInputDetails defines model for UserInputDetails.