Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthenticationController ¶
type AuthenticationController struct{}
func (AuthenticationController) Authenticate ¶
func (controller AuthenticationController) Authenticate(c *gin.Context)
@Summary Create JWT token @Schemes @Description Create JWT token from a users email and password. @Description This token is used to authenticate to the rest of the API @Tags Token @Accept json @Produce json @Param request body model.User true "Token Request" @Success 200 {object} model.UserResponse @Failure 400 {object} middleware.ErrorResponse @Failure 401 {object} middleware.ErrorResponse @Router /token [post]
type RequestController ¶
type RequestController struct{}
func (RequestController) CreateNew ¶
func (requestController RequestController) CreateNew(c *gin.Context)
@Summary Create a certificate request @Schemes @Description Create a certificate request @Tags Request @Accept json @Produce json @Param request body model.RequestCreate true "Certificate Request" @Success 201 {object} model.APIEnvelopeResponse{data=model.Request} @Failure 400 {object} middleware.ErrorResponse @Failure 401 {object} middleware.ErrorResponse @Router /request [post]
func (RequestController) GetAll ¶
func (requestController RequestController) GetAll(c *gin.Context)
@Summary Fetch all certificate requests @Schemes @Description Fetch all certificate requests @Tags Request @Accept json @Param limit query int false "Number of results per page" @Param page query int false "Which page of results to fetch" @Param sort query string false "Order of which results appear" Enums(asc, desc) @Produce json @Success 200 {object} model.APIEnvelopeResponse{data=[]model.Request} @Failure 401 {object} middleware.ErrorResponse @Router /request [get]
func (RequestController) GetOne ¶
func (requestController RequestController) GetOne(c *gin.Context)
@Summary Fetch a certificate request @Schemes @Description Fetch one certificate request by certificate request ID @Tags Request @Accept json @Produce json @Param id path int true "Certificate Request ID" @Success 200 {object} model.APIEnvelopeResponse{data=model.Request} @Failure 400 {object} middleware.ErrorResponse @Failure 401 {object} middleware.ErrorResponse @Failure 404 {object} middleware.ErrorResponse @Router /request/{id} [get]
func (RequestController) Renew ¶
func (requestController RequestController) Renew(c *gin.Context)
@Summary Renew a certificate request @Schemes @Description Renew a certificate request @Tags Request @Accept json @Produce json @Param id path int true "Certificate Request ID" @Param request body model.RequestCreate true "Certificate Request" @Success 201 {object} model.APIEnvelopeResponse{data=model.Request} @Failure 400 {object} middleware.ErrorResponse @Failure 401 {object} middleware.ErrorResponse @Router /request/{id} [post]
Source Files