a fork of iceshrimp.net but a tweaked frontend to my personal liking. waow
fediverse
social-media
social
iceshrimp
fedi
[backend/web] Add doc comments for MiscController
+20
+20
Iceshrimp.Backend/Controllers/Web/MiscController.cs
+20
Iceshrimp.Backend/Controllers/Web/MiscController.cs
···
16
16
17
17
namespace Iceshrimp.Backend.Controllers.Web;
18
18
19
+
/// <summary>
20
+
/// Operations that aren't well categorized and may be moved to a more appropriate section at a later date.
21
+
/// </summary>
19
22
[ApiController]
20
23
[Authenticate]
21
24
[Authorize]
25
+
[Tags("Miscellaneous")]
22
26
[EnableRateLimiting("sliding")]
23
27
[Route("/api/iceshrimp/misc")]
24
28
[Produces(MediaTypeNames.Application.Json)]
25
29
[EnableCors("iceshrimp")]
26
30
public class MiscController(DatabaseContext db, NoteRenderer noteRenderer, BiteService biteSvc) : ControllerBase
27
31
{
32
+
/// <summary>
33
+
/// Bite back
34
+
/// </summary>
35
+
/// <remarks>Bite a user back in response to a Bite activity</remarks>
36
+
/// <param name="id">The Bite's ID</param>
28
37
[HttpPost("bite_back/{id}")]
29
38
[Authenticate]
30
39
[Authorize]
···
49
58
await biteSvc.BiteAsync(user, target);
50
59
}
51
60
61
+
/// <summary>
62
+
/// Get muted threads
63
+
/// </summary>
64
+
/// <remarks>Returns a paginated list of note threads that are muted by the user.</remarks>
65
+
/// <param name="pq">Pagination query</param>
66
+
/// <response code="200">Paginated list of muted note threads</response>
52
67
[HttpGet("muted_threads")]
53
68
[LinkPagination(20, 40)]
54
69
[ProducesResults(HttpStatusCode.OK)]
···
66
81
return await noteRenderer.RenderManyAsync(notes.EnforceRenoteReplyVisibility(), user);
67
82
}
68
83
84
+
/// <summary>
85
+
/// Get user status
86
+
/// </summary>
87
+
/// <remarks>Returns status information for the user.</remarks>
88
+
/// <response code="200">Status information</response>
69
89
[HttpGet("status")]
70
90
[EnableRateLimiting("sliding")]
71
91
[ProducesResults(HttpStatusCode.OK)]