code.gitea.io/gitea@v1.22.3/routers/api/v1/user/block.go (about)

     1  // Copyright 2024 The Gitea Authors.
     2  // SPDX-License-Identifier: MIT
     3  
     4  package user
     5  
     6  import (
     7  	"code.gitea.io/gitea/routers/api/v1/shared"
     8  	"code.gitea.io/gitea/services/context"
     9  )
    10  
    11  func ListBlocks(ctx *context.APIContext) {
    12  	// swagger:operation GET /user/blocks user userListBlocks
    13  	// ---
    14  	// summary: List users blocked by the authenticated user
    15  	// parameters:
    16  	// - name: page
    17  	//   in: query
    18  	//   description: page number of results to return (1-based)
    19  	//   type: integer
    20  	// - name: limit
    21  	//   in: query
    22  	//   description: page size of results
    23  	//   type: integer
    24  	// produces:
    25  	// - application/json
    26  	// responses:
    27  	//   "200":
    28  	//     "$ref": "#/responses/UserList"
    29  
    30  	shared.ListBlocks(ctx, ctx.Doer)
    31  }
    32  
    33  func CheckUserBlock(ctx *context.APIContext) {
    34  	// swagger:operation GET /user/blocks/{username} user userCheckUserBlock
    35  	// ---
    36  	// summary: Check if a user is blocked by the authenticated user
    37  	// parameters:
    38  	// - name: username
    39  	//   in: path
    40  	//   description: user to check
    41  	//   type: string
    42  	//   required: true
    43  	// responses:
    44  	//   "204":
    45  	//     "$ref": "#/responses/empty"
    46  	//   "404":
    47  	//     "$ref": "#/responses/notFound"
    48  
    49  	shared.CheckUserBlock(ctx, ctx.Doer)
    50  }
    51  
    52  func BlockUser(ctx *context.APIContext) {
    53  	// swagger:operation PUT /user/blocks/{username} user userBlockUser
    54  	// ---
    55  	// summary: Block a user
    56  	// parameters:
    57  	// - name: username
    58  	//   in: path
    59  	//   description: user to block
    60  	//   type: string
    61  	//   required: true
    62  	// - name: note
    63  	//   in: query
    64  	//   description: optional note for the block
    65  	//   type: string
    66  	// responses:
    67  	//   "204":
    68  	//     "$ref": "#/responses/empty"
    69  	//   "404":
    70  	//     "$ref": "#/responses/notFound"
    71  	//   "422":
    72  	//     "$ref": "#/responses/validationError"
    73  
    74  	shared.BlockUser(ctx, ctx.Doer)
    75  }
    76  
    77  func UnblockUser(ctx *context.APIContext) {
    78  	// swagger:operation DELETE /user/blocks/{username} user userUnblockUser
    79  	// ---
    80  	// summary: Unblock a user
    81  	// parameters:
    82  	// - name: username
    83  	//   in: path
    84  	//   description: user to unblock
    85  	//   type: string
    86  	//   required: true
    87  	// responses:
    88  	//   "204":
    89  	//     "$ref": "#/responses/empty"
    90  	//   "404":
    91  	//     "$ref": "#/responses/notFound"
    92  	//   "422":
    93  	//     "$ref": "#/responses/validationError"
    94  
    95  	shared.UnblockUser(ctx, ctx.Doer, ctx.Doer)
    96  }