Improved the Comments in Controller

This commit is contained in:
Taha FADL
2020-07-15 16:21:43 +02:00
parent f0cf54513f
commit 79cc2dd740
7 changed files with 213 additions and 14 deletions

View File

@@ -26,7 +26,17 @@ namespace ScrumTaskboard.Controllers
}
// GET: api/tasks
#nullable enable
/// <summary>
/// Retrieve all Tasks in DB.
/// </summary>
/// <param name="title"></param>
/// <param name="userstoryid"></param>
/// <param name="statusid"></param>
/// <param name="assignedtoid"></param>
/// <param name="projectid"></param>
/// <param name="priority"></param>
/// <returns></returns>
#nullable enable
[HttpGet]
public async Task<ActionResult<IEnumerable<ScrumTask>>> GetTasks([FromQuery]string? title, [FromQuery]int? userstoryid, [FromQuery]int? statusid, [FromQuery]int? assignedtoid, [FromQuery]int? projectid, [FromQuery]ScrumPrio? priority)
{
@@ -60,9 +70,14 @@ namespace ScrumTaskboard.Controllers
return await filtered.ToListAsync();
}
#nullable disable
#nullable disable
// GET: api/tasks/5
/// <summary>
/// Retrieve the Task by it's ID.
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[HttpGet("{id}")]
public async Task<ActionResult<ScrumTask>> GetTask(int id)
{
@@ -77,6 +92,12 @@ namespace ScrumTaskboard.Controllers
}
// PUT: api/tasks/5
/// <summary>
/// Update the Task identified by it's ID.
/// </summary>
/// <param name="id"></param>
/// <param name="task"></param>
/// <returns></returns>
[HttpPut("{id}")]
public async Task<IActionResult> PutTask(int id, ScrumTask task)
{
@@ -111,6 +132,11 @@ namespace ScrumTaskboard.Controllers
}
// POST: api/tasks
/// <summary>
/// Create a new Task.
/// </summary>
/// <param name="task"></param>
/// <returns></returns>
[HttpPost]
public async Task<ActionResult<ScrumTask>> PostTask(ScrumTask task)
{
@@ -122,6 +148,11 @@ namespace ScrumTaskboard.Controllers
}
// DELETE: api/tasks/5
/// <summary>
/// Delete a Task identified by it's ID.
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[HttpDelete("{id}")]
public async Task<ActionResult<ScrumTask>> DeleteTask(int id)
{