taskgrp

Documentation

Overview

Package taskgrp provides handlers for inspecting tasks

Index

• type GetTaskResponse
• type Handler
  • func New(task task.Manager) *Handler
  • func (h *Handler) Get(ctx context.Context, w http.ResponseWriter, r *http.Request) error
  • func (h *Handler) Register(a *web.App)

Types

type GetTaskResponse

type GetTaskResponse struct {
	Data taskcommon.State `json:"data"`
}

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

func New

func New(task task.Manager) *Handler

func (*Handler) Get

func (h *Handler) Get(ctx context.Context, w http.ResponseWriter, r *http.Request) error

GetTask godoc

@Summary		Inspect task state by ID
@Description	Inspect task state by ID
@Tags			Task
@Accept			json
@Produce		json
@Param			id	path	string	true	"Task ID"
@Security		Bearer
@Success		200	{object}	GetTaskResponse
@Router			/task/{id} [get]
@Security		Bearer
@Failure		400
@Failure		404

func (*Handler) Register

func (h *Handler) Register(a *web.App)