fix to remove nullable reference types (the ! to remove the warning) and add documentation comments to the public members.

This commit is contained in:
Bryan Aldrich 2024-12-06 12:26:00 -05:00
parent ee15594da7
commit 12e29e4eeb
8 changed files with 88 additions and 24 deletions

View File

@ -15,6 +15,9 @@ namespace {{packageName}}.Client.Auth
{ {
private TokenResponse{{nrt?}} _token; private TokenResponse{{nrt?}} _token;
/// <summary>
/// Returns the current authentication token. Can return null if there is no authentication token, or it has expired.
/// </summary>
public string{{nrt?}} Token public string{{nrt?}} Token
{ {
get get
@ -76,12 +79,11 @@ namespace {{packageName}}.Client.Auth
/// <summary> /// <summary>
/// Creates an authentication parameter from an access token. /// Creates an authentication parameter from an access token.
/// </summary> /// </summary>
/// <param name="accessToken">Access token to create a parameter from.</param>
/// <returns>An authentication parameter.</returns> /// <returns>An authentication parameter.</returns>
protected async ValueTask<Parameter> GetAuthenticationParameter() protected async ValueTask<Parameter> GetAuthenticationParameter()
{ {
var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token; var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;
return new HeaderParameter(KnownHeaders.Authorization, token!); return new HeaderParameter(KnownHeaders.Authorization, token);
} }
/// <summary> /// <summary>
@ -96,7 +98,7 @@ namespace {{packageName}}.Client.Auth
if (!string.IsNullOrWhiteSpace(_token?.RefreshToken)) if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))
{ {
request.AddParameter("grant_type", "refresh_token") request.AddParameter("grant_type", "refresh_token")
.AddParameter("refresh_token", _token!.RefreshToken); .AddParameter("refresh_token", _token.RefreshToken);
} }
else else
{ {
@ -122,6 +124,12 @@ namespace {{packageName}}.Client.Auth
} }
} }
/// <summary>
/// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <returns></returns>
public async ValueTask Authenticate(IRestClient client, RestRequest request) public async ValueTask Authenticate(IRestClient client, RestRequest request)
=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false)); => request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));
} }

View File

@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth
{ {
private TokenResponse _token; private TokenResponse _token;
/// <summary>
/// Returns the current authentication token. Can return null if there is no authentication token, or it has expired.
/// </summary>
public string Token public string Token
{ {
get get
@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth
/// <summary> /// <summary>
/// Creates an authentication parameter from an access token. /// Creates an authentication parameter from an access token.
/// </summary> /// </summary>
/// <param name="accessToken">Access token to create a parameter from.</param>
/// <returns>An authentication parameter.</returns> /// <returns>An authentication parameter.</returns>
protected async ValueTask<Parameter> GetAuthenticationParameter() protected async ValueTask<Parameter> GetAuthenticationParameter()
{ {
var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token; var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;
return new HeaderParameter(KnownHeaders.Authorization, token!); return new HeaderParameter(KnownHeaders.Authorization, token);
} }
/// <summary> /// <summary>
@ -104,7 +106,7 @@ namespace Org.OpenAPITools.Client.Auth
if (!string.IsNullOrWhiteSpace(_token?.RefreshToken)) if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))
{ {
request.AddParameter("grant_type", "refresh_token") request.AddParameter("grant_type", "refresh_token")
.AddParameter("refresh_token", _token!.RefreshToken); .AddParameter("refresh_token", _token.RefreshToken);
} }
else else
{ {
@ -130,6 +132,12 @@ namespace Org.OpenAPITools.Client.Auth
} }
} }
/// <summary>
/// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <returns></returns>
public async ValueTask Authenticate(IRestClient client, RestRequest request) public async ValueTask Authenticate(IRestClient client, RestRequest request)
=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false)); => request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));
} }

View File

