[csharp] Add scope for oauth2 (#19234)

* feat: add scope for oauth2

* fix: add parameter AlwaysMultipartFormData

* fix: string to boolean

* fix: optional bool

* fix: null checks

* Optional string

* Remove all references to OAuthMultipartFormData

* Remove _multipartFormData = multipartFormData;

* Remove typo

* Run generate-samples and export_docs_generators

* Revert "Run generate-samples and export_docs_generators"

This reverts commit f051f26.

* Switch to string.IsNullOrEmpty, add langVersion 8

* Add langVersion 8 in ConditionalSerialization

* Use regular strings for netstandard2.0

* Remove references to langVersion 8

* Fix variable

* Use template engine to toggle nullable string

* Trigger tests

* Generate samples

* Trigger build

* Use {{nrt?}}

* update samples

---------

Co-authored-by: Morten Jansrud <[email protected]>

Author: wing328

modules/openapi-generator/src/main/resources/csharp/ApiClient.mustache

@@ -474,6 +474,7 @@ namespace {{packageName}}.Client
                     configuration.OAuthTokenUrl,
                     configuration.OAuthClientId,
                     configuration.OAuthClientSecret,
+                    configuration.OAuthScope,
                     configuration.OAuthFlow,
                     SerializerSettings,
                     configuration);

modules/openapi-generator/src/main/resources/csharp/Configuration.mustache

@@ -366,6 +366,12 @@ namespace {{packageName}}.Client
         /// <value>The OAuth Client Secret.</value>
         public virtual string OAuthClientSecret { get; set; }
 
+        /// <summary>
+        /// Gets or sets the client scope for OAuth2 authentication.
+        /// </summary>
+        /// <value>The OAuth Client Scope.</value>
+        public virtual string{{nrt?}} OAuthScope { get; set; }
+
         /// <summary>
         /// Gets or sets the flow for OAuth2 authentication.
         /// </summary>
@@ -711,6 +717,7 @@ namespace {{packageName}}.Client
                 OAuthTokenUrl = second.OAuthTokenUrl ?? first.OAuthTokenUrl,
                 OAuthClientId = second.OAuthClientId ?? first.OAuthClientId,
                 OAuthClientSecret = second.OAuthClientSecret ?? first.OAuthClientSecret,
+                OAuthScope = second.OAuthScope ?? first.OAuthScope,
                 OAuthFlow = second.OAuthFlow ?? first.OAuthFlow,
                 {{/hasOAuthMethods}}
                 {{/useRestSharp}}

modules/openapi-generator/src/main/resources/csharp/IReadableConfiguration.mustache

@@ -43,6 +43,12 @@ namespace {{packageName}}.Client
         /// <value>OAuth Client Secret.</value>
         string OAuthClientSecret { get; }
 
+        /// <summary>
+        /// Gets the OAuth token scope.
+        /// </summary>
+        /// <value>OAuth Token scope.</value>
+        string{{nrt?}} OAuthScope { get; }
+
         /// <summary>
         /// Gets the OAuth flow.
         /// </summary>

modules/openapi-generator/src/main/resources/csharp/auth/OAuthAuthenticator.mustache

@@ -16,6 +16,7 @@ namespace {{packageName}}.Client.Auth
         readonly string _tokenUrl;
         readonly string _clientId;
         readonly string _clientSecret;
+        readonly string{{nrt?}} _scope;
         readonly string _grantType;
         readonly JsonSerializerSettings _serializerSettings;
         readonly IReadableConfiguration _configuration;
@@ -27,13 +28,15 @@ namespace {{packageName}}.Client.Auth
             string tokenUrl,
             string clientId,
             string clientSecret,
