diff --git a/modules/openapi-generator/src/main/resources/csharp/auth/OAuthAuthenticator.mustache b/modules/openapi-generator/src/main/resources/csharp/auth/OAuthAuthenticator.mustache index 2e5a0521281..c336c8ad5cc 100644 --- a/modules/openapi-generator/src/main/resources/csharp/auth/OAuthAuthenticator.mustache +++ b/modules/openapi-generator/src/main/resources/csharp/auth/OAuthAuthenticator.mustache @@ -15,6 +15,9 @@ namespace {{packageName}}.Client.Auth { private TokenResponse{{nrt?}} _token; + /// + /// Returns the current authentication token. Can return null if there is no authentication token, or it has expired. + /// public string{{nrt?}} Token { get @@ -76,12 +79,11 @@ namespace {{packageName}}.Client.Auth /// /// Creates an authentication parameter from an access token. /// - /// Access token to create a parameter from. /// An authentication parameter. protected async ValueTask GetAuthenticationParameter() { var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token; - return new HeaderParameter(KnownHeaders.Authorization, token!); + return new HeaderParameter(KnownHeaders.Authorization, token); } /// @@ -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 } } + /// + /// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request + /// + /// + /// + /// public async ValueTask Authenticate(IRestClient client, RestRequest request) => request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false)); } diff --git a/samples/client/petstore/csharp/restsharp/net4.7/MultipleFrameworks/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs b/samples/client/petstore/csharp/restsharp/net4.7/MultipleFrameworks/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs index 9e2c72fa261..e731f1c71be 100644 --- a/samples/client/petstore/csharp/restsharp/net4.7/MultipleFrameworks/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs +++ b/samples/client/petstore/csharp/restsharp/net4.7/MultipleFrameworks/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs @@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth { private TokenResponse _token; + /// + /// Returns the current authentication token. Can return null if there is no authentication token, or it has expired. + /// public string Token { get @@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth /// /// Creates an authentication parameter from an access token. /// - /// Access token to create a parameter from. /// An authentication parameter. protected async ValueTask GetAuthenticationParameter() { var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token; - return new HeaderParameter(KnownHeaders.Authorization, token!); + return new HeaderParameter(KnownHeaders.Authorization, token); } /// @@ -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 } } + /// + /// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request + /// + /// + /// + /// public async ValueTask Authenticate(IRestClient client, RestRequest request) => request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false)); } diff --git a/samples/client/petstore/csharp/restsharp/net4.7/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs b/samples/client/petstore/csharp/restsharp/net4.7/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs index c956b85c618..6c6817ef501 100644 --- a/samples/client/petstore/csharp/restsharp/net4.7/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs +++ b/samples/client/petstore/csharp/restsharp/net4.7/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs @@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth { private TokenResponse _token; + /// + /// Returns the current authentication token. Can return null if there is no authentication token, or it has expired. + /// public string Token { get @@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth /// /// Creates an authentication parameter from an access token. /// - /// Access token to create a parameter from. /// An authentication parameter. protected async ValueTask GetAuthenticationParameter() { var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token; - return new HeaderParameter(KnownHeaders.Authorization, token!); + return new HeaderParameter(KnownHeaders.Authorization, token); } /// @@ -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 } } + /// + /// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request + /// + /// + /// + /// public async ValueTask Authenticate(IRestClient client, RestRequest request) => request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false)); } diff --git a/samples/client/petstore/csharp/restsharp/net4.8/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs b/samples/client/petstore/csharp/restsharp/net4.8/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs index c956b85c618..6c6817ef501 100644 --- a/samples/client/petstore/csharp/restsharp/net4.8/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs +++ b/samples/client/petstore/csharp/restsharp/net4.8/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs @@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth { private TokenResponse _token; + /// + /// Returns the current authentication token. Can return null if there is no authentication token, or it has expired. + /// public string Token { get @@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth /// /// Creates an authentication parameter from an access token. /// - /// Access token to create a parameter from. /// An authentication parameter. protected async ValueTask GetAuthenticationParameter() { var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token; - return new HeaderParameter(KnownHeaders.Authorization, token!); + return new HeaderParameter(KnownHeaders.Authorization, token); } /// @@ -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 } } + /// + /// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request + /// + /// + /// + /// public async ValueTask Authenticate(IRestClient client, RestRequest request) => request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false)); } diff --git a/samples/client/petstore/csharp/restsharp/net7/EnumMappings/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs b/samples/client/petstore/csharp/restsharp/net7/EnumMappings/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs index 7685a3763bb..bcccf1e83f6 100644 --- a/samples/client/petstore/csharp/restsharp/net7/EnumMappings/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs +++ b/samples/client/petstore/csharp/restsharp/net7/EnumMappings/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs @@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth { private TokenResponse? _token; + /// + /// Returns the current authentication token. Can return null if there is no authentication token, or it has expired. + /// public string? Token { get @@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth /// /// Creates an authentication parameter from an access token. /// - /// Access token to create a parameter from. /// An authentication parameter. protected async ValueTask GetAuthenticationParameter() { var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token; - return new HeaderParameter(KnownHeaders.Authorization, token!); + return new HeaderParameter(KnownHeaders.Authorization, token); } /// @@ -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 } } + /// + /// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request + /// + /// + /// + /// public async ValueTask Authenticate(IRestClient client, RestRequest request) => request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false)); } diff --git a/samples/client/petstore/csharp/restsharp/net7/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs b/samples/client/petstore/csharp/restsharp/net7/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs index 7685a3763bb..bcccf1e83f6 100644 --- a/samples/client/petstore/csharp/restsharp/net7/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs +++ b/samples/client/petstore/csharp/restsharp/net7/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs @@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth { private TokenResponse? _token; + /// + /// Returns the current authentication token. Can return null if there is no authentication token, or it has expired. + /// public string? Token { get @@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth /// /// Creates an authentication parameter from an access token. /// - /// Access token to create a parameter from. /// An authentication parameter. protected async ValueTask GetAuthenticationParameter() { var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token; - return new HeaderParameter(KnownHeaders.Authorization, token!); + return new HeaderParameter(KnownHeaders.Authorization, token); } /// @@ -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 } } + /// + /// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request + /// + /// + /// + /// public async ValueTask Authenticate(IRestClient client, RestRequest request) => request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false)); } diff --git a/samples/client/petstore/csharp/restsharp/standard2.0/ConditionalSerialization/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs b/samples/client/petstore/csharp/restsharp/standard2.0/ConditionalSerialization/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs index c956b85c618..6c6817ef501 100644 --- a/samples/client/petstore/csharp/restsharp/standard2.0/ConditionalSerialization/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs +++ b/samples/client/petstore/csharp/restsharp/standard2.0/ConditionalSerialization/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs @@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth { private TokenResponse _token; + /// + /// Returns the current authentication token. Can return null if there is no authentication token, or it has expired. + /// public string Token { get @@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth /// /// Creates an authentication parameter from an access token. /// - /// Access token to create a parameter from. /// An authentication parameter. protected async ValueTask GetAuthenticationParameter() { var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token; - return new HeaderParameter(KnownHeaders.Authorization, token!); + return new HeaderParameter(KnownHeaders.Authorization, token); } /// @@ -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 } } + /// + /// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request + /// + /// + /// + /// public async ValueTask Authenticate(IRestClient client, RestRequest request) => request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false)); } diff --git a/samples/client/petstore/csharp/restsharp/standard2.0/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs b/samples/client/petstore/csharp/restsharp/standard2.0/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs index c956b85c618..6c6817ef501 100644 --- a/samples/client/petstore/csharp/restsharp/standard2.0/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs +++ b/samples/client/petstore/csharp/restsharp/standard2.0/Petstore/src/Org.OpenAPITools/Client/Auth/OAuthAuthenticator.cs @@ -23,6 +23,9 @@ namespace Org.OpenAPITools.Client.Auth { private TokenResponse _token; + /// + /// Returns the current authentication token. Can return null if there is no authentication token, or it has expired. + /// public string Token { get @@ -84,12 +87,11 @@ namespace Org.OpenAPITools.Client.Auth /// /// Creates an authentication parameter from an access token. /// - /// Access token to create a parameter from. /// An authentication parameter. protected async ValueTask GetAuthenticationParameter() { var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token; - return new HeaderParameter(KnownHeaders.Authorization, token!); + return new HeaderParameter(KnownHeaders.Authorization, token); } /// @@ -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 } } + /// + /// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request + /// + /// + /// + /// public async ValueTask Authenticate(IRestClient client, RestRequest request) => request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false)); }