Swagger Documentation Enhancement (273)

This commit is contained in:
Santhosh S
2023-08-24 21:25:38 -04:00
parent 9345ee2ca5
commit e56ffae1a4
22 changed files with 288 additions and 49 deletions

View File

@ -14,6 +14,9 @@ namespace DamageAssesment.Api.Surveys.Controllers
{
this.surveyProvider = surveyProvider;
}
/// <summary>
/// GET request for retrieving surveys.
/// </summary>
[HttpGet]
public async Task<ActionResult> GetSurveysAsync()
@ -25,6 +28,10 @@ namespace DamageAssesment.Api.Surveys.Controllers
}
return NoContent();
}
/// <summary>
/// GET request for retrieving surveys by ID.
/// </summary>
[HttpGet("{Id}")]
public async Task<ActionResult> GetSurveysAsync(int Id)
{
@ -35,6 +42,9 @@ namespace DamageAssesment.Api.Surveys.Controllers
}
return NotFound();
}
/// <summary>
/// POST request for creating a new survey.
/// </summary>
[HttpPost]
public async Task<ActionResult> PostSurveysAsync(Models.Survey survey)
@ -46,6 +56,10 @@ namespace DamageAssesment.Api.Surveys.Controllers
}
return BadRequest(result.ErrorMessage);
}
/// <summary>
/// PUT request for updating an existing survey (surveyId,Updated Survey data).
/// </summary>
[HttpPut("{Id}")]
public async Task<ActionResult> PutSurveysAsync(int Id, Models.Survey survey)
@ -60,7 +74,10 @@ namespace DamageAssesment.Api.Surveys.Controllers
return BadRequest(result.ErrorMessage);
}
/// <summary>
/// DELETE request for deleting a survey by ID.
/// </summary>
[HttpDelete("{Id}")]
public async Task<ActionResult> DeleteSurveysAsync(int Id)
{