Option to exclude deprecated endpoints

docs/tutorials/GenerateProxyClientWithCLI/generate-proxy-client.md

@@ -107,6 +107,7 @@ nswag run sample.nswag /runtime:Net50
             "operationGenerationMode": "MultipleClientsFromOperationId",
             "includedOperationIds": [ "SampleOperationId" ],
             "excludedOperationIds": [],
+            "excludeDeprecated": false,
             "generateOptionalParameters": false,
             "generateJsonMethods": true,
             "parameterArrayType": "System.Collections.Generic.IEnumerable",

src/NSwag.ApiDescription.Client/NSwag.ApiDescription.Client.props

@@ -130,6 +130,7 @@
       <NSwagOperationGenerationMode>$(NSwagOperationGenerationMode)</NSwagOperationGenerationMode>
       <NSwagIncludedOperationIds>$(NSwagIncludedOperationIds)</NSwagIncludedOperationIds>
       <NSwagExcludedOperationIds>$(NSwagExcludedOperationIds)</NSwagExcludedOperationIds>
+	  <NSwagExcludeDeprecated>$(NSwagExcludeDeprecated)</NSwagExcludeDeprecated>
       <NSwagAdditionalNamespaceUsages>$(NSwagAdditionalNamespaceUsages)</NSwagAdditionalNamespaceUsages>
       <NSwagAdditionalContractNamespaceUsages>$(NSwagAdditionalContractNamespaceUsages)</NSwagAdditionalContractNamespaceUsages>
       <NSwagGenerateOptionalParameters>$(NSwagGenerateOptionalParameters)</NSwagGenerateOptionalParameters>

src/NSwag.ApiDescription.Client/NSwag.ApiDescription.Client.targets

@@ -127,6 +127,9 @@
 	  <CurrentOpenApiReference>
 		<Command Condition="'%(NSwagExcludedOperationIds)' != ''">%(Command) /excludedOperationIds:%(NSwagExcludedOperationIds)</Command>
 	  </CurrentOpenApiReference>
+	  <CurrentOpenApiReference>
+		<Command Condition="'%(NSwagExcludeDeprecated)' != ''">%(Command) /excludeDeprecated:%(NSwagExcludeDeprecated)</Command>
+	  </CurrentOpenApiReference>
 	  <CurrentOpenApiReference>
         <Command Condition="'%(NSwagAdditionalNamespaceUsages)' != ''">%(Command) /additionalNamespaceUsages:%(NSwagAdditionalNamespaceUsages)</Command>
       </CurrentOpenApiReference>

src/NSwag.CodeGeneration.CSharp.Tests/CSharpClientSettingsTests.cs

@@ -20,6 +20,9 @@ public object CreatePerson(bool @override = false)
                 return null;
             }
 
+#pragma warning disable S1133 // Deprecated code should be removed
+            [Obsolete("Testing generation of obsolete endpoints")]
+#pragma warning restore S1133 // Deprecated code should be removed
             public object DeletePerson(bool @override = false)
             {
                 return null;
@@ -413,5 +416,58 @@ await VerifyHelper.Verify(code)
                 .UseParameters(excludedOperationIds.Length);
             CSharpCompiler.AssertCompile(code);
         }
