BreizhHardware/jfa-go
1
0
Fork 0
mirror of https://github.com/hrfee/jfa-go.git synced 2026-01-18 16:47:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

swag: add new statistics tag, add filtered user count route

Browse Source
This commit is contained in:
Harvey Tindall
2025-11-23 16:55:06 +00:00
parent b5f28da452
commit 7c9f917114
5 changed files with 44 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
api-activities.go
View File

@@ -116,7 +116,7 @@ func (app *appContext) generateActivitiesQuery(req ServerFilterReqDTO) *badgerho
// @Success 200 {object} GetActivitiesRespDTO
// @Router /activity [post]
// @Security Bearer
// @tags Activity
// @tags Activity,Statistics
func (app *appContext) GetActivities(gc *gin.Context) {
req := ServerSearchReqDTO{}
gc.BindJSON(&req)
@@ -185,7 +185,7 @@ func (app *appContext) DeleteActivity(gc *gin.Context) {
// @Success 200 {object} PageCountDTO
// @Router /activity/count [get]
// @Security Bearer
// @tags Activity
// @tags Activity,Statistics
func (app *appContext) GetActivityCount(gc *gin.Context) {
resp := PageCountDTO{}
var err error
@@ -202,7 +202,7 @@ func (app *appContext) GetActivityCount(gc *gin.Context) {
// @Success 200 {object} PageCountDTO
// @Router /activity/count [post]
// @Security Bearer
// @tags Activity
// @tags Activity,Statistics
func (app *appContext) GetFilteredActivityCount(gc *gin.Context) {
resp := PageCountDTO{}
req := ServerFilterReqDTO{}

6
api-invites.go
View File

@@ -270,7 +270,7 @@ func (app *appContext) GenerateInvite(gc *gin.Context) {
// @Success 200 {object} PageCountDTO
// @Router /invites/count [get]
// @Security Bearer
// @tags Invites
// @tags Invites,Statistics
func (app *appContext) GetInviteCount(gc *gin.Context) {
resp := PageCountDTO{}
var err error
@@ -286,7 +286,7 @@ func (app *appContext) GetInviteCount(gc *gin.Context) {
// @Success 200 {object} PageCountDTO
// @Router /invites/count/used [get]
// @Security Bearer
// @tags Invites
// @tags Invites,Statistics
func (app *appContext) GetInviteUsedCount(gc *gin.Context) {
resp := PageCountDTO{}
var err error
@@ -310,7 +310,7 @@ func (app *appContext) GetInviteUsedCount(gc *gin.Context) {
// @Success 200 {object} getInvitesDTO
// @Router /invites [get]
// @Security Bearer
// @tags Invites
// @tags Invites,Statistics
func (app *appContext) GetInvites(gc *gin.Context) {
currentTime := time.Now()
app.checkInvites()

36
api-users.go
View File

@@ -911,7 +911,7 @@ func (app *appContext) userSummary(jfUser mediabrowser.User) respUser {
// @Success 200 {object} PageCountDTO
// @Router /users/count [get]
// @Security Bearer
// @tags Activity
// @tags Activity,Statistics
func (app *appContext) GetUserCount(gc *gin.Context) {
resp := PageCountDTO{}
users, err := app.jf.GetUsers(false)
@@ -952,7 +952,7 @@ func (app *appContext) GetUsers(gc *gin.Context) {
// @Failure 500 {object} stringResponse
// @Router /users [post]
// @Security Bearer
// @tags Users
// @tags Users,Statistics
func (app *appContext) SearchUsers(gc *gin.Context) {
req := ServerSearchReqDTO{}
gc.BindJSON(&req)
@@ -991,6 +991,38 @@ func (app *appContext) SearchUsers(gc *gin.Context) {
gc.JSON(200, resp)
}
// @Summary Get a count of users matching the search provided
// @Produce json
// @Param ServerSearchReqDTO body ServerSearchReqDTO true "search / pagination parameters"
// @Success 200 {object} PageCountDTO
// @Failure 500 {object} stringResponse
// @Router /users/count [post]
// @Security Bearer
// @tags Users,Statistics
func (app *appContext) GetFilteredUserCount(gc *gin.Context) {
req := ServerSearchReqDTO{}
gc.BindJSON(&req)
if req.SortByField == "" {
req.SortByField = USER_DEFAULT_SORT_FIELD
}
var resp PageCountDTO
// No need to sort
userList, err := app.userCache.GetUserDTOs(app, false)
if err != nil {
app.err.Printf(lm.FailedGetUsers, lm.Jellyfin, err)
respond(500, "Couldn't get users", gc)
return
}
if len(req.SearchTerms) != 0 || len(req.Queries) != 0 {
resp.Count = uint64(len(app.userCache.Filter(userList, req.SearchTerms, req.Queries)))
} else {
resp.Count = uint64(len(userList))
}
gc.JSON(200, resp)
}
// @Summary Set whether or not a user can access jfa-go. Redundant if the user is a Jellyfin admin.
// @Produce json
// @Param setAccountsAdminDTO body setAccountsAdminDTO true "Map of userIDs to whether or not they have access."

3
main.go
View File

@@ -757,6 +757,9 @@ func flagPassed(name string) (found bool) {
// @tag.name Other
// @tag.description Things that dont fit elsewhere.
// @tag.name Statistics
// @tag.description Routes that expose useful info/stats.
func printVersion() {
tray := ""
if TRAY {

1
router.go
View File

@@ -201,6 +201,7 @@ func (app *appContext) loadRoutes(router *gin.Engine) {
api.GET(p+"/users", app.GetUsers)
api.GET(p+"/users/count", app.GetUserCount)
api.POST(p+"/users", app.SearchUsers)
api.POST(p+"/users/count", app.GetFilteredUserCount)
api.POST(p+"/user", app.NewUserFromAdmin)
api.POST(p+"/users/extend", app.ExtendExpiry)
api.DELETE(p+"/users/:id/expiry", app.RemoveExpiry)