anas/divan
1
0
Fork 0
Code Issues 12 Pull Requests Actions Packages Projects Releases Wiki Activity

#45 adding audio-upload-enabled header to reduce the need for a separate query

Browse Source
This commit is contained in:
Hamid Reza Mohammadi 2020-12-12 20:17:40 +03:30
parent 893a0dfdac
commit 1456e5bb43
3 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
RMuseum/Controllers/RecitationController.cs
View File

@ -102,6 +102,7 @@ namespace RMuseum.Controllers
/// <param name="allUsers">default: false, user must have recitation::moderate permission to be able to see all users narrations</param>
/// <param name="status">default: -1, unfiltered</param>
/// <param name="searchTerm"></param>
/// <remarks>additional headers: paging-headers, audio-upload-enabled</remarks>
/// <returns></returns>
[HttpGet]
[Authorize]
@ -138,6 +139,9 @@ namespace RMuseum.Controllers
// Paging Header
HttpContext.Response.Headers.Add("paging-headers", JsonConvert.SerializeObject(res.Result.PagingMeta));
//adding audio upload enabled header to reduce need for a separate query
HttpContext.Response.Headers.Add("audio-upload-enabled", JsonConvert.SerializeObject(_audioService.UploadEnabled));
return Ok(res.Result.Items);
}
@ -371,6 +375,7 @@ namespace RMuseum.Controllers
/// <param name="paging"></param>
/// <param name="allUsers">default: false, user must have recitation::moderate permission to be able to see all users uploads</param>
/// <returns></returns>
/// <remarks>additional headers: paging-headers, audio-upload-enabled</remarks>
[HttpGet("uploads")]
[Authorize]
[ProducesResponseType((int)HttpStatusCode.OK, Type = typeof(IEnumerable<UploadedItemViewModel>))]
@ -407,12 +412,17 @@ namespace RMuseum.Controllers
// Paging Header
HttpContext.Response.Headers.Add("paging-headers", JsonConvert.SerializeObject(res.Result.PagingMeta));
//adding audio upload enabled header to reduce need for a separate query
HttpContext.Response.Headers.Add("audio-upload-enabled", JsonConvert.SerializeObject(_audioService.UploadEnabled));
return Ok(res.Result.Items);
}
/// <summary>
/// upload, update, moderate and delete operations on recitations might temporarily become disabled,
/// this method gets the current status
/// remarks: the value of this flag is provided as a custom header called audio-upload-enabled in some common GET methods
/// in order to reduce the need for a separate query
/// </summary>
/// <returns></returns>

4
RMuseum/RMuseum.xml
View File

@ -754,6 +754,7 @@
<param name="allUsers">default: false, user must have recitation::moderate permission to be able to see all users narrations</param>
<param name="status">default: -1, unfiltered</param>
<param name="searchTerm"></param>
<remarks>additional headers: paging-headers, audio-upload-enabled</remarks>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.GetMp3File(System.Int32)">
@ -820,11 +821,14 @@
<param name="paging"></param>
<param name="allUsers">default: false, user must have recitation::moderate permission to be able to see all users uploads</param>
<returns></returns>
<remarks>additional headers: paging-headers, audio-upload-enabled</remarks>
</member>
<member name="M:RMuseum.Controllers.RecitationController.IsUploadEnabled">
<summary>
upload, update, moderate and delete operations on recitations might temporarily become disabled,
this method gets the current status
remarks: the value of this flag is provided as a custom header called audio-upload-enabled in some common GET methods
in order to reduce the need for a separate query
</summary>
<returns></returns>
</member>

2
RMuseum/Startup.cs
View File

@ -56,7 +56,7 @@ namespace RMuseum
builder => builder.SetIsOriginAllowed(_ => true)
.AllowAnyMethod()
.AllowAnyHeader()
.WithExposedHeaders("paging-headers")
.WithExposedHeaders("paging-headers", "audio-upload-enabled")
.AllowCredentials()
);
});