aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Api/Controllers/StartupController.cs
diff options
context:
space:
mode:
Diffstat (limited to 'Jellyfin.Api/Controllers/StartupController.cs')
-rw-r--r--Jellyfin.Api/Controllers/StartupController.cs37
1 files changed, 36 insertions, 1 deletions
diff --git a/Jellyfin.Api/Controllers/StartupController.cs b/Jellyfin.Api/Controllers/StartupController.cs
index 271745e05..0e7d17a27 100644
--- a/Jellyfin.Api/Controllers/StartupController.cs
+++ b/Jellyfin.Api/Controllers/StartupController.cs
@@ -8,18 +8,29 @@ using Microsoft.AspNetCore.Mvc;
namespace Jellyfin.Api.Controllers
{
+ /// <summary>
+ /// The startup wizard controller.
+ /// </summary>
[Authorize(Policy = "FirstTimeSetupOrElevated")]
public class StartupController : BaseJellyfinApiController
{
private readonly IServerConfigurationManager _config;
private readonly IUserManager _userManager;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="StartupController" /> class.
+ /// </summary>
+ /// <param name="config">The server configuration manager.</param>
+ /// <param name="userManager">The user manager.</param>
public StartupController(IServerConfigurationManager config, IUserManager userManager)
{
_config = config;
_userManager = userManager;
}
+ /// <summary>
+ /// Api endpoint for completing the startup wizard.
+ /// </summary>
[HttpPost("Complete")]
public void CompleteWizard()
{
@@ -28,6 +39,10 @@ namespace Jellyfin.Api.Controllers
_config.SaveConfiguration();
}
+ /// <summary>
+ /// Endpoint for getting the initial startup wizard configuration.
+ /// </summary>
+ /// <returns>The initial startup wizard configuration.</returns>
[HttpGet("Configuration")]
public StartupConfigurationDto GetStartupConfiguration()
{
@@ -41,6 +56,12 @@ namespace Jellyfin.Api.Controllers
return result;
}
+ /// <summary>
+ /// Endpoint for updating the initial startup wizard configuration.
+ /// </summary>
+ /// <param name="uiCulture">The UI language culture.</param>
+ /// <param name="metadataCountryCode">The metadata country code.</param>
+ /// <param name="preferredMetadataLanguage">The preferred language for metadata.</param>
[HttpPost("Configuration")]
public void UpdateInitialConfiguration(
[FromForm] string uiCulture,
@@ -53,6 +74,11 @@ namespace Jellyfin.Api.Controllers
_config.SaveConfiguration();
}
+ /// <summary>
+ /// Endpoint for (dis)allowing remote access and UPnP.
+ /// </summary>
+ /// <param name="enableRemoteAccess">Enable remote access.</param>
+ /// <param name="enableAutomaticPortMapping">Enable UPnP.</param>
[HttpPost("RemoteAccess")]
public void SetRemoteAccess([FromForm] bool enableRemoteAccess, [FromForm] bool enableAutomaticPortMapping)
{
@@ -61,8 +87,12 @@ namespace Jellyfin.Api.Controllers
_config.SaveConfiguration();
}
+ /// <summary>
+ /// Endpoint for returning the first user.
+ /// </summary>
+ /// <returns>The first user.</returns>
[HttpGet("User")]
- public StartupUserDto GetUser()
+ public StartupUserDto GetFirstUser()
{
var user = _userManager.Users.First();
@@ -73,6 +103,11 @@ namespace Jellyfin.Api.Controllers
};
}
+ /// <summary>
+ /// Endpoint for updating the user name and password.
+ /// </summary>
+ /// <param name="startupUserDto">The DTO containing username and password.</param>
+ /// <returns>The async task.</returns>
[HttpPost("User")]
public async Task UpdateUser([FromForm] StartupUserDto startupUserDto)
{