Documentation
¶
Index ¶
- func ClubRouter(clubParams types.RouteParams) fiber.Router
- func ClubRoutes(clubParams types.RouteParams)
- func CreateClub(db *gorm.DB, pinecone search.SearchClientInterface, userId uuid.UUID, ...) (*models.Club, *errors.Error)
- func DeleteClub(db *gorm.DB, pinecone search.SearchClientInterface, id uuid.UUID) *errors.Error
- func GetClubs(db *gorm.DB, pinecone search.SearchClientInterface, ...) ([]models.Club, *errors.Error)
- func UpdateClub(db *gorm.DB, pinecone search.SearchClientInterface, id uuid.UUID, ...) (*models.Club, *errors.Error)
- type ClubController
- type ClubService
- func (c *ClubService) CreateClub(clubBody models.CreateClubRequestBody) (*models.Club, *errors.Error)
- func (c *ClubService) DeleteClub(id string) *errors.Error
- func (c *ClubService) GetClub(id string) (*models.Club, *errors.Error)
- func (c *ClubService) GetClubs(queryParams *models.ClubQueryParams) ([]models.Club, *errors.Error)
- func (c *ClubService) UpdateClub(id string, clubBody models.UpdateClubRequestBody) (*models.Club, *errors.Error)
- type ClubServiceInterface
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ClubRouter ¶
func ClubRouter(clubParams types.RouteParams) fiber.Router
func ClubRoutes ¶
func ClubRoutes(clubParams types.RouteParams)
func CreateClub ¶
func DeleteClub ¶
Types ¶
type ClubController ¶
type ClubController struct {
// contains filtered or unexported fields
}
func NewClubController ¶
func NewClubController(clubService ClubServiceInterface) *ClubController
func (*ClubController) CreateClub ¶
func (cl *ClubController) CreateClub(c *fiber.Ctx) error
CreateClub godoc
@Summary Create a club @Description Creates a club @ID create-club @Tags club @Accept json @Produce json @Param club body models.CreateClubRequestBody true "Club" @Success 201 {object} models.Club @Failure 400 {object} errors.Error @Failure 401 {object} errors.Error @Failure 404 {object} errors.Error @Failure 500 {object} errors.Error @Router /clubs/ [post]
func (*ClubController) DeleteClub ¶
func (cl *ClubController) DeleteClub(c *fiber.Ctx) error
DeleteClub godoc
@Summary Delete a club @Description Deletes a club @ID delete-club @Tags club @Produce json @Param clubID path string true "Club ID" @Success 204 {string} utilities.SuccessResponse @Failure 400 {object} errors.Error @Failure 401 {object} errors.Error @Failure 404 {object} errors.Error @Failure 500 {object} errors.Error @Router /clubs/{clubID}/ [delete]
func (*ClubController) GetClub ¶
func (cl *ClubController) GetClub(c *fiber.Ctx) error
GetClub godoc
@Summary Retrieve a club @Description Retrieves a club @ID get-club @Tags club @Produce json @Param clubID path string true "Club ID" @Success 200 {object} models.Club @Failure 400 {object} errors.Error @Failure 404 {object} errors.Error @Failure 500 {object} errors.Error @Router /clubs/{clubID}/ [get]
func (*ClubController) GetClubs ¶
func (cl *ClubController) GetClubs(c *fiber.Ctx) error
GetClubs godoc
@Summary Retrieve all clubs @Description Retrieves all clubs @ID get-all-clubs @Tags club @Produce json @Param limit query int false "Limit" @Param page query int false "Page" @Success 200 {object} []models.Club @Failure 400 {object} errors.Error @Failure 500 {object} errors.Error @Router /clubs/ [get]
func (*ClubController) UpdateClub ¶
func (cl *ClubController) UpdateClub(c *fiber.Ctx) error
UpdateClub godoc
@Summary Update a club @Description Updates a club @ID update-club @Tags club @Accept json @Produce json @Param clubID path string true "Club ID" @Param club body models.UpdateClubRequestBody true "Club" @Success 200 {object} models.Club @Failure 400 {object} errors.Error @Failure 401 {object} errors.Error @Failure 404 {object} errors.Error @Failure 500 {object} errors.Error @Router /clubs/{clubID}/ [patch]
type ClubService ¶
type ClubService struct {
types.ServiceParams
}
func (*ClubService) CreateClub ¶
func (c *ClubService) CreateClub(clubBody models.CreateClubRequestBody) (*models.Club, *errors.Error)
func (*ClubService) DeleteClub ¶
func (c *ClubService) DeleteClub(id string) *errors.Error
func (*ClubService) GetClubs ¶
func (c *ClubService) GetClubs(queryParams *models.ClubQueryParams) ([]models.Club, *errors.Error)
func (*ClubService) UpdateClub ¶
func (c *ClubService) UpdateClub(id string, clubBody models.UpdateClubRequestBody) (*models.Club, *errors.Error)
type ClubServiceInterface ¶
type ClubServiceInterface interface {
GetClubs(queryParams *models.ClubQueryParams) ([]models.Club, *errors.Error)
GetClub(id string) (*models.Club, *errors.Error)
CreateClub(clubBody models.CreateClubRequestBody) (*models.Club, *errors.Error)
UpdateClub(id string, clubBody models.UpdateClubRequestBody) (*models.Club, *errors.Error)
DeleteClub(id string) *errors.Error
}
func NewClubService ¶
func NewClubService(serviceParams types.ServiceParams) ClubServiceInterface
Source Files