Documentation
¶
Overview ¶
Package generated provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version v1.16.3 DO NOT EDIT.
Package generated provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version v1.16.3 DO NOT EDIT.
Package generated provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version v1.16.3 DO NOT EDIT.
Index ¶
- Constants
- func GetSwagger() (swagger *openapi3.T, err error)
- func Handler(si ServerInterface) http.Handler
- func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler
- func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler
- func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- type ChiServerOptions
- type InvalidParamFormatError
- type JobClaimRequest
- type JobClaimResponse
- type JobCreateRequest
- type JobCreateResponse
- type JobError
- type JobStatusUpdateRequest
- type JobView
- type MiddlewareFunc
- type PostApiJobsClaimJSONRequestBody
- type PostApiJobsJSONRequestBody
- type PostApiJobsJobIdPayloadJSONRequestBody
- type PostApiJobsJobIdResultJSONRequestBody
- type PostApiJobsJobIdStatusJSONRequestBody
- type RequiredHeaderError
- type RequiredParamError
- type ServerInterface
- type ServerInterfaceWrapper
- func (siw *ServerInterfaceWrapper) GetApiJobsJobId(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetApiJobsJobIdEvents(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetApiState(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetApiStateStream(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetApiTransferChannelId(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetHealthz(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) PostApiJobs(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) PostApiJobsClaim(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) PostApiJobsJobIdCancel(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) PostApiJobsJobIdPayload(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) PostApiJobsJobIdResult(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) PostApiJobsJobIdStatus(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) PostApiTransfer(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) PostApiTransferChannelId(w http.ResponseWriter, r *http.Request)
- type TooManyValuesForParamError
- type TransferCreateResponse
- type TransferInfo
- type TransferRequest
- type TransferRequestResponse
- type UnescapedCookieParamError
- type Unimplemented
- func (_ Unimplemented) GetApiJobsJobId(w http.ResponseWriter, r *http.Request, jobId string)
- func (_ Unimplemented) GetApiJobsJobIdEvents(w http.ResponseWriter, r *http.Request, jobId string)
- func (_ Unimplemented) GetApiState(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) GetApiStateStream(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) GetApiTransferChannelId(w http.ResponseWriter, r *http.Request, channelId string)
- func (_ Unimplemented) GetHealthz(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) PostApiJobs(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) PostApiJobsClaim(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) PostApiJobsJobIdCancel(w http.ResponseWriter, r *http.Request, jobId string)
- func (_ Unimplemented) PostApiJobsJobIdPayload(w http.ResponseWriter, r *http.Request, jobId string)
- func (_ Unimplemented) PostApiJobsJobIdResult(w http.ResponseWriter, r *http.Request, jobId string)
- func (_ Unimplemented) PostApiJobsJobIdStatus(w http.ResponseWriter, r *http.Request, jobId string)
- func (_ Unimplemented) PostApiTransfer(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) PostApiTransferChannelId(w http.ResponseWriter, r *http.Request, channelId string)
- type UnmarshalingParamError
Constants ¶
const (
BearerAuthScopes = "BearerAuth.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func GetSwagger ¶
GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.
func Handler ¶
func Handler(si ServerInterface) http.Handler
Handler creates http.Handler with routing matching OpenAPI spec.
func HandlerFromMux ¶
func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler
HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.
func HandlerWithOptions ¶
func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler
HandlerWithOptions creates http.Handler with additional options
Types ¶
type ChiServerOptions ¶
type ChiServerOptions struct {
BaseURL string
BaseRouter chi.Router
Middlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
type InvalidParamFormatError ¶
func (*InvalidParamFormatError) Error ¶
func (e *InvalidParamFormatError) Error() string
func (*InvalidParamFormatError) Unwrap ¶
func (e *InvalidParamFormatError) Unwrap() error
type JobClaimRequest ¶ added in v0.8.0
type JobClaimRequest struct {
MaxWaitSeconds *int `json:"max_wait_seconds,omitempty"`
Types *[]string `json:"types,omitempty"`
}
JobClaimRequest defines model for JobClaimRequest.
type JobClaimResponse ¶ added in v0.8.0
type JobClaimResponse struct {
JobId string `json:"job_id"`
Metadata *map[string]interface{} `json:"metadata,omitempty"`
Type string `json:"type"`
}
JobClaimResponse defines model for JobClaimResponse.
type JobCreateRequest ¶ added in v0.8.0
type JobCreateRequest struct {
Metadata *map[string]interface{} `json:"metadata,omitempty"`
Priority *int `json:"priority,omitempty"`
Type string `json:"type"`
}
JobCreateRequest defines model for JobCreateRequest.
type JobCreateResponse ¶ added in v0.8.0
JobCreateResponse defines model for JobCreateResponse.
type JobStatusUpdateRequest ¶ added in v0.8.0
type JobStatusUpdateRequest struct {
Error *JobError `json:"error,omitempty"`
Progress *map[string]interface{} `json:"progress,omitempty"`
State string `json:"state"`
}
JobStatusUpdateRequest defines model for JobStatusUpdateRequest.
type JobView ¶ added in v0.8.0
type JobView struct {
CreatedAt time.Time `json:"created_at"`
Error *JobError `json:"error,omitempty"`
Id string `json:"id"`
Metadata *map[string]interface{} `json:"metadata,omitempty"`
Payloads *map[string]TransferInfo `json:"payloads,omitempty"`
Progress *map[string]interface{} `json:"progress,omitempty"`
QueuePosition *int `json:"queue_position,omitempty"`
Results *map[string]TransferInfo `json:"results,omitempty"`
Status string `json:"status"`
Type string `json:"type"`
UpdatedAt time.Time `json:"updated_at"`
}
JobView defines model for JobView.
type PostApiJobsClaimJSONRequestBody ¶ added in v0.8.0
type PostApiJobsClaimJSONRequestBody = JobClaimRequest
PostApiJobsClaimJSONRequestBody defines body for PostApiJobsClaim for application/json ContentType.
type PostApiJobsJSONRequestBody ¶ added in v0.8.0
type PostApiJobsJSONRequestBody = JobCreateRequest
PostApiJobsJSONRequestBody defines body for PostApiJobs for application/json ContentType.
type PostApiJobsJobIdPayloadJSONRequestBody ¶ added in v0.8.1
type PostApiJobsJobIdPayloadJSONRequestBody = TransferRequest
PostApiJobsJobIdPayloadJSONRequestBody defines body for PostApiJobsJobIdPayload for application/json ContentType.
type PostApiJobsJobIdResultJSONRequestBody ¶ added in v0.8.1
type PostApiJobsJobIdResultJSONRequestBody = TransferRequest
PostApiJobsJobIdResultJSONRequestBody defines body for PostApiJobsJobIdResult for application/json ContentType.
type PostApiJobsJobIdStatusJSONRequestBody ¶ added in v0.8.0
type PostApiJobsJobIdStatusJSONRequestBody = JobStatusUpdateRequest
PostApiJobsJobIdStatusJSONRequestBody defines body for PostApiJobsJobIdStatus for application/json ContentType.
type RequiredHeaderError ¶
func (*RequiredHeaderError) Error ¶
func (e *RequiredHeaderError) Error() string
func (*RequiredHeaderError) Unwrap ¶
func (e *RequiredHeaderError) Unwrap() error
type RequiredParamError ¶
type RequiredParamError struct {
ParamName string
}
func (*RequiredParamError) Error ¶
func (e *RequiredParamError) Error() string
type ServerInterface ¶
type ServerInterface interface {
// Create a job
// (POST /api/jobs)
PostApiJobs(w http.ResponseWriter, r *http.Request)
// Claim the next queued job
// (POST /api/jobs/claim)
PostApiJobsClaim(w http.ResponseWriter, r *http.Request)
// Get job status
// (GET /api/jobs/{job_id})
GetApiJobsJobId(w http.ResponseWriter, r *http.Request, jobId string)
// Cancel a job
// (POST /api/jobs/{job_id}/cancel)
PostApiJobsJobIdCancel(w http.ResponseWriter, r *http.Request, jobId string)
// Stream job events
// (GET /api/jobs/{job_id}/events)
GetApiJobsJobIdEvents(w http.ResponseWriter, r *http.Request, jobId string)
// Request payload transfer channel
// (POST /api/jobs/{job_id}/payload)
PostApiJobsJobIdPayload(w http.ResponseWriter, r *http.Request, jobId string)
// Request result transfer channel
// (POST /api/jobs/{job_id}/result)
PostApiJobsJobIdResult(w http.ResponseWriter, r *http.Request, jobId string)
// Update job status
// (POST /api/jobs/{job_id}/status)
PostApiJobsJobIdStatus(w http.ResponseWriter, r *http.Request, jobId string)
// Get server state
// (GET /api/state)
GetApiState(w http.ResponseWriter, r *http.Request)
// Stream server state
// (GET /api/state/stream)
GetApiStateStream(w http.ResponseWriter, r *http.Request)
// Create a transfer channel
// (POST /api/transfer)
PostApiTransfer(w http.ResponseWriter, r *http.Request)
// Receive transfer data (reader)
// (GET /api/transfer/{channel_id})
GetApiTransferChannelId(w http.ResponseWriter, r *http.Request, channelId string)
// Send transfer data (writer)
// (POST /api/transfer/{channel_id})
PostApiTransferChannelId(w http.ResponseWriter, r *http.Request, channelId string)
// Health check
// (GET /healthz)
GetHealthz(w http.ResponseWriter, r *http.Request)
}
ServerInterface represents all server handlers.
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
HandlerMiddlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
ServerInterfaceWrapper converts contexts to parameters.
func (*ServerInterfaceWrapper) GetApiJobsJobId ¶ added in v0.8.0
func (siw *ServerInterfaceWrapper) GetApiJobsJobId(w http.ResponseWriter, r *http.Request)
GetApiJobsJobId operation middleware
func (*ServerInterfaceWrapper) GetApiJobsJobIdEvents ¶ added in v0.8.0
func (siw *ServerInterfaceWrapper) GetApiJobsJobIdEvents(w http.ResponseWriter, r *http.Request)
GetApiJobsJobIdEvents operation middleware
func (*ServerInterfaceWrapper) GetApiState ¶
func (siw *ServerInterfaceWrapper) GetApiState(w http.ResponseWriter, r *http.Request)
GetApiState operation middleware
func (*ServerInterfaceWrapper) GetApiStateStream ¶
func (siw *ServerInterfaceWrapper) GetApiStateStream(w http.ResponseWriter, r *http.Request)
GetApiStateStream operation middleware
func (*ServerInterfaceWrapper) GetApiTransferChannelId ¶ added in v0.8.0
func (siw *ServerInterfaceWrapper) GetApiTransferChannelId(w http.ResponseWriter, r *http.Request)
GetApiTransferChannelId operation middleware
func (*ServerInterfaceWrapper) GetHealthz ¶
func (siw *ServerInterfaceWrapper) GetHealthz(w http.ResponseWriter, r *http.Request)
GetHealthz operation middleware
func (*ServerInterfaceWrapper) PostApiJobs ¶ added in v0.8.0
func (siw *ServerInterfaceWrapper) PostApiJobs(w http.ResponseWriter, r *http.Request)
PostApiJobs operation middleware
func (*ServerInterfaceWrapper) PostApiJobsClaim ¶ added in v0.8.0
func (siw *ServerInterfaceWrapper) PostApiJobsClaim(w http.ResponseWriter, r *http.Request)
PostApiJobsClaim operation middleware
func (*ServerInterfaceWrapper) PostApiJobsJobIdCancel ¶ added in v0.8.0
func (siw *ServerInterfaceWrapper) PostApiJobsJobIdCancel(w http.ResponseWriter, r *http.Request)
PostApiJobsJobIdCancel operation middleware
func (*ServerInterfaceWrapper) PostApiJobsJobIdPayload ¶ added in v0.8.0
func (siw *ServerInterfaceWrapper) PostApiJobsJobIdPayload(w http.ResponseWriter, r *http.Request)
PostApiJobsJobIdPayload operation middleware
func (*ServerInterfaceWrapper) PostApiJobsJobIdResult ¶ added in v0.8.0
func (siw *ServerInterfaceWrapper) PostApiJobsJobIdResult(w http.ResponseWriter, r *http.Request)
PostApiJobsJobIdResult operation middleware
func (*ServerInterfaceWrapper) PostApiJobsJobIdStatus ¶ added in v0.8.0
func (siw *ServerInterfaceWrapper) PostApiJobsJobIdStatus(w http.ResponseWriter, r *http.Request)
PostApiJobsJobIdStatus operation middleware
func (*ServerInterfaceWrapper) PostApiTransfer ¶ added in v0.8.0
func (siw *ServerInterfaceWrapper) PostApiTransfer(w http.ResponseWriter, r *http.Request)
PostApiTransfer operation middleware
func (*ServerInterfaceWrapper) PostApiTransferChannelId ¶ added in v0.8.0
func (siw *ServerInterfaceWrapper) PostApiTransferChannelId(w http.ResponseWriter, r *http.Request)
PostApiTransferChannelId operation middleware
type TooManyValuesForParamError ¶
func (*TooManyValuesForParamError) Error ¶
func (e *TooManyValuesForParamError) Error() string
type TransferCreateResponse ¶ added in v0.8.0
type TransferCreateResponse struct {
ChannelId string `json:"channel_id"`
ExpiresAt time.Time `json:"expires_at"`
}
TransferCreateResponse defines model for TransferCreateResponse.
type TransferInfo ¶ added in v0.8.0
type TransferInfo struct {
ChannelId string `json:"channel_id"`
ExpiresAt time.Time `json:"expires_at"`
Key *string `json:"key,omitempty"`
Method string `json:"method"`
Url string `json:"url"`
}
TransferInfo defines model for TransferInfo.
type TransferRequest ¶ added in v0.8.1
type TransferRequest struct {
Key *string `json:"key,omitempty"`
}
TransferRequest defines model for TransferRequest.
type TransferRequestResponse ¶ added in v0.8.0
type TransferRequestResponse struct {
ChannelId string `json:"channel_id"`
ExpiresAt time.Time `json:"expires_at"`
Key *string `json:"key,omitempty"`
ReaderUrl *string `json:"reader_url,omitempty"`
WriterUrl *string `json:"writer_url,omitempty"`
}
TransferRequestResponse defines model for TransferRequestResponse.
type UnescapedCookieParamError ¶
func (*UnescapedCookieParamError) Error ¶
func (e *UnescapedCookieParamError) Error() string
func (*UnescapedCookieParamError) Unwrap ¶
func (e *UnescapedCookieParamError) Unwrap() error
type Unimplemented ¶
type Unimplemented struct{}
func (Unimplemented) GetApiJobsJobId ¶ added in v0.8.0
func (_ Unimplemented) GetApiJobsJobId(w http.ResponseWriter, r *http.Request, jobId string)
Get job status (GET /api/jobs/{job_id})
func (Unimplemented) GetApiJobsJobIdEvents ¶ added in v0.8.0
func (_ Unimplemented) GetApiJobsJobIdEvents(w http.ResponseWriter, r *http.Request, jobId string)
Stream job events (GET /api/jobs/{job_id}/events)
func (Unimplemented) GetApiState ¶
func (_ Unimplemented) GetApiState(w http.ResponseWriter, r *http.Request)
Get server state (GET /api/state)
func (Unimplemented) GetApiStateStream ¶
func (_ Unimplemented) GetApiStateStream(w http.ResponseWriter, r *http.Request)
Stream server state (GET /api/state/stream)
func (Unimplemented) GetApiTransferChannelId ¶ added in v0.8.0
func (_ Unimplemented) GetApiTransferChannelId(w http.ResponseWriter, r *http.Request, channelId string)
Receive transfer data (reader) (GET /api/transfer/{channel_id})
func (Unimplemented) GetHealthz ¶
func (_ Unimplemented) GetHealthz(w http.ResponseWriter, r *http.Request)
Health check (GET /healthz)
func (Unimplemented) PostApiJobs ¶ added in v0.8.0
func (_ Unimplemented) PostApiJobs(w http.ResponseWriter, r *http.Request)
Create a job (POST /api/jobs)
func (Unimplemented) PostApiJobsClaim ¶ added in v0.8.0
func (_ Unimplemented) PostApiJobsClaim(w http.ResponseWriter, r *http.Request)
Claim the next queued job (POST /api/jobs/claim)
func (Unimplemented) PostApiJobsJobIdCancel ¶ added in v0.8.0
func (_ Unimplemented) PostApiJobsJobIdCancel(w http.ResponseWriter, r *http.Request, jobId string)
Cancel a job (POST /api/jobs/{job_id}/cancel)
func (Unimplemented) PostApiJobsJobIdPayload ¶ added in v0.8.0
func (_ Unimplemented) PostApiJobsJobIdPayload(w http.ResponseWriter, r *http.Request, jobId string)
Request payload transfer channel (POST /api/jobs/{job_id}/payload)
func (Unimplemented) PostApiJobsJobIdResult ¶ added in v0.8.0
func (_ Unimplemented) PostApiJobsJobIdResult(w http.ResponseWriter, r *http.Request, jobId string)
Request result transfer channel (POST /api/jobs/{job_id}/result)
func (Unimplemented) PostApiJobsJobIdStatus ¶ added in v0.8.0
func (_ Unimplemented) PostApiJobsJobIdStatus(w http.ResponseWriter, r *http.Request, jobId string)
Update job status (POST /api/jobs/{job_id}/status)
func (Unimplemented) PostApiTransfer ¶ added in v0.8.0
func (_ Unimplemented) PostApiTransfer(w http.ResponseWriter, r *http.Request)
Create a transfer channel (POST /api/transfer)
func (Unimplemented) PostApiTransferChannelId ¶ added in v0.8.0
func (_ Unimplemented) PostApiTransferChannelId(w http.ResponseWriter, r *http.Request, channelId string)
Send transfer data (writer) (POST /api/transfer/{channel_id})
type UnmarshalingParamError ¶
func (*UnmarshalingParamError) Error ¶
func (e *UnmarshalingParamError) Error() string
func (*UnmarshalingParamError) Unwrap ¶
func (e *UnmarshalingParamError) Unwrap() error