niggl
/
srumboard_backend
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
ScrumTaskboard/Controllers/CategoriesController.cs
View File

@ -26,7 +26,14 @@ namespace ScrumTaskboard.Controllers
}
// GET: api/category
#nullable enable
/// <summary>
/// Retrieve all Categories in DB.
/// </summary>
/// <param name="title"></param>
/// <param name="projectid"></param>
/// <param name="color"></param>
/// <returns></returns>
#nullable enable
[HttpGet]
public async Task<ActionResult<IEnumerable<ScrumCategory>>> GetCategory([FromQuery]string? title, [FromQuery]int? projectid, [FromQuery] string? color)
{
@ -48,9 +55,14 @@ namespace ScrumTaskboard.Controllers
return await filtered.ToListAsync();
}
#nullable disable
#nullable disable
// GET: api/category/1
/// <summary>
/// Retrieve the Category by it's ID.
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[HttpGet("{id}")]
public async Task<ActionResult<ScrumCategory>> GetCategory(int id)
{
@ -65,6 +77,12 @@ namespace ScrumTaskboard.Controllers
}
// PUT: api/category/1
/// <summary>
/// Update the Category identified by it's ID.
/// </summary>
/// <param name="id"></param>
/// <param name="category"></param>
/// <returns></returns>
[HttpPut("{id}")]
public async Task<IActionResult> PutCategory(int id, ScrumCategory category)
{
@ -99,6 +117,11 @@ namespace ScrumTaskboard.Controllers
}
// POST: api/category
/// <summary>
/// Create a new Category.
/// </summary>
/// <param name="category"></param>
/// <returns></returns>
[HttpPost]
public async Task<ActionResult<ScrumUserstory>> PostCategory(ScrumCategory category)
{
@ -110,6 +133,11 @@ namespace ScrumTaskboard.Controllers
}
// DELETE: api/category/1
/// <summary>
/// Delete a Category identified by it's ID.
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[HttpDelete("{id}")]
public async Task<ActionResult<ScrumCategory>> DeleteCategory(int id)
{

31
ScrumTaskboard/Controllers/ProjectsController.cs
View File

@ -26,7 +26,13 @@ namespace ScrumTaskboard.Controllers
}
// GET: api/projects
#nullable enable
/// <summary>
/// Retrieve all Projects in DB.
/// </summary>
/// <param name="title"></param>
/// <param name="isprivate"></param>
/// <returns></returns>
#nullable enable
[HttpGet]
public async Task<ActionResult<IEnumerable<ScrumProject>>> GetProject([FromQuery]string? title, [FromQuery]bool? isprivate)
{
@ -43,9 +49,14 @@ namespace ScrumTaskboard.Controllers
return await filtered.ToListAsync();
}
#nullable disable
#nullable disable
// GET: api/projects/5
/// <summary>
/// Retrieve the Project by it's ID.
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[HttpGet("{id}")]
public async Task<ActionResult<ScrumProject>> GetProjects(int id)
{
@ -60,6 +71,12 @@ namespace ScrumTaskboard.Controllers
}
// PUT: api/Project/5
/// <summary>
/// Update the Project identified by it's ID.
/// </summary>
/// <param name="id"></param>
/// <param name="projects"></param>
/// <returns></returns>
[HttpPut("{id}")]
public async Task<IActionResult> PutProject(int id, ScrumProject projects)
{
@ -94,6 +111,11 @@ namespace ScrumTaskboard.Controllers
}
// POST: api/Project
/// <summary>
/// Create a new Project.
/// </summary>
/// <param name="projects"></param>
/// <returns></returns>
[HttpPost]
public async Task<ActionResult<ScrumProject>> PostProject(ScrumProject projects)
{
@ -105,6 +127,11 @@ namespace ScrumTaskboard.Controllers
}
// DELETE: api/Project/5
/// <summary>
/// Delete a Project identified by it's ID.
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[HttpDelete("{id}")]
public async Task<ActionResult<ScrumProject>> DeleteProject(int id)
{

33
ScrumTaskboard/Controllers/SprintsController.cs
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)
{

30
ScrumTaskboard/Controllers/StatusController.cs
View File

@ -25,7 +25,12 @@ namespace ScrumTaskboard.Controllers
}
// GET: api/status
#nullable enable
/// <summary>
/// Retrieve all Status in DB.
/// </summary>
/// <param name="title"></param>
/// <returns></returns>
#nullable enable
[HttpGet]
public async Task<ActionResult<IEnumerable<ScrumStatus>>> GetStatus([FromQuery]string? title)
{
@ -38,9 +43,14 @@ namespace ScrumTaskboard.Controllers
return await filtered.ToListAsync();
}
#nullable enable
#nullable enable
// GET: api/status/1
/// <summary>
/// Retrieve the Status by it's ID.
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[HttpGet("{id}")]
public async Task<ActionResult<ScrumStatus>> GetStatus(int id)
{
@ -55,6 +65,12 @@ namespace ScrumTaskboard.Controllers
}
// PUT: api/status/1
/// <summary>
/// Update the Status identified by it's ID.
/// </summary>
/// <param name="id"></param>
/// <param name="userstory"></param>
/// <returns></returns>
[HttpPut("{id}")]
public async Task<IActionResult> PutStatus(int id, ScrumStatus userstory)
{
@ -89,6 +105,11 @@ namespace ScrumTaskboard.Controllers
}
// POST: api/status
/// <summary>
/// Create a new Status.
/// </summary>
/// <param name="userstory"></param>
/// <returns></returns>
[HttpPost]
public async Task<ActionResult<ScrumStatus>> PostTask(ScrumStatus userstory)
{
@ -100,6 +121,11 @@ namespace ScrumTaskboard.Controllers
}
// DELETE: api/status/1
/// <summary>
/// Create a new Status.
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[HttpDelete("{id}")]
public async Task<ActionResult<ScrumStatus>> DeleteStatus(int id)
{

35
ScrumTaskboard/Controllers/TasksController.cs
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)
{

30
ScrumTaskboard/Controllers/UsersController.cs
View File

@ -25,7 +25,12 @@ namespace ScrumTaskboard.Controllers
}
// GET: api/sprint
#nullable enable
/// <summary>
/// Retrieve all Users in DB.
/// </summary>
/// <param name="name"></param>
/// <returns></returns>
#nullable enable
[HttpGet]
public async Task<ActionResult<IEnumerable<ScrumUser>>> GetUser([FromQuery]string? name)
{
@ -37,9 +42,14 @@ namespace ScrumTaskboard.Controllers
return await filtered.ToListAsync();
}
#nullable disable
#nullable disable
// GET: api/sprint/5
/// <summary>
/// Retrieve the User by it's ID.
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[HttpGet("{id}")]
public async Task<ActionResult<ScrumUser>> GetUser(int id)
{
@ -54,6 +64,12 @@ namespace ScrumTaskboard.Controllers
}
// PUT: api/sprint/5
/// <summary>
/// Update the User identified by it's ID.
/// </summary>
/// <param name="id"></param>
/// <param name="sprint"></param>
/// <returns></returns>
[HttpPut("{id}")]
public async Task<IActionResult> PutUser(int id, ScrumUser sprint)
{
@ -88,6 +104,11 @@ namespace ScrumTaskboard.Controllers
}
// POST: api/User
/// <summary>
/// Create a new User.
/// </summary>
/// <param name="sprint"></param>
/// <returns></returns>
[HttpPost]
public async Task<ActionResult<ScrumUser>> PostUser(ScrumUser sprint)
{
@ -99,6 +120,11 @@ namespace ScrumTaskboard.Controllers
}
// DELETE: api/User/5
/// <summary>
/// Delete a User identified by it's ID.
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[HttpDelete("{id}")]
public async Task<ActionResult<ScrumUser>> DeleteUser(int id)
{

36
ScrumTaskboard/Controllers/UserstoriesController.cs
View File

@ -26,7 +26,18 @@ namespace ScrumTaskboard.Controllers
}
// GET: api/userstories
#nullable enable
/// <summary>
/// Retrieve all Userstories in DB.
/// </summary>
/// <param name="title"></param>
/// <param name="statusid"></param>
/// <param name="categoryid"></param>
/// <param name="createdbyid"></param>
/// <param name="projectid"></param>
/// <param name="sprintid"></param>
/// <param name="priority"></param>
/// <returns></returns>
#nullable enable
[HttpGet]
public async Task<ActionResult<IEnumerable<ScrumUserstory>>> GetUserstory([FromQuery]string? title, [FromQuery]int? statusid, [FromQuery]int? categoryid, [FromQuery]int? createdbyid, [FromQuery]int? projectid, [FromQuery]int? sprintid, [FromQuery]ScrumPrio? priority)
{
@ -64,9 +75,14 @@ namespace ScrumTaskboard.Controllers
return await filtered.ToListAsync();
}
#nullable disable
#nullable disable
// GET: api/userstories/1
/// <summary>
/// Retrieve the Userstory by it's ID.
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[HttpGet("{id}")]
public async Task<ActionResult<ScrumUserstory>> GetUserstory(int id)
{
@ -81,6 +97,12 @@ namespace ScrumTaskboard.Controllers
}
// PUT: api/userstories/1
/// <summary>
/// Update the Userstory identified by it's ID.
/// </summary>
/// <param name="id"></param>
/// <param name="userstory"></param>
/// <returns></returns>
[HttpPut("{id}")]
public async Task<IActionResult> PutUserstory(int id, ScrumUserstory userstory)
{
@ -115,6 +137,11 @@ namespace ScrumTaskboard.Controllers
}
// POST: api/userstories
/// <summary>
/// Create a new Userstory.
/// </summary>
/// <param name="userstory"></param>
/// <returns></returns>
[HttpPost]
public async Task<ActionResult<ScrumUserstory>> PostTask(ScrumUserstory userstory)
{
@ -126,6 +153,11 @@ namespace ScrumTaskboard.Controllers
}
// DELETE: api/userstories/1
/// <summary>
/// Delete a Userstory identified by it's ID.
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
[HttpDelete("{id}")]
public async Task<ActionResult<ScrumUserstory>> DeleteUserstory(int id)
{