AppStd/ReC
8
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor API method names for consistency and clarity

Browse Source 
Renamed public API methods across ReC.Client.Api classes to use concise and uniform names (e.g., CreateAsync, UpdateAsync, DeleteAsync, GetAsync, InvokeAsync). Removed obsolete NETFRAMEWORK preprocessor blocks. Updated summary comment for Results property in ReCClient.cs. These changes improve naming consistency and code clarity throughout the client library.
This commit is contained in:
tekh
2026-01-16 11:42:03 +01:00
parent 8ddaf1d13e
commit b9a40bb12e
8 changed files with 27 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/ReC.Client/Api/CommonApi.cs
View File

@@ -1,8 +1,6 @@
#if NETFRAMEWORK
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
#endif
namespace ReC.Client.Api
{
@@ -29,7 +27,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> CreateObjectAsync<T>(T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> CreateAsync<T>(T procedure, CancellationToken cancel = default)
=> _http.PostAsync("api/Common", ReCClientHelpers.ToJsonContent(procedure), cancel);
/// <summary>
@@ -39,7 +37,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> UpdateObjectAsync<T>(T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> UpdateAsync<T>(T procedure, CancellationToken cancel = default)
=> _http.PutAsync("api/Common", ReCClientHelpers.ToJsonContent(procedure), cancel);
/// <summary>
@@ -49,7 +47,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> DeleteObjectAsync<T>(T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> DeleteAsync<T>(T procedure, CancellationToken cancel = default)
{
var request = new HttpRequestMessage(HttpMethod.Delete, "api/Common")
{

8
src/ReC.Client/Api/EndpointAuthApi.cs
View File

@@ -1,8 +1,6 @@
#if NETFRAMEWORK
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
#endif
namespace ReC.Client.Api
{
@@ -29,7 +27,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> CreateEndpointAuthAsync<T>(T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> CreateAsync<T>(T procedure, CancellationToken cancel = default)
=> _http.PostAsync("api/EndpointAuth", ReCClientHelpers.ToJsonContent(procedure), cancel);
/// <summary>
@@ -40,7 +38,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> UpdateEndpointAuthAsync<T>(long id, T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> UpdateAsync<T>(long id, T procedure, CancellationToken cancel = default)
=> _http.PutAsync($"api/EndpointAuth/{id}", ReCClientHelpers.ToJsonContent(procedure), cancel);
/// <summary>
@@ -50,7 +48,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> DeleteEndpointAuthAsync<T>(T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> DeleteAsync<T>(T procedure, CancellationToken cancel = default)
{
var request = new HttpRequestMessage(HttpMethod.Delete, "api/EndpointAuth")
{

8
src/ReC.Client/Api/EndpointParamsApi.cs
View File

@@ -1,8 +1,6 @@
#if NETFRAMEWORK
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
#endif
namespace ReC.Client.Api
{
@@ -29,7 +27,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> CreateEndpointParamsAsync<T>(T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> CreateAsync<T>(T procedure, CancellationToken cancel = default)
=> _http.PostAsync("api/EndpointParams", ReCClientHelpers.ToJsonContent(procedure), cancel);
/// <summary>
@@ -40,7 +38,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> UpdateEndpointParamsAsync<T>(long id, T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> UpdateAsync<T>(long id, T procedure, CancellationToken cancel = default)
=> _http.PutAsync($"api/EndpointParams/{id}", ReCClientHelpers.ToJsonContent(procedure), cancel);
/// <summary>
@@ -50,7 +48,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> DeleteEndpointParamsAsync<T>(T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> DeleteAsync<T>(T procedure, CancellationToken cancel = default)
{
var request = new HttpRequestMessage(HttpMethod.Delete, "api/EndpointParams")
{

8
src/ReC.Client/Api/EndpointsApi.cs
View File

@@ -1,8 +1,6 @@
#if NETFRAMEWORK
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
#endif
namespace ReC.Client.Api
{
@@ -29,7 +27,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> CreateEndpointAsync<T>(T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> CreateAsync<T>(T procedure, CancellationToken cancel = default)
=> _http.PostAsync("api/Endpoints", ReCClientHelpers.ToJsonContent(procedure), cancel);
/// <summary>
@@ -40,7 +38,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> UpdateEndpointAsync<T>(long id, T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> UpdateAsync<T>(long id, T procedure, CancellationToken cancel = default)
=> _http.PutAsync($"api/Endpoints/{id}", ReCClientHelpers.ToJsonContent(procedure), cancel);
/// <summary>
@@ -50,7 +48,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> DeleteEndpointAsync<T>(T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> DeleteAsync<T>(T procedure, CancellationToken cancel = default)
{
var request = new HttpRequestMessage(HttpMethod.Delete, "api/Endpoints")
{

10
src/ReC.Client/Api/ProfileApi.cs
View File

@@ -1,8 +1,6 @@
#if NETFRAMEWORK
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
#endif
namespace ReC.Client.Api
{
@@ -29,7 +27,7 @@ namespace ReC.Client.Api
/// <param name="includeActions">Whether to include related actions.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> GetProfileAsync(long id, bool includeActions = false, CancellationToken cancel = default)
public Task<HttpResponseMessage> GetAsync(long id, bool includeActions = false, CancellationToken cancel = default)
{
var query = ReCClientHelpers.BuildQuery(("Id", id), ("IncludeActions", includeActions));
return _http.GetAsync($"api/Profile{query}", cancel);
@@ -42,7 +40,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> CreateProfileAsync<T>(T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> CreateAsync<T>(T procedure, CancellationToken cancel = default)
=> _http.PostAsync("api/Profile", ReCClientHelpers.ToJsonContent(procedure), cancel);
/// <summary>
@@ -53,7 +51,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> UpdateProfileAsync<T>(long id, T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> UpdateAsync<T>(long id, T procedure, CancellationToken cancel = default)
=> _http.PutAsync($"api/Profile/{id}", ReCClientHelpers.ToJsonContent(procedure), cancel);
/// <summary>
@@ -63,7 +61,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> DeleteProfilesAsync<T>(T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> DeleteAsync<T>(T procedure, CancellationToken cancel = default)
{
var request = new HttpRequestMessage(HttpMethod.Delete, "api/Profile")
{

12
src/ReC.Client/Api/RecActionApi.cs
View File

@@ -1,8 +1,6 @@
#if NETFRAMEWORK
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
#endif
namespace ReC.Client.Api
{
@@ -28,7 +26,7 @@ namespace ReC.Client.Api
/// <param name="profileId">The profile identifier.</param>
/// <param name="cancellationToken">A token to cancel the operation.</param>
/// <returns><see langword="true"/> if the request succeeds; otherwise, <see langword="false"/>.</returns>
public async Task<bool> InvokeRecActionAsync(int profileId, CancellationToken cancellationToken = default)
public async Task<bool> InvokeAsync(int profileId, CancellationToken cancellationToken = default)
{
var resp = await _http.PostAsync($"api/RecAction/invoke/{profileId}", content: null, cancellationToken);
return resp.IsSuccessStatusCode;
@@ -41,7 +39,7 @@ namespace ReC.Client.Api
/// <param name="invoked">Optional invoked filter.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> GetRecActionsAsync(long? profileId = null, bool? invoked = null, CancellationToken cancel = default)
public Task<HttpResponseMessage> GetAsync(long? profileId = null, bool? invoked = null, CancellationToken cancel = default)
{
var query = ReCClientHelpers.BuildQuery(("ProfileId", profileId), ("Invoked", invoked));
return _http.GetAsync($"api/RecAction{query}", cancel);
@@ -54,7 +52,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> CreateRecActionAsync<T>(T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> CreateAsync<T>(T procedure, CancellationToken cancel = default)
=> _http.PostAsync("api/RecAction", ReCClientHelpers.ToJsonContent(procedure), cancel);
/// <summary>
@@ -65,7 +63,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> UpdateRecActionAsync<T>(long id, T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> UpdateAsync<T>(long id, T procedure, CancellationToken cancel = default)
=> _http.PutAsync($"api/RecAction/{id}", ReCClientHelpers.ToJsonContent(procedure), cancel);
/// <summary>
@@ -75,7 +73,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> DeleteRecActionsAsync<T>(T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> DeleteAsync<T>(T procedure, CancellationToken cancel = default)
{
var request = new HttpRequestMessage(HttpMethod.Delete, "api/RecAction")
{

10
src/ReC.Client/Api/ResultApi.cs
View File

@@ -1,8 +1,6 @@
#if NETFRAMEWORK
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
#endif
namespace ReC.Client.Api
{
@@ -30,7 +28,7 @@ namespace ReC.Client.Api
/// <param name="profileId">Optional profile identifier.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> GetResultsAsync(long? id = null, long? actionId = null, long? profileId = null, CancellationToken cancel = default)
public Task<HttpResponseMessage> GetAsync(long? id = null, long? actionId = null, long? profileId = null, CancellationToken cancel = default)
{
var query = ReCClientHelpers.BuildQuery(("Id", id), ("ActionId", actionId), ("ProfileId", profileId));
return _http.GetAsync($"api/Result{query}", cancel);
@@ -43,7 +41,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> CreateResultAsync<T>(T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> CreateAsync<T>(T procedure, CancellationToken cancel = default)
=> _http.PostAsync("api/Result", ReCClientHelpers.ToJsonContent(procedure), cancel);
/// <summary>
@@ -54,7 +52,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> UpdateResultAsync<T>(long id, T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> UpdateAsync<T>(long id, T procedure, CancellationToken cancel = default)
=> _http.PutAsync($"api/Result/{id}", ReCClientHelpers.ToJsonContent(procedure), cancel);
/// <summary>
@@ -64,7 +62,7 @@ namespace ReC.Client.Api
/// <param name="procedure">The payload to send.</param>
/// <param name="cancel">A token to cancel the operation.</param>
/// <returns>The HTTP response message.</returns>
public Task<HttpResponseMessage> DeleteResultsAsync<T>(T procedure, CancellationToken cancel = default)
public Task<HttpResponseMessage> DeleteAsync<T>(T procedure, CancellationToken cancel = default)
{
var request = new HttpRequestMessage(HttpMethod.Delete, "api/Result")
{

4
src/ReC.Client/ReCClient.cs
View File

@@ -1,7 +1,7 @@
using Microsoft.Extensions.DependencyInjection;
using System;
using System.Net.Http;
using System.Threading.Tasks;
using ReC.Client.Api;
namespace ReC.Client
{
@@ -23,7 +23,7 @@ namespace ReC.Client
public RecActionApi RecActions { get; }
/// <summary>
/// Provides access to OutRes endpoints.
/// Provides access to Result endpoints.
/// </summary>
public ResultApi Results { get; }