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,15 @@ namespace ScrumTaskboard.Controllers
}
// GET: api/sprint
#nullable enable
/// <summary>
/// Retrieve all Sprints in DB.
/// </summary>
/// <param name="title"></param>
/// <param name="projectid"></param>
/// <param name="startDate"></param>
/// <param name="endDate"></param>
/// <returns></returns>
#nullable enable
[HttpGet]
public async Task<ActionResult<IEnumerable<ScrumSprint>>> GetSprint([FromQuery]string? title, [FromQuery]int? projectid, [FromQuery]DateTime? startDate, [FromQuery]DateTime? endDate)
{
@@ -51,9 +59,14 @@ namespace ScrumTaskboard.Controllers
return await filtered.ToListAsync();
}
#nullable disable
#nullable disable
// GET: api/sprint/5
/// <summary>
/// Retrieve the Sprint by it's ID.
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[HttpGet("{id}")]
public async Task<ActionResult<ScrumSprint>> GetSprint(int id)
{
@@ -68,6 +81,12 @@ namespace ScrumTaskboard.Controllers
}
// PUT: api/sprint/5
/// <summary>
/// Update the Sprint identified by it's ID.
/// </summary>
/// <param name="id"></param>
/// <param name="sprint"></param>
/// <returns></returns>
[HttpPut("{id}")]
public async Task<IActionResult> PutSprint(int id, ScrumSprint sprint)
{
@@ -102,6 +121,11 @@ namespace ScrumTaskboard.Controllers
}
// POST: api/Sprint
/// <summary>
/// Create a new Sprint.
/// </summary>
/// <param name="sprint"></param>
/// <returns></returns>
[HttpPost]
public async Task<ActionResult<ScrumSprint>> PostSprint(ScrumSprint sprint)
{
@@ -113,6 +137,11 @@ namespace ScrumTaskboard.Controllers
}
// DELETE: api/Sprint/5
/// <summary>
/// Delete a Sprint identified by it's ID.
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[HttpDelete("{id}")]
public async Task<ActionResult<ScrumSprint>> DeleteSprint(int id)
{