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

BryanAldrich · BryanAldrich · commit 12e29e4eeb0c · 2024-12-06T12:26:00.000-05:00
diff --git 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;
 
+        /// <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));
     }
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
@@ -23,6 +23,9 @@ public class OAuthAuthenticator : IAuthenticator
     {
         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 @@ public OAuthAuthenticator(
         /// <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 @@ async Task<string> GetToken()
             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 @@ async Task<string> GetToken()
             }
         }
 
+        /// <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));
     }
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
@@ -23,6 +23,9 @@ public class OAuthAuthenticator : IAuthenticator
     {
         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 @@ public OAuthAuthenticator(
         /// <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 @@ async Task<string> GetToken()
             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 @@ async Task<string> GetToken()
             }
         }
 
+        /// <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));
     }
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
@@ -23,6 +23,9 @@ public class OAuthAuthenticator : IAuthenticator
     {
         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 @@ public OAuthAuthenticator(
         /// <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 @@ async Task<string> GetToken()
             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 @@ async Task<string> GetToken()
             }
         }
 
+        /// <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));
     }
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
@@ -23,6 +23,9 @@ public class OAuthAuthenticator : IAuthenticator
     {
         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 @@ public OAuthAuthenticator(
         /// <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 @@ async Task<string> GetToken()
             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 @@ async Task<string> GetToken()
             }
         }
 
+        /// <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));
     }
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
@@ -23,6 +23,9 @@ public class OAuthAuthenticator : IAuthenticator
     {
         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 @@ public OAuthAuthenticator(
         /// <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 @@ async Task<string> GetToken()
             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 @@ async Task<string> GetToken()
             }
         }
 
+        /// <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));
     }
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
@@ -23,6 +23,9 @@ public class OAuthAuthenticator : IAuthenticator
     {
         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 @@ public OAuthAuthenticator(
         /// <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 @@ async Task<string> GetToken()
             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 @@ async Task<string> GetToken()
             }
         }
 
+        /// <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));
     }
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
@@ -23,6 +23,9 @@ public class OAuthAuthenticator : IAuthenticator
     {
         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 @@ public OAuthAuthenticator(
         /// <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 @@ async Task<string> GetToken()
             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 @@ async Task<string> GetToken()
             }
         }
 
+        /// <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));
     }

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,9 @@ namespace {{packageName}}.Client.Auth`
`15`	`15`	`{`
`16`	`16`	`private TokenResponse{{nrt?}} _token;`
`17`	`17`
	`18`	`+ /// <summary>`
	`19`	`+ /// Returns the current authentication token. Can return null if there is no authentication token, or it has expired.`
	`20`	`+ /// </summary>`
`18`	`21`	`public string{{nrt?}} Token`
`19`	`22`	`{`
`20`	`23`	`get`
`@@ -76,12 +79,11 @@ namespace {{packageName}}.Client.Auth`
`76`	`79`	`/// <summary>`
`77`	`80`	`/// Creates an authentication parameter from an access token.`
`78`	`81`	`/// </summary>`
`79`		`- /// <param name="accessToken">Access token to create a parameter from.</param>`
`80`	`82`	`/// <returns>An authentication parameter.</returns>`
`81`	`83`	`protected async ValueTask<Parameter> GetAuthenticationParameter()`
`82`	`84`	`{`
`83`	`85`	`var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;`
`84`		`- return new HeaderParameter(KnownHeaders.Authorization, token!);`
	`86`	`+ return new HeaderParameter(KnownHeaders.Authorization, token);`
`85`	`87`	`}`
`86`	`88`
`87`	`89`	`/// <summary>`
`@@ -96,7 +98,7 @@ namespace {{packageName}}.Client.Auth`
`96`	`98`	`if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))`
`97`	`99`	`{`
`98`	`100`	`request.AddParameter("grant_type", "refresh_token")`
`99`		`- .AddParameter("refresh_token", _token!.RefreshToken);`
	`101`	`+ .AddParameter("refresh_token", _token.RefreshToken);`
`100`	`102`	`}`
`101`	`103`	`else`
`102`	`104`	`{`
`@@ -122,6 +124,12 @@ namespace {{packageName}}.Client.Auth`
`122`	`124`	`}`
`123`	`125`	`}`
`124`	`126`
	`127`	`+ /// <summary>`
	`128`	`+ /// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request`
	`129`	`+ /// </summary>`
	`130`	`+ /// <param name="client"></param>`
	`131`	`+ /// <param name="request"></param>`
	`132`	`+ /// <returns></returns>`
`125`	`133`	`public async ValueTask Authenticate(IRestClient client, RestRequest request)`
`126`	`134`	`=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));`
`127`	`135`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,9 @@ public class OAuthAuthenticator : IAuthenticator`
`23`	`23`	`{`
`24`	`24`	`private TokenResponse _token;`
`25`	`25`
	`26`	`+ /// <summary>`
	`27`	`+ /// Returns the current authentication token. Can return null if there is no authentication token, or it has expired.`
	`28`	`+ /// </summary>`
`26`	`29`	`public string Token`
`27`	`30`	`{`
`28`	`31`	`get`
`@@ -84,12 +87,11 @@ public OAuthAuthenticator(`
`84`	`87`	`/// <summary>`
`85`	`88`	`/// Creates an authentication parameter from an access token.`
`86`	`89`	`/// </summary>`
`87`		`- /// <param name="accessToken">Access token to create a parameter from.</param>`
`88`	`90`	`/// <returns>An authentication parameter.</returns>`
`89`	`91`	`protected async ValueTask<Parameter> GetAuthenticationParameter()`
`90`	`92`	`{`
`91`	`93`	`var token = string.IsNullOrEmpty(Token) ? await GetToken().ConfigureAwait(false) : Token;`
`92`		`- return new HeaderParameter(KnownHeaders.Authorization, token!);`
	`94`	`+ return new HeaderParameter(KnownHeaders.Authorization, token);`
`93`	`95`	`}`
`94`	`96`
`95`	`97`	`/// <summary>`
`@@ -104,7 +106,7 @@ async Task<string> GetToken()`
`104`	`106`	`if (!string.IsNullOrWhiteSpace(_token?.RefreshToken))`
`105`	`107`	`{`
`106`	`108`	`request.AddParameter("grant_type", "refresh_token")`
`107`		`- .AddParameter("refresh_token", _token!.RefreshToken);`
	`109`	`+ .AddParameter("refresh_token", _token.RefreshToken);`
`108`	`110`	`}`
`109`	`111`	`else`
`110`	`112`	`{`
`@@ -130,6 +132,12 @@ async Task<string> GetToken()`
`130`	`132`	`}`
`131`	`133`	`}`
`132`	`134`
	`135`	`+ /// <summary>`
	`136`	`+ /// Retrieves the authentication token (creating a new one if necessary) and adds it to the current request`
	`137`	`+ /// </summary>`
	`138`	`+ /// <param name="client"></param>`
	`139`	`+ /// <param name="request"></param>`
	`140`	`+ /// <returns></returns>`
`133`	`141`	`public async ValueTask Authenticate(IRestClient client, RestRequest request)`
`134`	`142`	`=> request.AddOrUpdateParameter(await GetAuthenticationParameter().ConfigureAwait(false));`
`135`	`143`	`}`