+
+        [Fact]
+        public async Task When_depreacted_endpoints_are_excluded_the_client_should_not_generate_these_endpoint()
+        {
+            // Arrange
+            var swaggerGenerator = new WebApiOpenApiDocumentGenerator(new WebApiOpenApiDocumentGeneratorSettings
+            {
+                SchemaSettings = new NewtonsoftJsonSchemaGeneratorSettings()
+            });
+
+            var document = await swaggerGenerator.GenerateForControllerAsync<FooController>();
+            var generator = new CSharpClientGenerator(document, new CSharpClientGeneratorSettings
+            {
+                GenerateClientClasses = true,
+                ExcludeDeprecated = true
+            });
+
+            // Act
+            var code = generator.GenerateFile();
+
+            // Assert
+            Assert.DoesNotContain("DeletePerson", code);
+            Assert.DoesNotContain("Obsolete", code);
+            await VerifyHelper.Verify(code);
+            CSharpCompiler.AssertCompile(code);
+        }
+
+        [Fact]
+        public async Task When_depreacted_endpoints_are_excluded_the_client_should_still_generate_explicitly_included_endpoints()
+        {
+            // Arrange
+            var swaggerGenerator = new WebApiOpenApiDocumentGenerator(new WebApiOpenApiDocumentGeneratorSettings
+            {
+                SchemaSettings = new NewtonsoftJsonSchemaGeneratorSettings()
+            });
+
+            var document = await swaggerGenerator.GenerateForControllerAsync<FooController>();
+            var generator = new CSharpClientGenerator(document, new CSharpClientGeneratorSettings
+            {
+                GenerateClientClasses = true,
+                ExcludeDeprecated = true,
+                IncludedOperationIds = ["Foo_DeletePerson"]
+            });
+
+            // Act
+            var code = generator.GenerateFile();
+
+            // Assert
+            Assert.Contains("DeletePerson", code);
+            Assert.Contains("Obsolete", code);
+            await VerifyHelper.Verify(code);
+            CSharpCompiler.AssertCompile(code);
+        }
     }
 }

src/NSwag.CodeGeneration.CSharp.Tests/Snapshots/CSharpClientSettingsTests.WhenUsingBaseUrl_ButNoProperty_ThenPropertyIsNotUsedAndFieldIsGenerated.verified.txt

@@ -193,11 +193,13 @@ namespace MyNamespace
             }
         }
 
+        [System.Obsolete]
         public virtual System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override)
         {
             return DeletePersonAsync(@override, System.Threading.CancellationToken.None);
         }
 
+        [System.Obsolete]
         public virtual async System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken)
         {
             var client_ = _httpClient;

src/NSwag.CodeGeneration.CSharp.Tests/Snapshots/CSharpClientSettingsTests.When_ConfigurationClass_is_set_then_correct_ctor_is_generated.verified.txt

@@ -200,11 +200,13 @@ namespace MyNamespace
             }
         }
 
+        [System.Obsolete]
         public virtual System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override)
         {
             return DeletePersonAsync(@override, System.Threading.CancellationToken.None);
         }
 
+        [System.Obsolete]
         public virtual async System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken)
         {
             var client_ = new System.Net.Http.HttpClient();

src/NSwag.CodeGeneration.CSharp.Tests/Snapshots/CSharpClientSettingsTests.When_UseHttpRequestMessageCreationMethod_is_set_then_CreateRequestMessage_is_generated.verified.txt

@@ -202,11 +202,13 @@ namespace MyNamespace
             }
         }
 
+        [System.Obsolete]
         public virtual System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override)
         {
             return DeletePersonAsync(@override, System.Threading.CancellationToken.None);
         }
 
+        [System.Obsolete]
         public virtual async System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken)
         {
             var client_ = _httpClient;

src/NSwag.CodeGeneration.CSharp.Tests/Snapshots/CSharpClientSettingsTests.When_client_base_interface_is_not_specified_then_client_interface_should_have_no_base_interface.verified.txt

@@ -14,8 +14,10 @@ namespace MyNamespace
 
         System.Threading.Tasks.Task<object> CreatePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken);
 
+        [System.Obsolete]
         System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override);
 
+        [System.Obsolete]
         System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken);
 
     }
@@ -218,11 +220,13 @@ namespace MyNamespace
             }
         }
 
+        [System.Obsolete]
         public virtual System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override)
         {
             return DeletePersonAsync(@override, System.Threading.CancellationToken.None);
         }
 
+        [System.Obsolete]
         public virtual async System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken)
         {
             var client_ = _httpClient;

src/NSwag.CodeGeneration.CSharp.Tests/Snapshots/CSharpClientSettingsTests.When_client_base_interface_is_not_specified_then_client_interface_should_have_no_base_interface_and_has_correct_access_modifier.verified.txt

@@ -14,8 +14,10 @@ namespace MyNamespace
 
         System.Threading.Tasks.Task<object> CreatePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken);
 
+        [System.Obsolete]
         System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override);
 
+        [System.Obsolete]
         System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken);
 
     }
@@ -218,11 +220,13 @@ namespace MyNamespace
             }
         }
 
