api

Documentation

Index

• Variables
• type CompanionAPI
  • func (cApi *CompanionAPI) WebServices() []*restful.WebService
• type CreateUserReq
• type MeResponse
• type UpdatePasswordReq

Variables

var (
	// ErrMissingContent indicates an inexistent user.
	ErrMissingUser = restful.NewError(http.StatusConflict, "Missing user")
	// ErrMissingUserId indicates an user without an id.
	ErrMissingUserId = restful.NewError(http.StatusUnprocessableEntity, "No user id given")
	// ErrMissingUserPassword indicates an user without a password.
	ErrMissingUserPassword = restful.NewError(http.StatusUnprocessableEntity, "No user password given.")
	// ErrUserAlreadyExist indicates an existing user that should not be.
	ErrUserAlreadyExist = restful.NewError(http.StatusConflict, "User already exist")
	// ErrPatchFail indicates the json-patch update fails.
	ErrPatchFail = restful.NewError(http.StatusConflict, "Patch update fails")
)

Types

type CompanionAPI

type CompanionAPI struct {
	Client     backend.Client
	AdminToken string
}

CompanionAPI registering with restful

func (*CompanionAPI) WebServices

func (cApi *CompanionAPI) WebServices() []*restful.WebService

Register provide a restful.WebService from this API

type CreateUserReq

type CreateUserReq struct {
	ID   string           `json:"id"`
	User backend.UserData `json:"user"`
}

CreateUserReq is a request to create a new UserData

type MeResponse

type MeResponse struct {
	Sub string
}

type UpdatePasswordReq

type UpdatePasswordReq struct {
	NewPassword string
}