Skip to content
Snippets Groups Projects
Commit 081ac501 authored by Theresia Rupprecht's avatar Theresia Rupprecht
Browse files

New: Add documentation for treeAPI(coscine/issues#1108)

parent 555d10b3
No related branches found
No related tags found
1 merge request!7Topic/1108 docu blob api
......@@ -76,7 +76,7 @@ namespace Coscine.Api.Blob.Controllers
/// This method returns the amount of allocated space for the given resource
/// </summary>
/// <param name="resourceId">Id of a resource</param>
/// <returns>Data, file count and bytesize used </returns>
/// <returns>Data, file count and bytesize used or Status Code 400 or 404 or 401 0r 500 </returns>
[HttpGet("[controller]/{resourceId}/quota")]
public IActionResult GetQuota (string resourceId)
{
......@@ -157,11 +157,11 @@ namespace Coscine.Api.Blob.Controllers
// This may be a problem for other provider!
/// <summary>
/// This method checks if the given file exists
/// This method checks if the given file exists and returns it
/// </summary>
/// <param name="resourceId">Id of the resource</param>
/// <param name="path"> Path to the file </param>
/// <returns>Ok if file exists otherwise error </returns>
/// <returns>Ok if file exists otherwise Statuscode 400 or 401 or 404 or 204 </returns>
[HttpGet("[controller]/{resourceId}/{*path}")]
[DisableRequestSizeLimit]
public async Task<IActionResult> GetFile(string resourceId, string path)
......@@ -233,7 +233,7 @@ namespace Coscine.Api.Blob.Controllers
/// </summary>
/// <param name="resourceId">Id of the resource </param>
/// <param name="path">Path to the file</param>
/// <returns>Ok if file is uploaded otherwise error</returns>
/// <returns>Ok if file is uploaded otherwise Statuscode 400 or 401 or 404 or 204</returns>
[HttpPut("[controller]/{resourceId}/{*path}")]
[DisableRequestSizeLimit]
public async Task<IActionResult> UploadFile(string resourceId, string path)
......@@ -318,7 +318,7 @@ namespace Coscine.Api.Blob.Controllers
/// </summary>
/// <param name="resourceId">Id of the resource </param>
/// <param name="path">Path to the file</param>
/// <returns>Ok if deletion successful otherwise returns error </returns>
/// <returns>Ok if deletion successful otherwise Statuscode 400 or 401 or 404 or 204 </returns>
[HttpDelete("[controller]/{resourceId}/{*path}")]
public async Task<IActionResult> DeleteFile(string resourceId, string path)
{
......@@ -382,7 +382,7 @@ namespace Coscine.Api.Blob.Controllers
/// <summary>
/// This method checks if the resource is valid
/// </summary>
/// <returns>Ok if resource is valid otherwise returns error</returns>
/// <returns>Ok if resource is valid otherwise Statuscode 400 or 404 or 204</returns>
[HttpPost("[controller]/validate")]
public async Task<IActionResult> IsResourceValid([FromBody] JToken resource)
{
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment