Merge pull request #3331 from wing328/csharp_fix_client_model

[C#] to fix issues when the model name is "Client"

Author: wing328

modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractCSharpCodegen.java

@@ -57,6 +57,10 @@ public AbstractCSharpCodegen() {
 
         setReservedWordsLowerCase(
                 Arrays.asList(
+                        // set client as a reserved word to avoid conflicts with IO.Swagger.Client
+                        // this is a workaround and can be removed if c# api client is updated to use
+                        // fully qualified name
+                        "client",
                         // local variable names in API methods (endpoints)
                         "localVarPath", "localVarPathParams", "localVarQueryParams", "localVarHeaderParams", 
                         "localVarFormParams", "localVarFileParams", "localVarStatusCode", "localVarResponse",

modules/swagger-codegen/src/main/resources/csharp/README.mustache

@@ -128,10 +128,16 @@ No model defined in this package
 
 ## Documentation for Authorization
 
-<a name="{{#authMethods}}{{name}}"></a>
-{{^authMethods}} All endpoints do not require authorization.
-{{/authMethods}}{{#authMethods}}{{#last}} Authentication schemes defined for the API:{{/last}}{{/authMethods}}
-{{#authMethods}}### {{name}}
+{{^authMethods}}
+All endpoints do not require authorization.
+{{/authMethods}}
+{{#authMethods}}
+{{#last}}
+Authentication schemes defined for the API:
+{{/last}}
+{{/authMethods}}
+{{#authMethods}}
+### {{name}}
 
 {{#isApiKey}}- **Type**: API key
 - **API key parameter name**: {{keyParamName}}

modules/swagger-codegen/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml

@@ -561,6 +561,28 @@ paths:
           description: User not found
 
   /fake:
+    patch:
+      tags:
+        - fake
+      summary: To test "client" model
+      descriptions: To test "client" model
+      operationId: testClientModel
+      consumes:
+        - application/json
+      produces:
+        - application/json
+      parameters:
+        - in: body
+          name: body
+          description: client model
+          required: true
+          schema:
+            $ref: '#/definitions/Client'
+      responses:
+        '200':
+          description: successful operation
+          schema:
+            $ref: '#/definitions/Client'
     get:
       tags:
         - fake
@@ -1018,6 +1040,11 @@ definitions:
         type: object
         additionalProperties:
           $ref: '#/definitions/Animal'
+  Client:
+    type: object
+    properties:
+      client:
+        type: string
   ReadOnlyFirst:
     type: object
     properties:

samples/client/petstore/csharp/SwaggerClient/IO.Swagger.sln

@@ -2,7 +2,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 2012
 VisualStudioVersion = 12.0.0.0
 MinimumVisualStudioVersion = 10.0.0.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "IO.Swagger", "src\IO.Swagger\IO.Swagger.csproj", "{9391D4F3-E89A-41F1-B1C9-A9C885B3F96D}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "IO.Swagger", "src\IO.Swagger\IO.Swagger.csproj", "{C8F5DE66-0944-4368-91CC-2313B4BFADDE}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "IO.Swagger.Test", "src\IO.Swagger.Test\IO.Swagger.Test.csproj", "{19F1DEBC-DE5E-4517-8062-F000CD499087}"
 EndProject
@@ -12,10 +12,10 @@ Debug|Any CPU = Debug|Any CPU
 Release|Any CPU = Release|Any CPU
 EndGlobalSection
 GlobalSection(ProjectConfigurationPlatforms) = postSolution
-{9391D4F3-E89A-41F1-B1C9-A9C885B3F96D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-{9391D4F3-E89A-41F1-B1C9-A9C885B3F96D}.Debug|Any CPU.Build.0 = Debug|Any CPU
-{9391D4F3-E89A-41F1-B1C9-A9C885B3F96D}.Release|Any CPU.ActiveCfg = Release|Any CPU
-{9391D4F3-E89A-41F1-B1C9-A9C885B3F96D}.Release|Any CPU.Build.0 = Release|Any CPU
+{C8F5DE66-0944-4368-91CC-2313B4BFADDE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+{C8F5DE66-0944-4368-91CC-2313B4BFADDE}.Debug|Any CPU.Build.0 = Debug|Any CPU
+{C8F5DE66-0944-4368-91CC-2313B4BFADDE}.Release|Any CPU.ActiveCfg = Release|Any CPU
+{C8F5DE66-0944-4368-91CC-2313B4BFADDE}.Release|Any CPU.Build.0 = Release|Any CPU
 {19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 {19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.Build.0 = Debug|Any CPU
 {19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.ActiveCfg = Release|Any CPU

samples/client/petstore/csharp/SwaggerClient/README.md

@@ -1,21 +1,21 @@
 # IO.Swagger - the C# library for the Swagger Petstore
 
-This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ 
+This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
 
 This C# SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 1.0.0
 - SDK version: 1.0.0
-- Build date: 2016-06-23T12:09:14.609+08:00
+- Build date: 2016-07-10T17:40:23.847+08:00
 - Build package: class io.swagger.codegen.languages.CSharpClientCodegen
 
 ## Frameworks supported
 - .NET 4.0 or later
 - Windows Phone 7.1 (Mango)
 
 ## Dependencies
-- [RestSharp] (https://www.nuget.org/packages/RestSharp) - 105.1.0 or later
-- [Json.NET] (https://www.nuget.org/packages/Newtonsoft.Json/) - 7.0.0 or later
+- [RestSharp](https://www.nuget.org/packages/RestSharp) - 105.1.0 or later
+- [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 7.0.0 or later
 
 The DLLs included in the package may not be the latest version. We recommned using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:
 ```
@@ -54,39 +54,31 @@ namespace Example
         {
 
             var apiInstance = new FakeApi();
-            var number = 3.4;  // decimal? | None
-            var _double = 1.2;  // double? | None
-            var _string = _string_example;  // string | None
-            var _byte = B;  // byte[] | None
-            var integer = 56;  // int? | None (optional) 
-            var int32 = 56;  // int? | None (optional) 
-            var int64 = 789;  // long? | None (optional) 
-            var _float = 3.4;  // float? | None (optional) 
-            var binary = B;  // byte[] | None (optional) 
-            var date = 2013-10-20;  // DateTime? | None (optional) 
-            var dateTime = 2013-10-20T19:20:30+01:00;  // DateTime? | None (optional) 
-            var password = password_example;  // string | None (optional) 
+            var body = new ModelClient(); // ModelClient | client model
 
             try
             {
-                // Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 
-                apiInstance.TestEndpointParameters(number, _double, _string, _byte, integer, int32, int64, _float, binary, date, dateTime, password);
+                // To test \"client\" model
+                ModelClient result = apiInstance.TestClientModel(body);
+                Debug.WriteLine(result);
             }
             catch (Exception e)
             {
-                Debug.Print("Exception when calling FakeApi.TestEndpointParameters: " + e.Message );
+                Debug.Print("Exception when calling FakeApi.TestClientModel: " + e.Message );
             }
         }
     }
 }
 ```
 
+<a name="documentation-for-api-endpoints"></a>
 ## Documentation for API Endpoints
 
 All URIs are relative to *http://petstore.swagger.io/v2*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*FakeApi* | [**TestClientModel**](docs/FakeApi.md#testclientmodel) | **PATCH** /fake | To test \"client\" model
 *FakeApi* | [**TestEndpointParameters**](docs/FakeApi.md#testendpointparameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 
 *FakeApi* | [**TestEnumQueryParameters**](docs/FakeApi.md#testenumqueryparameters) | **GET** /fake | To test enum query parameters
 *PetApi* | [**AddPet**](docs/PetApi.md#addpet) | **POST** /pet | Add a new pet to the store
@@ -111,6 +103,7 @@ Class | Method | HTTP request | Description
 *UserApi* | [**UpdateUser**](docs/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user
 
 
+<a name="documentation-for-models"></a>
 ## Documentation for Models
 
  - [Model.AdditionalPropertiesClass](docs/AdditionalPropertiesClass.md)
@@ -130,6 +123,7 @@ Class | Method | HTTP request | Description
  - [Model.MapTest](docs/MapTest.md)
  - [Model.MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md)
  - [Model.Model200Response](docs/Model200Response.md)
+ - [Model.ModelClient](docs/ModelClient.md)
  - [Model.ModelReturn](docs/ModelReturn.md)
  - [Model.Name](docs/Name.md)
  - [Model.NumberOnly](docs/NumberOnly.md)
@@ -143,7 +137,6 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Authorization
 
-
 ### api_key
 
 - **Type**: API key

samples/client/petstore/csharp/SwaggerClient/docs/FakeApi.md

@@ -4,10 +4,71 @@ All URIs are relative to *http://petstore.swagger.io/v2*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**TestClientModel**](FakeApi.md#testclientmodel) | **PATCH** /fake | To test \"client\" model
 [**TestEndpointParameters**](FakeApi.md#testendpointparameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 
 [**TestEnumQueryParameters**](FakeApi.md#testenumqueryparameters) | **GET** /fake | To test enum query parameters
 
 
+<a name="testclientmodel"></a>
+# **TestClientModel**
+> ModelClient TestClientModel (ModelClient body)
+
+To test \"client\" model
+
+### Example
+```csharp
+using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class TestClientModelExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new FakeApi();
+            var body = new ModelClient(); // ModelClient | client model
+
+            try
+            {
+                // To test \"client\" model
+                ModelClient result = apiInstance.TestClientModel(body);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling FakeApi.TestClientModel: " + e.Message );
+            }
+        }
+    }
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ModelClient**](ModelClient.md)| client model | 
+
+### Return type
+
+[**ModelClient**](ModelClient.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 <a name="testendpointparameters"></a>
 # **TestEndpointParameters**
 > void TestEndpointParameters (decimal? number, double? _double, string _string, byte[] _byte, int? integer = null, int? int32 = null, long? int64 = null, float? _float = null, byte[] binary = null, DateTime? date = null, DateTime? dateTime = null, string password = null)

samples/client/petstore/csharp/SwaggerClient/docs/ModelClient.md

@@ -0,0 +1,9 @@
+# IO.Swagger.Model.ModelClient
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_Client** | **string** |  | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

samples/client/petstore/csharp/SwaggerClient/src/IO.Swagger.Test/Model/ModelClientTests.cs

@@ -0,0 +1,90 @@
+/* 
+ * Swagger Petstore
+ *
+ * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: [email protected]
+ * Generated by: https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+
+using NUnit.Framework;
+
+using System;
+using System.Linq;
+using System.IO;
+using System.Collections.Generic;
+using IO.Swagger.Api;
+using IO.Swagger.Model;
+using IO.Swagger.Client;
+using System.Reflection;
+
+namespace IO.Swagger.Test
+{
+    /// <summary>
+    ///  Class for testing ModelClient
+    /// </summary>
+    /// <remarks>
+    /// This file is automatically generated by Swagger Codegen.
+    /// Please update the test case below to test the model.
+    /// </remarks>
+    [TestFixture]
+    public class ModelClientTests
+    {
+        // TODO uncomment below to declare an instance variable for ModelClient
+        //private ModelClient instance;
+
+        /// <summary>
+        /// Setup before each test
+        /// </summary>
+        [SetUp]
+        public void Init()
+        {
+            // TODO uncomment below to create an instance of ModelClient
+            //instance = new ModelClient();
+        }
+
+        /// <summary>
+        /// Clean up after each test
+        /// </summary>
+        [TearDown]
+        public void Cleanup()
+        {
+
+        }
+
+        /// <summary>
+        /// Test an instance of ModelClient
+        /// </summary>
+        [Test]
+        public void ModelClientInstanceTest()
+        {
+            // TODO uncomment below to test "IsInstanceOfType" ModelClient
+            //Assert.IsInstanceOfType<ModelClient> (instance, "variable 'instance' is a ModelClient");
+        }
+
+        /// <summary>
+        /// Test the property '_Client'
+        /// </summary>
+        [Test]
+        public void _ClientTest()
+        {
+            // TODO unit test for the property '_Client'
+        }
+
+    }
+
+}