loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-05-12 20:50:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
modules/openapi-generator/src/main/resources/csharp/auth/OAuthAuthenticator.mustache vendored
View File

@ -15,6 +15,9 @@ namespace {{packageName}}.Client.Auth
{
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
{
get
@ -76,12 +79,11 @@ namespace {{packageName}}.Client.Auth
/// <summary>
/// Creates an authentication parameter from an access token.
/// </summary>
/// <param name="accessToken">Access token to create a parameter from.</param>
/// <returns>An authentication parameter.</returns>
protected async ValueTask<Parameter> GetAuthenticationParameter()
{
var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;
return new HeaderParameter(KnownHeaders.Authorization, token!);
return new HeaderParameter(KnownHeaders.Authorization, token);
}
/// <summary>
@ -96,7 +98,7 @@ namespace {{packageName}}.Client.Auth
if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))
{
request.AddParameter("grant_type", "refresh_token")
.AddParameter("refresh_token", _token!.RefreshToken);
.AddParameter("refresh_token", _token.RefreshToken);
}
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)
=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));
}

14
samples/client/petstore/csharp/restsharp/net4.7/MultipleFrameworks/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs
View File

@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth
{
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
{
get
@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth
/// <summary>
/// Creates an authentication parameter from an access token.
/// </summary>
/// <param name="accessToken">Access token to create a parameter from.</param>
/// <returns>An authentication parameter.</returns>
protected async ValueTask<Parameter> GetAuthenticationParameter()
{
var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;
return new HeaderParameter(KnownHeaders.Authorization, token!);
return new HeaderParameter(KnownHeaders.Authorization, token);
}
/// <summary>
@ -104,7 +106,7 @@ namespace Org.OpenAPITools.Client.Auth
if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))
{
request.AddParameter("grant_type", "refresh_token")
.AddParameter("refresh_token", _token!.RefreshToken);
.AddParameter("refresh_token", _token.RefreshToken);
}
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)
=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));
}

14
samples/client/petstore/csharp/restsharp/net4.7/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs
View File

@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth
{
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
{
get
@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth
/// <summary>
/// Creates an authentication parameter from an access token.
/// </summary>
/// <param name="accessToken">Access token to create a parameter from.</param>
/// <returns>An authentication parameter.</returns>
protected async ValueTask<Parameter> GetAuthenticationParameter()
{
var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;
return new HeaderParameter(KnownHeaders.Authorization, token!);
return new HeaderParameter(KnownHeaders.Authorization, token);
}
/// <summary>
@ -104,7 +106,7 @@ namespace Org.OpenAPITools.Client.Auth
if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))
{
request.AddParameter("grant_type", "refresh_token")
.AddParameter("refresh_token", _token!.RefreshToken);
.AddParameter("refresh_token", _token.RefreshToken);
}
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)
=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));
}

14
samples/client/petstore/csharp/restsharp/net4.8/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs
View File

@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth
{
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
{
get
@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth
/// <summary>
/// Creates an authentication parameter from an access token.
/// </summary>
/// <param name="accessToken">Access token to create a parameter from.</param>
/// <returns>An authentication parameter.</returns>
protected async ValueTask<Parameter> GetAuthenticationParameter()
{
var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;
return new HeaderParameter(KnownHeaders.Authorization, token!);
return new HeaderParameter(KnownHeaders.Authorization, token);
}
/// <summary>
@ -104,7 +106,7 @@ namespace Org.OpenAPITools.Client.Auth
if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))
{
request.AddParameter("grant_type", "refresh_token")
.AddParameter("refresh_token", _token!.RefreshToken);
.AddParameter("refresh_token", _token.RefreshToken);
}
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)
=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));
}

14
samples/client/petstore/csharp/restsharp/net7/EnumMappings/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs
View File

@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth
{
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
{
get
@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth
/// <summary>
/// Creates an authentication parameter from an access token.
/// </summary>
/// <param name="accessToken">Access token to create a parameter from.</param>
/// <returns>An authentication parameter.</returns>
protected async ValueTask<Parameter> GetAuthenticationParameter()
{
var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;
return new HeaderParameter(KnownHeaders.Authorization, token!);
return new HeaderParameter(KnownHeaders.Authorization, token);
}
/// <summary>
@ -104,7 +106,7 @@ namespace Org.OpenAPITools.Client.Auth
if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))
{
request.AddParameter("grant_type", "refresh_token")
.AddParameter("refresh_token", _token!.RefreshToken);
.AddParameter("refresh_token", _token.RefreshToken);
}
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)
=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));
}

14
samples/client/petstore/csharp/restsharp/net7/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs
View File

@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth
{
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
{
get
@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth
/// <summary>
/// Creates an authentication parameter from an access token.
/// </summary>
/// <param name="accessToken">Access token to create a parameter from.</param>
/// <returns>An authentication parameter.</returns>
protected async ValueTask<Parameter> GetAuthenticationParameter()
{
var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;
return new HeaderParameter(KnownHeaders.Authorization, token!);
return new HeaderParameter(KnownHeaders.Authorization, token);
}
/// <summary>
@ -104,7 +106,7 @@ namespace Org.OpenAPITools.Client.Auth
if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))
{
request.AddParameter("grant_type", "refresh_token")
.AddParameter("refresh_token", _token!.RefreshToken);
.AddParameter("refresh_token", _token.RefreshToken);
}
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)
=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));
}

14
samples/client/petstore/csharp/restsharp/standard2.0/ConditionalSerialization/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs
View File

@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth
{
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
{
get
@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth
/// <summary>
/// Creates an authentication parameter from an access token.
/// </summary>
/// <param name="accessToken">Access token to create a parameter from.</param>
/// <returns>An authentication parameter.</returns>
protected async ValueTask<Parameter> GetAuthenticationParameter()
{
var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;
return new HeaderParameter(KnownHeaders.Authorization, token!);
return new HeaderParameter(KnownHeaders.Authorization, token);
}
/// <summary>
@ -104,7 +106,7 @@ namespace Org.OpenAPITools.Client.Auth
if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))
{
request.AddParameter("grant_type", "refresh_token")
.AddParameter("refresh_token", _token!.RefreshToken);
.AddParameter("refresh_token", _token.RefreshToken);
}
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)
=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));
}

14
samples/client/petstore/csharp/restsharp/standard2.0/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs
View File

@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth
{
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
{
get
@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth
/// <summary>
/// Creates an authentication parameter from an access token.
/// </summary>
/// <param name="accessToken">Access token to create a parameter from.</param>
/// <returns>An authentication parameter.</returns>
protected async ValueTask<Parameter> GetAuthenticationParameter()
{
var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;
return new HeaderParameter(KnownHeaders.Authorization, token!);
return new HeaderParameter(KnownHeaders.Authorization, token);
}
/// <summary>
@ -104,7 +106,7 @@ namespace Org.OpenAPITools.Client.Auth
if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))
{
request.AddParameter("grant_type", "refresh_token")
.AddParameter("refresh_token", _token!.RefreshToken);
.AddParameter("refresh_token", _token.RefreshToken);
}
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)
=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));
}