Fix formatting.

sysadminsmedia · Oct 8, 2024 · 7d462a4 · 7d462a4
1 parent c9ed50a
commit 7d462a4
Show file tree

Hide file tree

Showing 17 changed files with 428 additions and 428 deletions.
diff --git a/backend/app/api/handlers/v1/controller.go b/backend/app/api/handlers/v1/controller.go
@@ -111,11 +111,11 @@ func NewControllerV1(svc *services.AllServices, repos *repo.AllRepos, bus *event
 
 // HandleBase godoc
 //
-//	@Summary Application Info
-//	@Tags    Base
-//	@Produce json
-//	@Success 200 {object} APISummary
-//	@Router  /v1/status [GET]
+//	@Summary	Application Info
+//	@Tags		Base
+//	@Produce	json
+//	@Success	200	{object}	APISummary
+//	@Router		/v1/status [GET]
 func (ctrl *V1Controller) HandleBase(ready ReadyFunc, build Build) errchain.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) error {
 		return server.JSON(w, http.StatusOK, APISummary{
@@ -131,11 +131,11 @@ func (ctrl *V1Controller) HandleBase(ready ReadyFunc, build Build) errchain.Hand
 
 // HandleCurrency godoc
 //
-// @Summary Currency
-// @Tags    Base
-// @Produce json
-// @Success 200 {object} currencies.Currency
-// @Router  /v1/currency [GET]
+//	@Summary	Currency
+//	@Tags		Base
+//	@Produce	json
+//	@Success	200	{object}	currencies.Currency
+//	@Router		/v1/currency [GET]
 func (ctrl *V1Controller) HandleCurrency() errchain.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) error {
 		// Set Cache for 10 Minutes

diff --git a/backend/app/api/handlers/v1/v1_ctrl_actions.go b/backend/app/api/handlers/v1/v1_ctrl_actions.go
@@ -32,52 +32,52 @@ func actionHandlerFactory(ref string, fn func(context.Context, uuid.UUID) (int,
 
 // HandleEnsureAssetID godoc
 //
-//	@Summary     Ensure Asset IDs
-//	@Description Ensures all items in the database have an asset ID
-//	@Tags        Actions
-//	@Produce     json
-//	@Success     200     {object} ActionAmountResult
-//	@Router      /v1/actions/ensure-asset-ids [Post]
-//	@Security    Bearer
+//	@Summary		Ensure Asset IDs
+//	@Description	Ensures all items in the database have an asset ID
+//	@Tags			Actions
+//	@Produce		json
+//	@Success		200	{object}	ActionAmountResult
+//	@Router			/v1/actions/ensure-asset-ids [Post]
+//	@Security		Bearer
 func (ctrl *V1Controller) HandleEnsureAssetID() errchain.HandlerFunc {
 	return actionHandlerFactory("ensure asset IDs", ctrl.svc.Items.EnsureAssetID)
 }
 
 // HandleEnsureImportRefs godoc
 //
-//	@Summary  Ensures Import Refs
-//	@Description  Ensures all items in the database have an import ref
-//	@Tags     Actions
-//	@Produce  json
-//	@Success  200     {object} ActionAmountResult
-//	@Router   /v1/actions/ensure-import-refs [Post]
-//	@Security Bearer
+//	@Summary		Ensures Import Refs
+//	@Description	Ensures all items in the database have an import ref
+//	@Tags			Actions
+//	@Produce		json
+//	@Success		200	{object}	ActionAmountResult
+//	@Router			/v1/actions/ensure-import-refs [Post]
+//	@Security		Bearer
 func (ctrl *V1Controller) HandleEnsureImportRefs() errchain.HandlerFunc {
 	return actionHandlerFactory("ensure import refs", ctrl.svc.Items.EnsureImportRef)
 }
 
 // HandleItemDateZeroOut godoc
 //
-//	@Summary      Zero Out Time Fields
-//	@Description  Resets all item date fields to the beginning of the day
-//	@Tags         Actions
-//	@Produce      json
-//	@Success      200     {object} ActionAmountResult
-//	@Router       /v1/actions/zero-item-time-fields [Post]
-//	@Security Bearer
+//	@Summary		Zero Out Time Fields
+//	@Description	Resets all item date fields to the beginning of the day
+//	@Tags			Actions
+//	@Produce		json
+//	@Success		200	{object}	ActionAmountResult
+//	@Router			/v1/actions/zero-item-time-fields [Post]
+//	@Security		Bearer
 func (ctrl *V1Controller) HandleItemDateZeroOut() errchain.HandlerFunc {
 	return actionHandlerFactory("zero out date time", ctrl.repo.Items.ZeroOutTimeFields)
 }
 
 // HandleSetPrimaryPhotos godoc
 //
-//	@Summary     Set Primary Photos
-//	@Description Sets the first photo of each item as the primary photo
-//	@Tags        Actions
-//	@Produce     json
-//	@Success     200     {object} ActionAmountResult
-//	@Router      /v1/actions/set-primary-photos [Post]
-//	@Security    Bearer
+//	@Summary		Set Primary Photos
+//	@Description	Sets the first photo of each item as the primary photo
+//	@Tags			Actions
+//	@Produce		json
+//	@Success		200	{object}	ActionAmountResult
+//	@Router			/v1/actions/set-primary-photos [Post]
+//	@Security		Bearer
 func (ctrl *V1Controller) HandleSetPrimaryPhotos() errchain.HandlerFunc {
 	return actionHandlerFactory("ensure asset IDs", ctrl.repo.Items.SetPrimaryPhotos)
 }
diff --git a/backend/app/api/handlers/v1/v1_ctrl_assets.go b/backend/app/api/handlers/v1/v1_ctrl_assets.go
@@ -17,13 +17,13 @@ import (
 
 // HandleAssetGet godocs
 //
-//	@Summary  Get Item by Asset ID
-//	@Tags     Items
-//	@Produce  json
-//	@Param    id  path     string true "Asset ID"
-//	@Success  200       {object} repo.PaginationResult[repo.ItemSummary]{}
-//	@Router   /v1/assets/{id} [GET]
-//	@Security Bearer
+//	@Summary	Get Item by Asset ID
+//	@Tags		Items
+//	@Produce	json
+//	@Param		id	path		string	true	"Asset ID"
+//	@Success	200	{object}	repo.PaginationResult[repo.ItemSummary]{}
+//	@Router		/v1/assets/{id} [GET]
+//	@Security	Bearer
 func (ctrl *V1Controller) HandleAssetGet() errchain.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) error {
 		ctx := services.NewContext(r.Context())

diff --git a/backend/app/api/handlers/v1/v1_ctrl_auth.go b/backend/app/api/handlers/v1/v1_ctrl_auth.go
@@ -79,17 +79,17 @@ type AuthProvider interface {
 
 // HandleAuthLogin godoc
 //
-//	@Summary User Login
-//	@Tags    Authentication
-//	@Accept  x-www-form-urlencoded
-//	@Accept  application/json
-//	@Param   username formData string false "string" example([email protected])
-//	@Param   password formData string false "string" example(admin)
-//	@Param   payload body     LoginForm true "Login Data"
-//	@Param   provider    query    string   false "auth provider"
-//	@Produce json
-//	@Success 200 {object} TokenResponse
-//	@Router  /v1/users/login [POST]
+//	@Summary	User Login
+//	@Tags		Authentication
+//	@Accept		x-www-form-urlencoded
+//	@Accept		application/json
+//	@Param		username	formData	string		false	"string"	example([email protected])
+//	@Param		password	formData	string		false	"string"	example(admin)
+//	@Param		payload		body		LoginForm	true	"Login Data"
+//	@Param		provider	query		string		false	"auth provider"
+//	@Produce	json
+//	@Success	200	{object}	TokenResponse
+//	@Router		/v1/users/login [POST]
 func (ctrl *V1Controller) HandleAuthLogin(ps ...AuthProvider) errchain.HandlerFunc {
 	if len(ps) == 0 {
 		panic("no auth providers provided")
@@ -131,11 +131,11 @@ func (ctrl *V1Controller) HandleAuthLogin(ps ...AuthProvider) errchain.HandlerFu
 
 // HandleAuthLogout godoc
 //
-//	@Summary  User Logout
-//	@Tags     Authentication
-//	@Success  204
-//	@Router   /v1/users/logout [POST]
-//	@Security Bearer
+//	@Summary	User Logout
+//	@Tags		Authentication
+//	@Success	204
+//	@Router		/v1/users/logout [POST]
+//	@Security	Bearer
 func (ctrl *V1Controller) HandleAuthLogout() errchain.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) error {
 		token := services.UseTokenCtx(r.Context())
@@ -155,13 +155,13 @@ func (ctrl *V1Controller) HandleAuthLogout() errchain.HandlerFunc {
 
 // HandleAuthRefresh godoc
 //
-//	@Summary     User Token Refresh
-//	@Description handleAuthRefresh returns a handler that will issue a new token from an existing token.
-//	@Description This does not validate that the user still exists within the database.
-//	@Tags        Authentication
-//	@Success     200
-//	@Router      /v1/users/refresh [GET]
-//	@Security    Bearer
+//	@Summary		User Token Refresh
+//	@Description	handleAuthRefresh returns a handler that will issue a new token from an existing token.
+//	@Description	This does not validate that the user still exists within the database.
+//	@Tags			Authentication
+//	@Success		200
+//	@Router			/v1/users/refresh [GET]
+//	@Security		Bearer
 func (ctrl *V1Controller) HandleAuthRefresh() errchain.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) error {
 		requestToken := services.UseTokenCtx(r.Context())

diff --git a/backend/app/api/handlers/v1/v1_ctrl_group.go b/backend/app/api/handlers/v1/v1_ctrl_group.go
@@ -26,12 +26,12 @@ type (
 
 // HandleGroupGet godoc
 //
-//	@Summary  Get Group
-//	@Tags     Group
-//	@Produce  json
-//	@Success  200 {object} repo.Group
-//	@Router   /v1/groups [Get]
-//	@Security Bearer
+//	@Summary	Get Group
+//	@Tags		Group
+//	@Produce	json
+//	@Success	200	{object}	repo.Group
+//	@Router		/v1/groups [Get]
+//	@Security	Bearer
 func (ctrl *V1Controller) HandleGroupGet() errchain.HandlerFunc {
 	fn := func(r *http.Request) (repo.Group, error) {
 		auth := services.NewContext(r.Context())
@@ -43,13 +43,13 @@ func (ctrl *V1Controller) HandleGroupGet() errchain.HandlerFunc {
 
 // HandleGroupUpdate godoc
 //
-//	@Summary  Update Group
-//	@Tags     Group
-//	@Produce  json
-//	@Param    payload body     repo.GroupUpdate true "User Data"
-//	@Success  200     {object} repo.Group
-//	@Router   /v1/groups [Put]
-//	@Security Bearer
+//	@Summary	Update Group
+//	@Tags		Group
+//	@Produce	json
+//	@Param		payload	body		repo.GroupUpdate	true	"User Data"
+//	@Success	200		{object}	repo.Group
+//	@Router		/v1/groups [Put]
+//	@Security	Bearer
 func (ctrl *V1Controller) HandleGroupUpdate() errchain.HandlerFunc {
 	fn := func(r *http.Request, body repo.GroupUpdate) (repo.Group, error) {
 		auth := services.NewContext(r.Context())
@@ -69,13 +69,13 @@ func (ctrl *V1Controller) HandleGroupUpdate() errchain.HandlerFunc {
 
 // HandleGroupInvitationsCreate godoc
 //
-//	@Summary  Create Group Invitation
-//	@Tags     Group
-//	@Produce  json
-//	@Param    payload body     GroupInvitationCreate true "User Data"
-//	@Success  200     {object} GroupInvitation
-//	@Router   /v1/groups/invitations [Post]
-//	@Security Bearer
+//	@Summary	Create Group Invitation
+//	@Tags		Group
+//	@Produce	json
+//	@Param		payload	body		GroupInvitationCreate	true	"User Data"
+//	@Success	200		{object}	GroupInvitation
+//	@Router		/v1/groups/invitations [Post]
+//	@Security	Bearer
 func (ctrl *V1Controller) HandleGroupInvitationsCreate() errchain.HandlerFunc {
 	fn := func(r *http.Request, body GroupInvitationCreate) (GroupInvitation, error) {
 		if body.ExpiresAt.IsZero() {