+            string{{nrt?}} scope,
             OAuthFlow? flow,
             JsonSerializerSettings serializerSettings,
             IReadableConfiguration configuration) : base("")
         {
             _tokenUrl = tokenUrl;
             _clientId = clientId;
             _clientSecret = clientSecret;
+            _scope = scope;
             _serializerSettings = serializerSettings;
             _configuration = configuration;
 
@@ -80,6 +83,12 @@ namespace {{packageName}}.Client.Auth
                 .AddParameter("grant_type", _grantType)
                 .AddParameter("client_id", _clientId)
                 .AddParameter("client_secret", _clientSecret);
+
+            if (!string.IsNullOrEmpty(_scope))
+            {
+                request.AddParameter("scope", _scope);
+            }
+
             var response = await client.PostAsync<TokenResponse>(request).ConfigureAwait(false);
 
             // RFC6749 - token_type is case insensitive.

samples/client/petstore/csharp/restsharp/net4.7/MultipleFrameworks/src/Org.OpenAPITools/Client/ApiClient.cs

@@ -474,6 +474,7 @@ private ApiResponse<T> ExecClient<T>(Func<RestClient, RestResponse<T>> getRespon
                     configuration.OAuthTokenUrl,
                     configuration.OAuthClientId,
                     configuration.OAuthClientSecret,
+                    configuration.OAuthScope,
                     configuration.OAuthFlow,
                     SerializerSettings,
                     configuration);

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

@@ -24,6 +24,7 @@ public class OAuthAuthenticator : AuthenticatorBase
         readonly string _tokenUrl;
         readonly string _clientId;
         readonly string _clientSecret;
+        readonly string _scope;
         readonly string _grantType;
         readonly JsonSerializerSettings _serializerSettings;
         readonly IReadableConfiguration _configuration;
@@ -35,13 +36,15 @@ public OAuthAuthenticator(
             string tokenUrl,
             string clientId,
             string clientSecret,
+            string scope,
             OAuthFlow? flow,
             JsonSerializerSettings serializerSettings,
             IReadableConfiguration configuration) : base("")
         {
             _tokenUrl = tokenUrl;
             _clientId = clientId;
             _clientSecret = clientSecret;
+            _scope = scope;
             _serializerSettings = serializerSettings;
             _configuration = configuration;
 
@@ -88,6 +91,12 @@ async Task<string> GetToken()
                 .AddParameter("grant_type", _grantType)
                 .AddParameter("client_id", _clientId)
                 .AddParameter("client_secret", _clientSecret);
+
+            if (!string.IsNullOrEmpty(_scope))
+            {
+                request.AddParameter("scope", _scope);
+            }
+
             var response = await client.PostAsync<TokenResponse>(request).ConfigureAwait(false);
 
             // RFC6749 - token_type is case insensitive.

samples/client/petstore/csharp/restsharp/net4.7/MultipleFrameworks/src/Org.OpenAPITools/Client/Configuration.cs

@@ -294,6 +294,12 @@ public string GetApiKeyWithPrefix(string apiKeyIdentifier)
         /// <value>The OAuth Client Secret.</value>
         public virtual string OAuthClientSecret { get; set; }
 
+        /// <summary>
+        /// Gets or sets the client scope for OAuth2 authentication.
+        /// </summary>
+        /// <value>The OAuth Client Scope.</value>
+        public virtual string OAuthScope { get; set; }
+
         /// <summary>
         /// Gets or sets the flow for OAuth2 authentication.
         /// </summary>
@@ -622,6 +628,7 @@ public static IReadableConfiguration MergeConfigurations(IReadableConfiguration
                 OAuthTokenUrl = second.OAuthTokenUrl ?? first.OAuthTokenUrl,
                 OAuthClientId = second.OAuthClientId ?? first.OAuthClientId,
                 OAuthClientSecret = second.OAuthClientSecret ?? first.OAuthClientSecret,
+                OAuthScope = second.OAuthScope ?? first.OAuthScope,
                 OAuthFlow = second.OAuthFlow ?? first.OAuthFlow,
                 TempFolderPath = second.TempFolderPath ?? first.TempFolderPath,
                 DateTimeFormat = second.DateTimeFormat ?? first.DateTimeFormat,

samples/client/petstore/csharp/restsharp/net4.7/MultipleFrameworks/src/Org.OpenAPITools/Client/IReadableConfiguration.cs

@@ -46,6 +46,12 @@ public interface IReadableConfiguration
         /// <value>OAuth Client Secret.</value>
         string OAuthClientSecret { get; }
 
+        /// <summary>
+        /// Gets the OAuth token scope.
+        /// </summary>
+        /// <value>OAuth Token scope.</value>
+        string OAuthScope { get; }
+
         /// <summary>
         /// Gets the OAuth flow.
         /// </summary>

samples/client/petstore/csharp/restsharp/net4.7/Petstore/src/Org.OpenAPITools/Client/ApiClient.cs

@@ -474,6 +474,7 @@ private ApiResponse<T> ExecClient<T>(Func<RestClient, RestResponse<T>> getRespon
                     configuration.OAuthTokenUrl,
                     configuration.OAuthClientId,
                     configuration.OAuthClientSecret,
+                    configuration.OAuthScope,
                     configuration.OAuthFlow,
                     SerializerSettings,
                     configuration);

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

@@ -24,6 +24,7 @@ public class OAuthAuthenticator : AuthenticatorBase
         readonly string _tokenUrl;
         readonly string _clientId;
         readonly string _clientSecret;
+        readonly string _scope;
         readonly string _grantType;
         readonly JsonSerializerSettings _serializerSettings;
         readonly IReadableConfiguration _configuration;
@@ -35,13 +36,15 @@ public OAuthAuthenticator(
             string tokenUrl,
             string clientId,
             string clientSecret,
+            string scope,
             OAuthFlow? flow,
             JsonSerializerSettings serializerSettings,
             IReadableConfiguration configuration) : base("")
         {
             _tokenUrl = tokenUrl;
             _clientId = clientId;
             _clientSecret = clientSecret;
+            _scope = scope;
             _serializerSettings = serializerSettings;
             _configuration = configuration;
 
@@ -88,6 +91,12 @@ async Task<string> GetToken()
                 .AddParameter("grant_type", _grantType)
                 .AddParameter("client_id", _clientId)
                 .AddParameter("client_secret", _clientSecret);
+
+            if (!string.IsNullOrEmpty(_scope))
+            {
+                request.AddParameter("scope", _scope);
+            }
+
             var response = await client.PostAsync<TokenResponse>(request).ConfigureAwait(false);
 
             // RFC6749 - token_type is case insensitive.