@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth
{ {
private TokenResponse _token; private TokenResponse _token;
/// <summary>
/// Returns the current authentication token. Can return null if there is no authentication token, or it has expired.
/// </summary>
public string Token public string Token
{ {
get get
@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth
/// <summary> /// <summary>
/// Creates an authentication parameter from an access token. /// Creates an authentication parameter from an access token.
/// </summary> /// </summary>
/// <param name="accessToken">Access token to create a parameter from.</param>
/// <returns>An authentication parameter.</returns> /// <returns>An authentication parameter.</returns>
protected async ValueTask<Parameter> GetAuthenticationParameter() protected async ValueTask<Parameter> GetAuthenticationParameter()
{ {
var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token; var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;
return new HeaderParameter(KnownHeaders.Authorization, token!); return new HeaderParameter(KnownHeaders.Authorization, token);
} }
/// <summary> /// <summary>
@ -104,7 +106,7 @@ namespace Org.OpenAPITools.Client.Auth
if (!string.IsNullOrWhiteSpace(_token?.RefreshToken)) if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))
{ {
request.AddParameter("grant_type", "refresh_token") request.AddParameter("grant_type", "refresh_token")
.AddParameter("refresh_token", _token!.RefreshToken); .AddParameter("refresh_token", _token.RefreshToken);
} }
else else
{ {
@ -130,6 +132,12 @@ namespace Org.OpenAPITools.Client.Auth
} }
} }
/// <summary>
/// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <returns></returns>
public async ValueTask Authenticate(IRestClient client, RestRequest request) public async ValueTask Authenticate(IRestClient client, RestRequest request)
=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false)); => request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));
} }

View File

@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth
{ {
private TokenResponse _token; private TokenResponse _token;
/// <summary>
/// Returns the current authentication token. Can return null if there is no authentication token, or it has expired.
/// </summary>
public string Token public string Token
{ {
get get
@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth
/// <summary> /// <summary>
/// Creates an authentication parameter from an access token. /// Creates an authentication parameter from an access token.
/// </summary> /// </summary>
/// <param name="accessToken">Access token to create a parameter from.</param>
/// <returns>An authentication parameter.</returns> /// <returns>An authentication parameter.</returns>
protected async ValueTask<Parameter> GetAuthenticationParameter() protected async ValueTask<Parameter> GetAuthenticationParameter()
{ {
var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token; var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;
return new HeaderParameter(KnownHeaders.Authorization, token!); return new HeaderParameter(KnownHeaders.Authorization, token);
} }
/// <summary> /// <summary>
@ -104,7 +106,7 @@ namespace Org.OpenAPITools.Client.Auth
if (!string.IsNullOrWhiteSpace(_token?.RefreshToken)) if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))
{ {
request.AddParameter("grant_type", "refresh_token") request.AddParameter("grant_type", "refresh_token")
.AddParameter("refresh_token", _token!.RefreshToken); .AddParameter("refresh_token", _token.RefreshToken);
} }
else else
{ {
@ -130,6 +132,12 @@ namespace Org.OpenAPITools.Client.Auth
} }
} }
/// <summary>
/// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <returns></returns>
public async ValueTask Authenticate(IRestClient client, RestRequest request) public async ValueTask Authenticate(IRestClient client, RestRequest request)
=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false)); => request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));
} }

View File

@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth
{ {
private TokenResponse? _token; private TokenResponse? _token;
/// <summary>
/// Returns the current authentication token. Can return null if there is no authentication token, or it has expired.
/// </summary>
public string? Token public string? Token
{ {
get get
@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth
/// <summary> /// <summary>
/// Creates an authentication parameter from an access token. /// Creates an authentication parameter from an access token.
/// </summary> /// </summary>
/// <param name="accessToken">Access token to create a parameter from.</param>
/// <returns>An authentication parameter.</returns> /// <returns>An authentication parameter.</returns>
protected async ValueTask<Parameter> GetAuthenticationParameter() protected async ValueTask<Parameter> GetAuthenticationParameter()
{ {
var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token; var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;
return new HeaderParameter(KnownHeaders.Authorization, token!); return new HeaderParameter(KnownHeaders.Authorization, token);
} }
/// <summary> /// <summary>
@ -104,7 +106,7 @@ namespace Org.OpenAPITools.Client.Auth
if (!string.IsNullOrWhiteSpace(_token?.RefreshToken)) if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))
{ {
request.AddParameter("grant_type", "refresh_token") request.AddParameter("grant_type", "refresh_token")
.AddParameter("refresh_token", _token!.RefreshToken); .AddParameter("refresh_token", _token.RefreshToken);
} }
else else
{ {
@ -130,6 +132,12 @@ namespace Org.OpenAPITools.Client.Auth
} }
} }
/// <summary>
/// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <returns></returns>
public async ValueTask Authenticate(IRestClient client, RestRequest request) public async ValueTask Authenticate(IRestClient client, RestRequest request)
=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false)); => request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));
} }

View File

