package
0.0.0-20240611132008-c57eac18f8d9
Repository: https://github.com/slightly-techie/okr-api.git
Documentation: pkg.go.dev

# Functions

Create Company godoc @Summary Create Company @Description Create a company @Tags Company @Accept json @Produce json @Security JWT @Param Company body types.NewCompanyRequest true "company" @Success 200 {object} types.APISuccessMessage @Failure 400 {object} types.APIErrorMessage @Failure 500 {object} types.APIErrorMessage @Router /companies/create [post].
@Summary Create Objective @Description Create an Objective @Tags Objectives @Accept json @Produce json @Security JWT @Param Objective body types.NewObjectiveRequest true "Objective" @Success 200 {object} types.APISuccessMessage @Failure 400 {object} types.APIErrorMessage @Failure 500 {object} types.APIErrorMessage @Router /objectives/create [post].
@Summary Delete objective @Description Delete objective @Tags Objectives @Accept json @Produce json @Security JWT @Param id path string true "Objective ID" @Success 200 {object} types.APISuccessMessage @Failure 400 {object} types.APIErrorMessage @Failure 500 {object} types.APIErrorMessage @Router /objectives/{id} [delete].
@Summary Get Objectives @Description Get all Objectives @Tags Objectives @Accept json @Produce json @Security JWT @Param id path string true "User ID" @Success 200 {object} types.APISuccessMessage @Failure 400 {object} types.APIErrorMessage @Failure 500 {object} types.APIErrorMessage @Router /objectives [get].
GetUser godoc @Summary Get User @Description Get a user by the provided ID @Tags User @Accept json @Produce json @Param id path string true "User ID" @Success 200 {object} types.APISuccessMessage @Failure 400 {object} types.APIErrorMessage @Failure 500 {object} types.APIErrorMessage @Router /users/{id} [get].
SignIn godoc @Summary Sign In @Description Log in to your account @Tags Auth @Accept json @Produce json @Param Credentials body models.LoginInfo true "credentials" @Success 200 {object} types.APISuccessMessage @Failure 400 {object} types.APIErrorMessage @Failure 500 {object} types.APIErrorMessage @Router /auth/login [post].
@Summary Update Objective @Description Update and Objective @Tags Objectives @Accept json @Produce json @Security JWT @Param id path string true "Objective ID" @Param Objective body types.NewObjectiveRequest true "Objective" @Success 200 {object} types.APISuccessMessage @Failure 400 {object} types.APIErrorMessage @Failure 500 {object} types.APIErrorMessage @Router /objectives/{id} [put].