Cutlery/Kyoo
1
0
Fork 0
mirror of https://github.com/zoriya/Kyoo.git synced 2025-05-23 17:52:36 -04:00
Code Issues Packages Projects Releases Wiki Activity

Use pages for users paginations

Browse Source
This commit is contained in:
Zoe Roux 2025-03-30 20:12:56 +02:00
parent 076d5a0dbd
commit 411f6dcfba
No known key found for this signature in database
5 changed files with 76 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api/src/models/utils/descriptions.ts
View File

@ -8,7 +8,7 @@ export const desc = {
`,
after: comment`
Id of the cursor in the pagination.
Cursor for the pagination.
You can ignore this and only use the prev/next field in the response.
`,

24
auth/docs/docs.go
View File

@ -245,9 +245,8 @@ const docTemplate = `{
"parameters": [
{
"type": "string",
"format": "uuid",
"description": "used for pagination.",
"name": "afterId",
"name": "after",
"in": "query"
}
],
@ -255,7 +254,7 @@ const docTemplate = `{
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/main.User"
"$ref": "#/definitions/main.Page-main_User"
}
},
"422": {
@ -576,6 +575,25 @@ const docTemplate = `{
}
}
},
"main.Page-main_User": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/main.User"
}
},
"next": {
"type": "string",
"example": "https://kyoo.zoriya.dev/auth/users?after=aoeusth"
},
"this": {
"type": "string",
"example": "https://kyoo.zoriya.dev/auth/users"
}
}
},
"main.RegisterDto": {
"type": "object",
"required": [

24
auth/docs/swagger.json
View File

@ -239,9 +239,8 @@
"parameters": [
{
"type": "string",
"format": "uuid",
"description": "used for pagination.",
"name": "afterId",
"name": "after",
"in": "query"
}
],
@ -249,7 +248,7 @@
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/main.User"
"$ref": "#/definitions/main.Page-main_User"
}
},
"422": {
@ -570,6 +569,25 @@
}
}
},
"main.Page-main_User": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/main.User"
}
},
"next": {
"type": "string",
"example": "https://kyoo.zoriya.dev/auth/users?after=aoeusth"
},
"this": {
"type": "string",
"example": "https://kyoo.zoriya.dev/auth/users"
}
}
},
"main.RegisterDto": {
"type": "object",
"required": [

28
auth/page.go Normal file
View File

@ -0,0 +1,28 @@
package main
import "net/url"
type Page[T any] struct {
Items []T `json:"items"`
This string `json:"this" example:"https://kyoo.zoriya.dev/auth/users"`
Next *string `json:"next" example:"https://kyoo.zoriya.dev/auth/users?after=aoeusth"`
}
func NewPage(items []User, url *url.URL, limit int32) Page[User] {
this := url.String()
var next *string
if len(items) == int(limit) && limit > 0 {
query := url.Query()
query.Set("after", items[len(items)-1].Id.String())
url.RawQuery = query.Encode()
nextU := url.String()
next = &nextU
}
return Page[User]{
Items: items,
This: this,
Next: next,
}
}

11
auth/users.go
View File

@ -78,8 +78,8 @@ func MapOidc(oidc *dbc.GetUserRow) OidcHandle {
// @Accept json
// @Produce json
// @Security Jwt[users.read]
// @Param afterId query string false "used for pagination." Format(uuid)
// @Success 200 {object} User[]
// @Param after query string false "used for pagination."
// @Success 200 {object} Page[User]
// @Failure 422 {object} KError "Invalid after id"
// @Router /users [get]
func (h *Handler) ListUsers(c echo.Context) error {
@ -90,7 +90,7 @@ func (h *Handler) ListUsers(c echo.Context) error {
ctx := context.Background()
limit := int32(20)
id := c.Param("afterId")
id := c.Param("after")
var users []dbc.User
if id == "" {
@ -98,7 +98,7 @@ func (h *Handler) ListUsers(c echo.Context) error {
} else {
uid, uerr := uuid.Parse(id)
if uerr != nil {
return echo.NewHTTPError(http.StatusUnprocessableEntity, "Invalid `afterId` parameter, uuid was expected")
return echo.NewHTTPError(http.StatusUnprocessableEntity, "Invalid `after` parameter, uuid was expected")
}
users, err = h.db.GetAllUsersAfter(ctx, dbc.GetAllUsersAfterParams{
Limit: limit,
@ -114,8 +114,7 @@ func (h *Handler) ListUsers(c echo.Context) error {
for _, user := range users {
ret = append(ret, MapDbUser(&user))
}
// TODO: switch to a Page
return c.JSON(200, ret)
return c.JSON(200, NewPage(ret, c.Request().URL, limit))
}
// @Summary Get user