backend

Documentation

Index

• type BackendRequestParams
• type Handler
  • func NewHandler(backendManager *backendmanager.BackendManager) (*Handler, error)
  • func (h *Handler) CreateBackend() http.HandlerFunc
  • func (h *Handler) DeleteBackend() http.HandlerFunc
  • func (h *Handler) GetBackend() http.HandlerFunc
  • func (h *Handler) ListBackends() http.HandlerFunc
  • func (h *Handler) UpdateBackend() http.HandlerFunc

Types

type BackendRequestParams

type BackendRequestParams struct {
	BackendID uint
}

type Handler

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

func NewHandler

func NewHandler(
	backendManager *backendmanager.BackendManager,
) (*Handler, error)

func (*Handler) CreateBackend

func (h *Handler) CreateBackend() http.HandlerFunc

@Summary Create backend @Description Create a new backend @Accept json @Produce json @Param backend body CreateBackendRequest true "Created backend" @Success 200 {object} entity.Backend "Success" @Failure 400 {object} errors.DetailError "Bad Request" @Failure 401 {object} errors.DetailError "Unauthorized" @Failure 429 {object} errors.DetailError "Too Many Requests" @Failure 404 {object} errors.DetailError "Not Found" @Failure 500 {object} errors.DetailError "Internal Server Error" @Router /api/v1/backend/{backendName} [post]

func (*Handler) DeleteBackend

func (h *Handler) DeleteBackend() http.HandlerFunc

@Summary Delete backend @Description Delete specified backend by ID @Produce json @Param id path int true "Backend ID" @Success 200 {object} entity.Backend "Success" @Failure 400 {object} errors.DetailError "Bad Request" @Failure 401 {object} errors.DetailError "Unauthorized" @Failure 429 {object} errors.DetailError "Too Many Requests" @Failure 404 {object} errors.DetailError "Not Found" @Failure 500 {object} errors.DetailError "Internal Server Error" @Router /api/v1/backend/{backendName} [delete] @Router /api/v1/backend/{backendID} [delete]

func (*Handler) GetBackend

func (h *Handler) GetBackend() http.HandlerFunc

@Summary Get backend @Description Get backend information by backend ID @Produce json @Param id path int true "Backend ID" @Success 200 {object} entity.Backend "Success" @Failure 400 {object} errors.DetailError "Bad Request" @Failure 401 {object} errors.DetailError "Unauthorized" @Failure 429 {object} errors.DetailError "Too Many Requests" @Failure 404 {object} errors.DetailError "Not Found" @Failure 500 {object} errors.DetailError "Internal Server Error" @Router /api/v1/backend/{backendID} [get]

func (*Handler) ListBackends

func (h *Handler) ListBackends() http.HandlerFunc

@Summary List backends @Description List all backends @Produce json @Success 200 {object} entity.Backend "Success" @Failure 400 {object} errors.DetailError "Bad Request" @Failure 401 {object} errors.DetailError "Unauthorized" @Failure 429 {object} errors.DetailError "Too Many Requests" @Failure 404 {object} errors.DetailError "Not Found" @Failure 500 {object} errors.DetailError "Internal Server Error" @Router /api/v1/backend [get]

func (*Handler) UpdateBackend

func (h *Handler) UpdateBackend() http.HandlerFunc

@Summary Update backend @Description Update the specified backend @Accept json @Produce json @Param backend body UpdateBackendRequest true "Updated backend" @Success 200 {object} entity.Backend "Success" @Failure 400 {object} errors.DetailError "Bad Request" @Failure 401 {object} errors.DetailError "Unauthorized" @Failure 429 {object} errors.DetailError "Too Many Requests" @Failure 404 {object} errors.DetailError "Not Found" @Failure 500 {object} errors.DetailError "Internal Server Error" @Router /api/v1/backend/{backendID} [put]