mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2025-08-14 07:06:49 +02:00
022ab86988
Speaking from personal experience, when exploring the API I find myself trying to parse the exact meaning of many descriptions for a while, and I also have to get used to many different kinds of inconsistencies and grammar issues. This PR improves a few of these. Some I tried to reword to make them easier to understand, for others I just improved consistency a little, like capitalization. This area needs more work, this PR just makes some progress. Anything that is improved in this one can be improved further in later PRs, so in review please focus on regressions if you find any. Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8728 Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org> Co-authored-by: 0ko <0ko@noreply.codeberg.org> Co-committed-by: 0ko <0ko@noreply.codeberg.org>
87 lines
2.1 KiB
Go
87 lines
2.1 KiB
Go
// Copyright 2023 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package admin
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
user_model "forgejo.org/models/user"
|
|
api "forgejo.org/modules/structs"
|
|
"forgejo.org/routers/api/v1/utils"
|
|
"forgejo.org/services/context"
|
|
"forgejo.org/services/convert"
|
|
)
|
|
|
|
// GetAllEmails
|
|
func GetAllEmails(ctx *context.APIContext) {
|
|
// swagger:operation GET /admin/emails admin adminGetAllEmails
|
|
// ---
|
|
// summary: List all users' email addresses
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: page
|
|
// in: query
|
|
// description: page number of results to return (1-based)
|
|
// type: integer
|
|
// - name: limit
|
|
// in: query
|
|
// description: page size of results
|
|
// type: integer
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/EmailList"
|
|
// "403":
|
|
// "$ref": "#/responses/forbidden"
|
|
|
|
listOptions := utils.GetListOptions(ctx)
|
|
|
|
emails, maxResults, err := user_model.SearchEmails(ctx, &user_model.SearchEmailOptions{
|
|
Keyword: ctx.Params(":email"),
|
|
ListOptions: listOptions,
|
|
})
|
|
if err != nil {
|
|
ctx.Error(http.StatusInternalServerError, "GetAllEmails", err)
|
|
return
|
|
}
|
|
|
|
results := make([]*api.Email, len(emails))
|
|
for i := range emails {
|
|
results[i] = convert.ToEmailSearch(emails[i])
|
|
}
|
|
|
|
ctx.SetLinkHeader(int(maxResults), listOptions.PageSize)
|
|
ctx.SetTotalCountHeader(maxResults)
|
|
ctx.JSON(http.StatusOK, &results)
|
|
}
|
|
|
|
// SearchEmail
|
|
func SearchEmail(ctx *context.APIContext) {
|
|
// swagger:operation GET /admin/emails/search admin adminSearchEmails
|
|
// ---
|
|
// summary: Search users' email addresses
|
|
// produces:
|
|
// - application/json
|
|
// parameters:
|
|
// - name: q
|
|
// in: query
|
|
// description: keyword
|
|
// type: string
|
|
// - name: page
|
|
// in: query
|
|
// description: page number of results to return (1-based)
|
|
// type: integer
|
|
// - name: limit
|
|
// in: query
|
|
// description: page size of results
|
|
// type: integer
|
|
// responses:
|
|
// "200":
|
|
// "$ref": "#/responses/EmailList"
|
|
// "403":
|
|
// "$ref": "#/responses/forbidden"
|
|
|
|
ctx.SetParams(":email", ctx.FormTrim("q"))
|
|
GetAllEmails(ctx)
|
|
}
|