+        [System.Obsolete]
         public virtual System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override)
         {
             return DeletePersonAsync(@override, System.Threading.CancellationToken.None);
         }
 
+        [System.Obsolete]
         public virtual async System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken)
         {
             var client_ = _httpClient;

src/NSwag.CodeGeneration.CSharp.Tests/Snapshots/CSharpClientSettingsTests.When_client_base_interface_is_specified_then_client_interface_extends_it.verified.txt

@@ -14,8 +14,10 @@ namespace MyNamespace
 
         System.Threading.Tasks.Task<object> CreatePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken);
 
+        [System.Obsolete]
         System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override);
 
+        [System.Obsolete]
         System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken);
 
     }
@@ -218,11 +220,13 @@ namespace MyNamespace
             }
         }
 
+        [System.Obsolete]
         public virtual System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override)
         {
             return DeletePersonAsync(@override, System.Threading.CancellationToken.None);
         }
 
+        [System.Obsolete]
         public virtual async System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken)
         {
             var client_ = _httpClient;

src/NSwag.CodeGeneration.CSharp.Tests/Snapshots/CSharpClientSettingsTests.When_client_base_interface_is_specified_with_access_modifier_then_client_interface_extends_it_and_has_correct_access_modifier.verified.txt

@@ -14,8 +14,10 @@ namespace MyNamespace
 
         System.Threading.Tasks.Task<object> CreatePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken);
 
+        [System.Obsolete]
         System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override);
 
+        [System.Obsolete]
         System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken);
 
     }
@@ -218,11 +220,13 @@ namespace MyNamespace
             }
         }
 
+        [System.Obsolete]
         public virtual System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override)
         {
             return DeletePersonAsync(@override, System.Threading.CancellationToken.None);
         }
 
+        [System.Obsolete]
         public virtual async System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken)
         {
             var client_ = _httpClient;

src/NSwag.CodeGeneration.CSharp.Tests/Snapshots/CSharpClientSettingsTests.When_client_class_generation_is_enabled_and_suppressed_then_client_class_is_not_generated.verified.txt

@@ -14,8 +14,10 @@ namespace MyNamespace
 
         System.Threading.Tasks.Task<object> CreatePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken);
 
+        [System.Obsolete]
         System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override);
 
+        [System.Obsolete]
         System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken);
 
     }

src/NSwag.CodeGeneration.CSharp.Tests/Snapshots/CSharpClientSettingsTests.When_client_interface_generation_is_enabled_and_suppressed_then_client_interface_is_not_generated.verified.txt

@@ -202,11 +202,13 @@ namespace MyNamespace
             }
         }
 
+        [System.Obsolete]
         public virtual System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override)
         {
             return DeletePersonAsync(@override, System.Threading.CancellationToken.None);
         }
 
+        [System.Obsolete]
         public virtual async System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken)
         {
             var client_ = _httpClient;

src/NSwag.CodeGeneration.CSharp.Tests/Snapshots/CSharpClientSettingsTests.When_code_is_generated_then_by_default_the_system_httpclient_is_used.verified.txt

@@ -200,11 +200,13 @@ namespace MyNamespace
             }
         }
 
+        [System.Obsolete]
         public virtual System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override)
         {
             return DeletePersonAsync(@override, System.Threading.CancellationToken.None);
         }
 
+        [System.Obsolete]
         public virtual async System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken)
         {
             var client_ = new System.Net.Http.HttpClient();

src/NSwag.CodeGeneration.CSharp.Tests/Snapshots/CSharpClientSettingsTests.When_custom_http_client_type_is_specified_then_an_instance_of_that_type_is_used.verified.txt

@@ -200,11 +200,13 @@ namespace MyNamespace
             }
         }
 
+        [System.Obsolete]
         public virtual System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override)
         {
             return DeletePersonAsync(@override, System.Threading.CancellationToken.None);
         }
 
+        [System.Obsolete]
         public virtual async System.Threading.Tasks.Task<object> DeletePersonAsync(bool? @override, System.Threading.CancellationToken cancellationToken)
         {
             var client_ = new CustomNamespace.CustomHttpClient();