Added XML comments

This commit is contained in:
Alexander Rufenach
2021-06-04 04:41:31 -04:00
parent 9f3eef2cce
commit 25d84797fc
8 changed files with 260 additions and 24 deletions
@@ -5,6 +5,9 @@ using Microsoft.AspNetCore.Mvc;
namespace Jellyfin.Plugin.AnilistSync.API
{
/// <summary>
/// Anilist endpoints.
/// </summary>
[ApiController]
[Authorize(Policy = "DefaultAuthorization")]
[Route("AnilistSync")]
@@ -12,17 +15,31 @@ namespace Jellyfin.Plugin.AnilistSync.API
{
private readonly AnilistApi _anilistApi;
/// <summary>
/// Initializes a new instacne fo the <see cref="Endpoints"/> class.
/// </summary>
/// <param name="anilistApi"></param>
public Endpoints(AnilistApi anilistApi)
{
_anilistApi = anilistApi;
}
/// <summary>
/// Gets the OAuth token.
/// </summary>
/// <param name="userCode">User code.</param>
/// <returns>Code response containing token.</returns>
[HttpGet("oauth/token/{userCode}")]
public async Task<ActionResult<CodeResponse?>> GetToken([FromRoute] string userCode)
{
return await _anilistApi.GetToken(userCode);
}
/// <summary>
/// Gets the currently authenticated user
/// </summary>
/// <param name="userId">The user ID.</param>
/// <returns>Root object containing User object</returns>
[HttpGet("users/settings/{userId}")]
public async Task<ActionResult<RootObject?>> GetUser([FromRoute] Guid userId)
{