summaryrefslogtreecommitdiffstats
path: root/routers/api/v1/user/block.go
blob: 7231e9add7a9380358cacf3679bf5b2043d36069 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
// Copyright 2024 The Gitea Authors.
// SPDX-License-Identifier: MIT

package user

import (
	"code.gitea.io/gitea/routers/api/v1/shared"
	"code.gitea.io/gitea/services/context"
)

func ListBlocks(ctx *context.APIContext) {
	// swagger:operation GET /user/blocks user userListBlocks
	// ---
	// summary: List users blocked by the authenticated user
	// 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
	// produces:
	// - application/json
	// responses:
	//   "200":
	//     "$ref": "#/responses/UserList"

	shared.ListBlocks(ctx, ctx.Doer)
}

func CheckUserBlock(ctx *context.APIContext) {
	// swagger:operation GET /user/blocks/{username} user userCheckUserBlock
	// ---
	// summary: Check if a user is blocked by the authenticated user
	// parameters:
	// - name: username
	//   in: path
	//   description: user to check
	//   type: string
	//   required: true
	// responses:
	//   "204":
	//     "$ref": "#/responses/empty"
	//   "404":
	//     "$ref": "#/responses/notFound"

	shared.CheckUserBlock(ctx, ctx.Doer)
}

func BlockUser(ctx *context.APIContext) {
	// swagger:operation PUT /user/blocks/{username} user userBlockUser
	// ---
	// summary: Block a user
	// parameters:
	// - name: username
	//   in: path
	//   description: user to block
	//   type: string
	//   required: true
	// - name: note
	//   in: query
	//   description: optional note for the block
	//   type: string
	// responses:
	//   "204":
	//     "$ref": "#/responses/empty"
	//   "404":
	//     "$ref": "#/responses/notFound"
	//   "422":
	//     "$ref": "#/responses/validationError"

	shared.BlockUser(ctx, ctx.Doer)
}

func UnblockUser(ctx *context.APIContext) {
	// swagger:operation DELETE /user/blocks/{username} user userUnblockUser
	// ---
	// summary: Unblock a user
	// parameters:
	// - name: username
	//   in: path
	//   description: user to unblock
	//   type: string
	//   required: true
	// responses:
	//   "204":
	//     "$ref": "#/responses/empty"
	//   "404":
	//     "$ref": "#/responses/notFound"
	//   "422":
	//     "$ref": "#/responses/validationError"

	shared.UnblockUser(ctx, ctx.Doer, ctx.Doer)
}