glax/Tranga
1
0
Fork 0
mirror of https://github.com/C9Glax/tranga.git synced 2025-06-17 08:47:53 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Replace occurences of "ID" with more meaningful names in documentation

Browse Source
This commit is contained in:
Glax
2025-03-08 13:26:07 +01:00
parent 73eb02e7cb
commit 94678e744f
5 changed files with 88 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
API/Controllers/JobController.cs
View File

@ -40,41 +40,41 @@ public class JobController(PgsqlContext context) : Controller
/// <summary>
/// Get all Jobs in requested State
/// </summary>
/// <param name="state">Requested Job-State</param>
/// <param name="JobState">Requested Job-State</param>
/// <response code="200"></response>
[HttpGet("State/{state}")]
[HttpGet("State/{JobState}")]
[ProducesResponseType<Job[]>(Status200OK, "application/json")]
public IActionResult GetJobsInState(JobState state)
public IActionResult GetJobsInState(JobState JobState)
{
Job[] jobsInState = context.Jobs.Where(job => job.state == state).ToArray();
Job[] jobsInState = context.Jobs.Where(job => job.state == JobState).ToArray();
return Ok(jobsInState);
}
/// <summary>
/// Returns all Jobs of requested Type
/// </summary>
/// <param name="type">Requested Job-Type</param>
/// <param name="JobType">Requested Job-Type</param>
/// <response code="200"></response>
[HttpGet("Type/{type}")]
[HttpGet("Type/{JobType}")]
[ProducesResponseType<Job[]>(Status200OK, "application/json")]
public IActionResult GetJobsOfType(JobType type)
public IActionResult GetJobsOfType(JobType JobType)
{
Job[] jobsOfType = context.Jobs.Where(job => job.JobType == type).ToArray();
Job[] jobsOfType = context.Jobs.Where(job => job.JobType == JobType).ToArray();
return Ok(jobsOfType);
}
/// <summary>
/// Return Job with ID
/// </summary>
/// <param name="id">Job-ID</param>
/// <param name="JobId">Job-ID</param>
/// <response code="200"></response>
/// <response code="404">Job with ID could not be found</response>
[HttpGet("{id}")]
[HttpGet("{JobId}")]
[ProducesResponseType<Job>(Status200OK, "application/json")]
[ProducesResponseType(Status404NotFound)]
public IActionResult GetJob(string id)
public IActionResult GetJob(string JobId)
{
Job? ret = context.Jobs.Find(id);
Job? ret = context.Jobs.Find(JobId);
return (ret is not null) switch
{
true => Ok(ret),
@ -85,46 +85,46 @@ public class JobController(PgsqlContext context) : Controller
/// <summary>
/// Create a new CreateNewDownloadChapterJob
/// </summary>
/// <param name="mangaId">ID of Manga</param>
/// <param name="MangaId">ID of Manga</param>
/// <param name="recurrenceTime">How often should we check for new chapters</param>
/// <response code="201">Created new Job</response>
/// <response code="500">Error during Database Operation</response>
[HttpPut("NewDownloadChapterJob/{mangaId}")]
[HttpPut("NewDownloadChapterJob/{MangaId}")]
[ProducesResponseType(Status201Created)]
[ProducesResponseType<string>(Status500InternalServerError, "text/plain")]
public IActionResult CreateNewDownloadChapterJob(string mangaId, [FromBody]ulong recurrenceTime)
public IActionResult CreateNewDownloadChapterJob(string MangaId, [FromBody]ulong recurrenceTime)
{
Job job = new DownloadNewChaptersJob(recurrenceTime, mangaId);
Job job = new DownloadNewChaptersJob(recurrenceTime, MangaId);
return AddJob(job);
}
/// <summary>
/// Create a new DownloadSingleChapterJob
/// </summary>
/// <param name="chapterId">ID of the Chapter</param>
/// <param name="ChapterId">ID of the Chapter</param>
/// <response code="201">Created new Job</response>
/// <response code="500">Error during Database Operation</response>
[HttpPut("DownloadSingleChapterJob/{chapterId}")]
[HttpPut("DownloadSingleChapterJob/{ChapterId}")]
[ProducesResponseType(Status201Created)]
[ProducesResponseType<string>(Status500InternalServerError, "text/plain")]
public IActionResult CreateNewDownloadChapterJob(string chapterId)
public IActionResult CreateNewDownloadChapterJob(string ChapterId)
{
Job job = new DownloadSingleChapterJob(chapterId);
Job job = new DownloadSingleChapterJob(ChapterId);
return AddJob(job);
}
/// <summary>
/// Create a new UpdateMetadataJob
/// </summary>
/// <param name="mangaId">ID of the Manga</param>
/// <param name="MangaId">ID of the Manga</param>
/// <response code="201">Created new Job</response>
/// <response code="500">Error during Database Operation</response>
[HttpPut("UpdateMetadataJob/{mangaId}")]
[HttpPut("UpdateMetadataJob/{MangaId}")]
[ProducesResponseType(Status201Created)]
[ProducesResponseType<string>(Status500InternalServerError, "text/plain")]
public IActionResult CreateUpdateMetadataJob(string mangaId)
public IActionResult CreateUpdateMetadataJob(string MangaId)
{
Job job = new UpdateMetadataJob(0, mangaId);
Job job = new UpdateMetadataJob(0, MangaId);
return AddJob(job);
}
@ -169,22 +169,22 @@ public class JobController(PgsqlContext context) : Controller
/// <summary>
/// Delete Job with ID and all children
/// </summary>
/// <param name="id">Job-ID</param>
/// <param name="JobId">Job-ID</param>
/// <response code="200">Job(s) deleted</response>
/// <response code="404">Job could not be found</response>
/// <response code="500">Error during Database Operation</response>
[HttpDelete("{id}")]
[HttpDelete("{JobId}")]
[ProducesResponseType<string[]>(Status200OK, "application/json")]
[ProducesResponseType(Status404NotFound)]
[ProducesResponseType<string>(Status500InternalServerError, "text/plain")]
public IActionResult DeleteJob(string id)
public IActionResult DeleteJob(string JobId)
{
try
{
Job? ret = context.Jobs.Find(id);
Job? ret = context.Jobs.Find(JobId);
if(ret is null)
return NotFound();
IQueryable<Job> children = GetChildJobs(id);
IQueryable<Job> children = GetChildJobs(JobId);
context.RemoveRange(children);
context.Remove(ret);
@ -209,22 +209,22 @@ public class JobController(PgsqlContext context) : Controller
/// <summary>
/// Modify Job with ID
/// </summary>
/// <param name="id">Job-ID</param>
/// <param name="JobId">Job-ID</param>
/// <param name="modifyJobRecord">Fields to modify, set to null to keep previous value</param>
/// <response code="202">Job modified</response>
/// <response code="400">Malformed request</response>
/// <response code="404">Job with ID not found</response>
/// <response code="500">Error during Database Operation</response>
[HttpPatch("{id}/")]
[HttpPatch("{JobId}")]
[ProducesResponseType<Job>(Status202Accepted, "application/json")]
[ProducesResponseType(Status400BadRequest)]
[ProducesResponseType(Status404NotFound)]
[ProducesResponseType<string>(Status500InternalServerError, "text/plain")]
public IActionResult ModifyJob(string id, [FromBody]ModifyJobRecord modifyJobRecord)
public IActionResult ModifyJob(string JobId, [FromBody]ModifyJobRecord modifyJobRecord)
{
try
{
Job? ret = context.Jobs.Find(id);
Job? ret = context.Jobs.Find(JobId);
if(ret is null)
return NotFound();
@ -243,19 +243,19 @@ public class JobController(PgsqlContext context) : Controller
/// <summary>
/// Starts the Job with the requested ID
/// </summary>
/// <param name="id">Job-ID</param>
/// <param name="JobId">Job-ID</param>
/// <response code="202">Job started</response>
/// <response code="404">Job with ID not found</response>
/// <response code="409">Job was already running</response>
/// <response code="500">Error during Database Operation</response>
[HttpPost("{id}/Start")]
[HttpPost("{JobId}/Start")]
[ProducesResponseType(Status202Accepted)]
[ProducesResponseType(Status404NotFound)]
[ProducesResponseType(Status409Conflict)]
[ProducesResponseType<string>(Status500InternalServerError, "text/plain")]
public IActionResult StartJob(string id)
public IActionResult StartJob(string JobId)
{
Job? ret = context.Jobs.Find(id);
Job? ret = context.Jobs.Find(JobId);
if (ret is null)
return NotFound();
try
@ -275,10 +275,10 @@ public class JobController(PgsqlContext context) : Controller
/// <summary>
/// Stops the Job with the requested ID
/// </summary>
/// <param name="id">Job-ID</param>
/// <param name="JobId">Job-ID</param>
/// <remarks>NOT IMPLEMENTED</remarks>
[HttpPost("{id}/Stop")]
public IActionResult StopJob(string id)
[HttpPost("{JobId}/Stop")]
public IActionResult StopJob(string JobId)
{
throw new NotImplementedException();
}