@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth
{ {
private TokenResponse? _token; private TokenResponse? _token;
/// <summary>
/// Returns the current authentication token. Can return null if there is no authentication token, or it has expired.
/// </summary>
public string? Token public string? Token
{ {
get get
@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth
/// <summary> /// <summary>
/// Creates an authentication parameter from an access token. /// Creates an authentication parameter from an access token.
/// </summary> /// </summary>
/// <param name="accessToken">Access token to create a parameter from.</param>
/// <returns>An authentication parameter.</returns> /// <returns>An authentication parameter.</returns>
protected async ValueTask<Parameter> GetAuthenticationParameter() protected async ValueTask<Parameter> GetAuthenticationParameter()
{ {
var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token; var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;
return new HeaderParameter(KnownHeaders.Authorization, token!); return new HeaderParameter(KnownHeaders.Authorization, token);
} }
/// <summary> /// <summary>
@ -104,7 +106,7 @@ namespace Org.OpenAPITools.Client.Auth
if (!string.IsNullOrWhiteSpace(_token?.RefreshToken)) if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))
{ {
request.AddParameter("grant_type", "refresh_token") request.AddParameter("grant_type", "refresh_token")
.AddParameter("refresh_token", _token!.RefreshToken); .AddParameter("refresh_token", _token.RefreshToken);
} }
else else
{ {
@ -130,6 +132,12 @@ namespace Org.OpenAPITools.Client.Auth
} }
} }
/// <summary>
/// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <returns></returns>
public async ValueTask Authenticate(IRestClient client, RestRequest request) public async ValueTask Authenticate(IRestClient client, RestRequest request)
=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false)); => request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));
} }

View File

@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth
{ {
private TokenResponse _token; private TokenResponse _token;
/// <summary>
/// Returns the current authentication token. Can return null if there is no authentication token, or it has expired.
/// </summary>
public string Token public string Token
{ {
get get
@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth
/// <summary> /// <summary>
/// Creates an authentication parameter from an access token. /// Creates an authentication parameter from an access token.
/// </summary> /// </summary>
/// <param name="accessToken">Access token to create a parameter from.</param>
/// <returns>An authentication parameter.</returns> /// <returns>An authentication parameter.</returns>
protected async ValueTask<Parameter> GetAuthenticationParameter() protected async ValueTask<Parameter> GetAuthenticationParameter()
{ {
var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token; var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;
return new HeaderParameter(KnownHeaders.Authorization, token!); return new HeaderParameter(KnownHeaders.Authorization, token);
} }
/// <summary> /// <summary>
@ -104,7 +106,7 @@ namespace Org.OpenAPITools.Client.Auth
if (!string.IsNullOrWhiteSpace(_token?.RefreshToken)) if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))
{ {
request.AddParameter("grant_type", "refresh_token") request.AddParameter("grant_type", "refresh_token")
.AddParameter("refresh_token", _token!.RefreshToken); .AddParameter("refresh_token", _token.RefreshToken);
} }
else else
{ {
@ -130,6 +132,12 @@ namespace Org.OpenAPITools.Client.Auth
} }
} }
/// <summary>
/// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <returns></returns>
public async ValueTask Authenticate(IRestClient client, RestRequest request) public async ValueTask Authenticate(IRestClient client, RestRequest request)
=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false)); => request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));
} }

View File

@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth
{ {
private TokenResponse _token; private TokenResponse _token;
/// <summary>
/// Returns the current authentication token. Can return null if there is no authentication token, or it has expired.
/// </summary>
public string Token public string Token
{ {
get get
@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth
/// <summary> /// <summary>
/// Creates an authentication parameter from an access token. /// Creates an authentication parameter from an access token.
/// </summary> /// </summary>
/// <param name="accessToken">Access token to create a parameter from.</param>
/// <returns>An authentication parameter.</returns> /// <returns>An authentication parameter.</returns>
protected async ValueTask<Parameter> GetAuthenticationParameter() protected async ValueTask<Parameter> GetAuthenticationParameter()
{ {
var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token; var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;
return new HeaderParameter(KnownHeaders.Authorization, token!); return new HeaderParameter(KnownHeaders.Authorization, token);
} }
/// <summary> /// <summary>
@ -104,7 +106,7 @@ namespace Org.OpenAPITools.Client.Auth
if (!string.IsNullOrWhiteSpace(_token?.RefreshToken)) if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))
{ {
request.AddParameter("grant_type", "refresh_token") request.AddParameter("grant_type", "refresh_token")
.AddParameter("refresh_token", _token!.RefreshToken); .AddParameter("refresh_token", _token.RefreshToken);
} }
else else
{ {
@ -130,6 +132,12 @@ namespace Org.OpenAPITools.Client.Auth
} }
} }
/// <summary>
/// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <returns></returns>
public async ValueTask Authenticate(IRestClient client, RestRequest request) public async ValueTask Authenticate(IRestClient client, RestRequest request)
=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false)); => request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));
} }