diff --git a/modules/swagger-codegen/src/main/resources/csharp/api.mustache b/modules/swagger-codegen/src/main/resources/csharp/api.mustache index 20d429d8827..02c6e0ad2b3 100644 --- a/modules/swagger-codegen/src/main/resources/csharp/api.mustache +++ b/modules/swagger-codegen/src/main/resources/csharp/api.mustache @@ -25,7 +25,7 @@ namespace {{packageName}}.Api /// {{notes}} /// /// Thrown when fails to make API call - {{#allParams}}/// {{description}} + {{#allParams}}/// {{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}} {{/allParams}}/// {{#returnType}}{{returnType}}{{/returnType}} {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}} {{operationId}} ({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}); @@ -36,7 +36,7 @@ namespace {{packageName}}.Api /// {{notes}} /// /// Thrown when fails to make API call - {{#allParams}}/// {{description}} + {{#allParams}}/// {{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}} {{/allParams}}/// ApiResponse of {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}Object(void){{/returnType}} ApiResponse<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Object{{/returnType}}> {{operationId}}WithHttpInfo ({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}); {{/operation}} @@ -51,7 +51,7 @@ namespace {{packageName}}.Api /// {{notes}} /// /// Thrown when fails to make API call - {{#allParams}}/// {{description}} + {{#allParams}}/// {{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}} {{/allParams}}/// Task of {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}void{{/returnType}} {{#returnType}}System.Threading.Tasks.Task<{{{returnType}}}>{{/returnType}}{{^returnType}}System.Threading.Tasks.Task{{/returnType}} {{operationId}}Async ({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}); @@ -62,7 +62,7 @@ namespace {{packageName}}.Api /// {{notes}} /// /// Thrown when fails to make API call - {{#allParams}}/// {{description}} + {{#allParams}}/// {{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}} {{/allParams}}/// Task of ApiResponse{{#returnType}} ({{returnType}}){{/returnType}} System.Threading.Tasks.Task> {{operationId}}AsyncWithHttpInfo ({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}); {{/operation}} @@ -162,7 +162,7 @@ namespace {{packageName}}.Api /// {{summary}} {{notes}} /// /// Thrown when fails to make API call - {{#allParams}}/// {{description}} + {{#allParams}}/// {{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}} {{/allParams}}/// {{#returnType}}{{returnType}}{{/returnType}} public {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}} {{operationId}} ({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) { @@ -174,7 +174,7 @@ namespace {{packageName}}.Api /// {{summary}} {{notes}} /// /// Thrown when fails to make API call - {{#allParams}}/// {{description}} + {{#allParams}}/// {{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}} {{/allParams}}/// ApiResponse of {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}Object(void){{/returnType}} public ApiResponse<{{#returnType}} {{{returnType}}} {{/returnType}}{{^returnType}}Object{{/returnType}}> {{operationId}}WithHttpInfo ({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) { @@ -274,7 +274,7 @@ namespace {{packageName}}.Api /// {{summary}} {{notes}} /// /// Thrown when fails to make API call - {{#allParams}}/// {{description}} + {{#allParams}}/// {{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}} {{/allParams}}/// Task of {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}void{{/returnType}} {{#returnType}}public async System.Threading.Tasks.Task<{{{returnType}}}>{{/returnType}}{{^returnType}}public async System.Threading.Tasks.Task{{/returnType}} {{operationId}}Async ({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) { @@ -287,7 +287,7 @@ namespace {{packageName}}.Api /// {{summary}} {{notes}} /// /// Thrown when fails to make API call - {{#allParams}}/// {{description}} + {{#allParams}}/// {{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}} {{/allParams}}/// Task of ApiResponse{{#returnType}} ({{returnType}}){{/returnType}} public async System.Threading.Tasks.Task> {{operationId}}AsyncWithHttpInfo ({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) { diff --git a/modules/swagger-codegen/src/main/resources/objc/api-body.mustache b/modules/swagger-codegen/src/main/resources/objc/api-body.mustache index 0aa3c7ce7ab..41560eabd3e 100644 --- a/modules/swagger-codegen/src/main/resources/objc/api-body.mustache +++ b/modules/swagger-codegen/src/main/resources/objc/api-body.mustache @@ -75,7 +75,7 @@ static {{classname}}* singletonAPI = nil; /// /// {{{summary}}} /// {{{notes}}} -/// {{#allParams}} @param {{paramName}} {{{description}}} +/// {{#allParams}} @param {{paramName}} {{{description}}} {{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} /// /// {{/allParams}} @returns {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}} /// diff --git a/modules/swagger-codegen/src/main/resources/php/api.mustache b/modules/swagger-codegen/src/main/resources/php/api.mustache index 1740a380102..1dfed441464 100644 --- a/modules/swagger-codegen/src/main/resources/php/api.mustache +++ b/modules/swagger-codegen/src/main/resources/php/api.mustache @@ -96,7 +96,7 @@ use \{{invokerPackage}}\ObjectSerializer; * * {{{summary}}} * - {{#allParams}} * @param {{dataType}} ${{paramName}} {{description}} {{#required}}(required){{/required}}{{^required}}(optional){{/required}} + {{#allParams}} * @param {{dataType}} ${{paramName}} {{description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} {{/allParams}} * @return {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}} * @throws \{{invokerPackage}}\ApiException on non-2xx response */ @@ -112,7 +112,7 @@ use \{{invokerPackage}}\ObjectSerializer; * * {{{summary}}} * - {{#allParams}} * @param {{dataType}} ${{paramName}} {{description}} {{#required}}(required){{/required}}{{^required}}(optional){{/required}} + {{#allParams}} * @param {{dataType}} ${{paramName}} {{description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} {{/allParams}} * @return Array of {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}null{{/returnType}}, HTTP status code, HTTP response headers (array of strings) * @throws \{{invokerPackage}}\ApiException on non-2xx response */ diff --git a/modules/swagger-codegen/src/main/resources/python/api.mustache b/modules/swagger-codegen/src/main/resources/python/api.mustache index 4d8b712a425..230f05d94af 100644 --- a/modules/swagger-codegen/src/main/resources/python/api.mustache +++ b/modules/swagger-codegen/src/main/resources/python/api.mustache @@ -68,7 +68,7 @@ class {{classname}}(object): :param callback function: The callback function for asynchronous request. (optional) {{#allParams}} - :param {{dataType}} {{paramName}}: {{{description}}}{{#required}} (required){{/required}}{{#optional}}(optional){{/optional}} + :param {{dataType}} {{paramName}}: {{{description}}}{{#required}} (required){{/required}}{{#optional}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/optional}} {{/allParams}} :return: {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}None{{/returnType}} If the method is called asynchronously, diff --git a/modules/swagger-codegen/src/main/resources/scala/api.mustache b/modules/swagger-codegen/src/main/resources/scala/api.mustache index 3b74dca8162..41b58374dea 100644 --- a/modules/swagger-codegen/src/main/resources/scala/api.mustache +++ b/modules/swagger-codegen/src/main/resources/scala/api.mustache @@ -27,7 +27,7 @@ class {{classname}}(val defBasePath: String = "{{basePath}}", /** * {{summary}} * {{notes}} -{{#allParams}} * @param {{paramName}} {{description}} +{{#allParams}} * @param {{paramName}} {{description}} {{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} {{/allParams}} * @return {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}} */ def {{operationId}} ({{#allParams}}{{paramName}}: {{dataType}}{{#defaultValue}} /* = {{{defaultValue}}} */{{/defaultValue}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) {{#returnType}}: Option[{{returnType}}]{{/returnType}} = { diff --git a/modules/swagger-codegen/src/main/resources/swift/api.mustache b/modules/swagger-codegen/src/main/resources/swift/api.mustache index 64757126563..ada4ec90d36 100644 --- a/modules/swagger-codegen/src/main/resources/swift/api.mustache +++ b/modules/swagger-codegen/src/main/resources/swift/api.mustache @@ -20,7 +20,7 @@ public class {{classname}}: APIBase { {{#summary}} {{{summary}}} {{/summary}}{{#allParams}} - - parameter {{paramName}}: ({{#isFormParam}}form{{/isFormParam}}{{#isQueryParam}}query{{/isQueryParam}}{{#isPathParam}}path{{/isPathParam}}{{#isHeaderParam}}header{{/isHeaderParam}}{{#isBodyParam}}body{{/isBodyParam}}) {{description}}{{/allParams}} + - parameter {{paramName}}: ({{#isFormParam}}form{{/isFormParam}}{{#isQueryParam}}query{{/isQueryParam}}{{#isPathParam}}path{{/isPathParam}}{{#isHeaderParam}}header{{/isHeaderParam}}{{#isBodyParam}}body{{/isBodyParam}}) {{description}} {{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{/allParams}} - parameter completion: completion handler to receive the data and the error objects */ public class func {{operationId}}({{#allParams}}{{^secondaryParam}}{{paramName}} {{/secondaryParam}}{{paramName}}: {{{dataType}}}{{^required}}?{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}{{#hasParams}}, {{/hasParams}}completion: (({{#returnType}}data: {{{returnType}}}?, {{/returnType}}error: ErrorType?) -> Void)) { @@ -34,7 +34,7 @@ public class {{classname}}: APIBase { {{#summary}} {{{summary}}} {{/summary}}{{#allParams}} - - parameter {{paramName}}: ({{#isFormParam}}form{{/isFormParam}}{{#isQueryParam}}query{{/isQueryParam}}{{#isPathParam}}path{{/isPathParam}}{{#isHeaderParam}}header{{/isHeaderParam}}{{#isBodyParam}}body{{/isBodyParam}}) {{description}}{{/allParams}} + - parameter {{paramName}}: ({{#isFormParam}}form{{/isFormParam}}{{#isQueryParam}}query{{/isQueryParam}}{{#isPathParam}}path{{/isPathParam}}{{#isHeaderParam}}header{{/isHeaderParam}}{{#isBodyParam}}body{{/isBodyParam}}) {{description}} {{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{/allParams}} - returns: Promise<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> */ public class func {{operationId}}({{#allParams}}{{^secondaryParam}}{{paramName}} {{/secondaryParam}}{{paramName}}: {{{dataType}}}{{^required}}?{{/required}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) -> Promise<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> { @@ -65,7 +65,7 @@ public class {{classname}}: APIBase { - examples: {{{examples}}}{{/examples}}{{#externalDocs}} - externalDocs: {{externalDocs}}{{/externalDocs}}{{#hasParams}} {{/hasParams}}{{#allParams}} - - parameter {{paramName}}: ({{#isFormParam}}form{{/isFormParam}}{{#isQueryParam}}query{{/isQueryParam}}{{#isPathParam}}path{{/isPathParam}}{{#isHeaderParam}}header{{/isHeaderParam}}{{#isBodyParam}}body{{/isBodyParam}}) {{description}}{{/allParams}} + - parameter {{paramName}}: ({{#isFormParam}}form{{/isFormParam}}{{#isQueryParam}}query{{/isQueryParam}}{{#isPathParam}}path{{/isPathParam}}{{#isHeaderParam}}header{{/isHeaderParam}}{{#isBodyParam}}body{{/isBodyParam}}) {{description}} {{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{/allParams}} - returns: RequestBuilder<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}> {{description}} */ diff --git a/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/PetApi.cs b/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/PetApi.cs index d37efe3b7b6..4c061a02d95 100644 --- a/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/PetApi.cs +++ b/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/PetApi.cs @@ -24,7 +24,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// Pet object that needs to be added to the store + /// Pet object that needs to be added to the store (optional) /// void AddPet (Pet body = null); @@ -35,7 +35,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// Pet object that needs to be added to the store + /// Pet object that needs to be added to the store (optional) /// ApiResponse of Object(void) ApiResponse AddPetWithHttpInfo (Pet body = null); @@ -46,7 +46,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// Pet object in the form of byte array + /// Pet object in the form of byte array (optional) /// void AddPetUsingByteArray (byte[] body = null); @@ -57,7 +57,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// Pet object in the form of byte array + /// Pet object in the form of byte array (optional) /// ApiResponse of Object(void) ApiResponse AddPetUsingByteArrayWithHttpInfo (byte[] body = null); @@ -69,7 +69,7 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// Pet id to delete - /// + /// (optional) /// void DeletePet (long? petId, string apiKey = null); @@ -81,7 +81,7 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// Pet id to delete - /// + /// (optional) /// ApiResponse of Object(void) ApiResponse DeletePetWithHttpInfo (long? petId, string apiKey = null); @@ -92,7 +92,7 @@ namespace IO.Swagger.Api /// Multiple status values can be provided with comma separated strings /// /// Thrown when fails to make API call - /// Status values that need to be considered for query + /// Status values that need to be considered for query (optional, default to available) /// List<Pet> List FindPetsByStatus (List status = null); @@ -103,7 +103,7 @@ namespace IO.Swagger.Api /// Multiple status values can be provided with comma separated strings /// /// Thrown when fails to make API call - /// Status values that need to be considered for query + /// Status values that need to be considered for query (optional, default to available) /// ApiResponse of List<Pet> ApiResponse> FindPetsByStatusWithHttpInfo (List status = null); @@ -114,7 +114,7 @@ namespace IO.Swagger.Api /// Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing. /// /// Thrown when fails to make API call - /// Tags to filter by + /// Tags to filter by (optional) /// List<Pet> List FindPetsByTags (List tags = null); @@ -125,7 +125,7 @@ namespace IO.Swagger.Api /// Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing. /// /// Thrown when fails to make API call - /// Tags to filter by + /// Tags to filter by (optional) /// ApiResponse of List<Pet> ApiResponse> FindPetsByTagsWithHttpInfo (List tags = null); @@ -202,7 +202,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// Pet object that needs to be added to the store + /// Pet object that needs to be added to the store (optional) /// void UpdatePet (Pet body = null); @@ -213,7 +213,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// Pet object that needs to be added to the store + /// Pet object that needs to be added to the store (optional) /// ApiResponse of Object(void) ApiResponse UpdatePetWithHttpInfo (Pet body = null); @@ -225,8 +225,8 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// ID of pet that needs to be updated - /// Updated name of the pet - /// Updated status of the pet + /// Updated name of the pet (optional) + /// Updated status of the pet (optional) /// void UpdatePetWithForm (string petId, string name = null, string status = null); @@ -238,8 +238,8 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// ID of pet that needs to be updated - /// Updated name of the pet - /// Updated status of the pet + /// Updated name of the pet (optional) + /// Updated status of the pet (optional) /// ApiResponse of Object(void) ApiResponse UpdatePetWithFormWithHttpInfo (string petId, string name = null, string status = null); @@ -251,8 +251,8 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// ID of pet to update - /// Additional data to pass to server - /// file to upload + /// Additional data to pass to server (optional) + /// file to upload (optional) /// void UploadFile (long? petId, string additionalMetadata = null, Stream file = null); @@ -264,8 +264,8 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// ID of pet to update - /// Additional data to pass to server - /// file to upload + /// Additional data to pass to server (optional) + /// file to upload (optional) /// ApiResponse of Object(void) ApiResponse UploadFileWithHttpInfo (long? petId, string additionalMetadata = null, Stream file = null); @@ -280,7 +280,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// Pet object that needs to be added to the store + /// Pet object that needs to be added to the store (optional) /// Task of void System.Threading.Tasks.Task AddPetAsync (Pet body = null); @@ -291,7 +291,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// Pet object that needs to be added to the store + /// Pet object that needs to be added to the store (optional) /// Task of ApiResponse System.Threading.Tasks.Task> AddPetAsyncWithHttpInfo (Pet body = null); @@ -302,7 +302,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// Pet object in the form of byte array + /// Pet object in the form of byte array (optional) /// Task of void System.Threading.Tasks.Task AddPetUsingByteArrayAsync (byte[] body = null); @@ -313,7 +313,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// Pet object in the form of byte array + /// Pet object in the form of byte array (optional) /// Task of ApiResponse System.Threading.Tasks.Task> AddPetUsingByteArrayAsyncWithHttpInfo (byte[] body = null); @@ -325,7 +325,7 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// Pet id to delete - /// + /// (optional) /// Task of void System.Threading.Tasks.Task DeletePetAsync (long? petId, string apiKey = null); @@ -337,7 +337,7 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// Pet id to delete - /// + /// (optional) /// Task of ApiResponse System.Threading.Tasks.Task> DeletePetAsyncWithHttpInfo (long? petId, string apiKey = null); @@ -348,7 +348,7 @@ namespace IO.Swagger.Api /// Multiple status values can be provided with comma separated strings /// /// Thrown when fails to make API call - /// Status values that need to be considered for query + /// Status values that need to be considered for query (optional, default to available) /// Task of List<Pet> System.Threading.Tasks.Task> FindPetsByStatusAsync (List status = null); @@ -359,7 +359,7 @@ namespace IO.Swagger.Api /// Multiple status values can be provided with comma separated strings /// /// Thrown when fails to make API call - /// Status values that need to be considered for query + /// Status values that need to be considered for query (optional, default to available) /// Task of ApiResponse (List<Pet>) System.Threading.Tasks.Task>> FindPetsByStatusAsyncWithHttpInfo (List status = null); @@ -370,7 +370,7 @@ namespace IO.Swagger.Api /// Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing. /// /// Thrown when fails to make API call - /// Tags to filter by + /// Tags to filter by (optional) /// Task of List<Pet> System.Threading.Tasks.Task> FindPetsByTagsAsync (List tags = null); @@ -381,7 +381,7 @@ namespace IO.Swagger.Api /// Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing. /// /// Thrown when fails to make API call - /// Tags to filter by + /// Tags to filter by (optional) /// Task of ApiResponse (List<Pet>) System.Threading.Tasks.Task>> FindPetsByTagsAsyncWithHttpInfo (List tags = null); @@ -458,7 +458,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// Pet object that needs to be added to the store + /// Pet object that needs to be added to the store (optional) /// Task of void System.Threading.Tasks.Task UpdatePetAsync (Pet body = null); @@ -469,7 +469,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// Pet object that needs to be added to the store + /// Pet object that needs to be added to the store (optional) /// Task of ApiResponse System.Threading.Tasks.Task> UpdatePetAsyncWithHttpInfo (Pet body = null); @@ -481,8 +481,8 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// ID of pet that needs to be updated - /// Updated name of the pet - /// Updated status of the pet + /// Updated name of the pet (optional) + /// Updated status of the pet (optional) /// Task of void System.Threading.Tasks.Task UpdatePetWithFormAsync (string petId, string name = null, string status = null); @@ -494,8 +494,8 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// ID of pet that needs to be updated - /// Updated name of the pet - /// Updated status of the pet + /// Updated name of the pet (optional) + /// Updated status of the pet (optional) /// Task of ApiResponse System.Threading.Tasks.Task> UpdatePetWithFormAsyncWithHttpInfo (string petId, string name = null, string status = null); @@ -507,8 +507,8 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// ID of pet to update - /// Additional data to pass to server - /// file to upload + /// Additional data to pass to server (optional) + /// file to upload (optional) /// Task of void System.Threading.Tasks.Task UploadFileAsync (long? petId, string additionalMetadata = null, Stream file = null); @@ -520,8 +520,8 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// ID of pet to update - /// Additional data to pass to server - /// file to upload + /// Additional data to pass to server (optional) + /// file to upload (optional) /// Task of ApiResponse System.Threading.Tasks.Task> UploadFileAsyncWithHttpInfo (long? petId, string additionalMetadata = null, Stream file = null); @@ -621,7 +621,7 @@ namespace IO.Swagger.Api /// Add a new pet to the store /// /// Thrown when fails to make API call - /// Pet object that needs to be added to the store + /// Pet object that needs to be added to the store (optional) /// public void AddPet (Pet body = null) { @@ -632,7 +632,7 @@ namespace IO.Swagger.Api /// Add a new pet to the store /// /// Thrown when fails to make API call - /// Pet object that needs to be added to the store + /// Pet object that needs to be added to the store (optional) /// ApiResponse of Object(void) public ApiResponse AddPetWithHttpInfo (Pet body = null) { @@ -709,7 +709,7 @@ namespace IO.Swagger.Api /// Add a new pet to the store /// /// Thrown when fails to make API call - /// Pet object that needs to be added to the store + /// Pet object that needs to be added to the store (optional) /// Task of void public async System.Threading.Tasks.Task AddPetAsync (Pet body = null) { @@ -721,7 +721,7 @@ namespace IO.Swagger.Api /// Add a new pet to the store /// /// Thrown when fails to make API call - /// Pet object that needs to be added to the store + /// Pet object that needs to be added to the store (optional) /// Task of ApiResponse public async System.Threading.Tasks.Task> AddPetAsyncWithHttpInfo (Pet body = null) { @@ -798,7 +798,7 @@ namespace IO.Swagger.Api /// Fake endpoint to test byte array in body parameter for adding a new pet to the store /// /// Thrown when fails to make API call - /// Pet object in the form of byte array + /// Pet object in the form of byte array (optional) /// public void AddPetUsingByteArray (byte[] body = null) { @@ -809,7 +809,7 @@ namespace IO.Swagger.Api /// Fake endpoint to test byte array in body parameter for adding a new pet to the store /// /// Thrown when fails to make API call - /// Pet object in the form of byte array + /// Pet object in the form of byte array (optional) /// ApiResponse of Object(void) public ApiResponse AddPetUsingByteArrayWithHttpInfo (byte[] body = null) { @@ -886,7 +886,7 @@ namespace IO.Swagger.Api /// Fake endpoint to test byte array in body parameter for adding a new pet to the store /// /// Thrown when fails to make API call - /// Pet object in the form of byte array + /// Pet object in the form of byte array (optional) /// Task of void public async System.Threading.Tasks.Task AddPetUsingByteArrayAsync (byte[] body = null) { @@ -898,7 +898,7 @@ namespace IO.Swagger.Api /// Fake endpoint to test byte array in body parameter for adding a new pet to the store /// /// Thrown when fails to make API call - /// Pet object in the form of byte array + /// Pet object in the form of byte array (optional) /// Task of ApiResponse public async System.Threading.Tasks.Task> AddPetUsingByteArrayAsyncWithHttpInfo (byte[] body = null) { @@ -976,7 +976,7 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// Pet id to delete - /// + /// (optional) /// public void DeletePet (long? petId, string apiKey = null) { @@ -988,7 +988,7 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// Pet id to delete - /// + /// (optional) /// ApiResponse of Object(void) public ApiResponse DeletePetWithHttpInfo (long? petId, string apiKey = null) { @@ -1065,7 +1065,7 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// Pet id to delete - /// + /// (optional) /// Task of void public async System.Threading.Tasks.Task DeletePetAsync (long? petId, string apiKey = null) { @@ -1078,7 +1078,7 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// Pet id to delete - /// + /// (optional) /// Task of ApiResponse public async System.Threading.Tasks.Task> DeletePetAsyncWithHttpInfo (long? petId, string apiKey = null) { @@ -1152,7 +1152,7 @@ namespace IO.Swagger.Api /// Finds Pets by status Multiple status values can be provided with comma separated strings /// /// Thrown when fails to make API call - /// Status values that need to be considered for query + /// Status values that need to be considered for query (optional, default to available) /// List<Pet> public List FindPetsByStatus (List status = null) { @@ -1164,7 +1164,7 @@ namespace IO.Swagger.Api /// Finds Pets by status Multiple status values can be provided with comma separated strings /// /// Thrown when fails to make API call - /// Status values that need to be considered for query + /// Status values that need to be considered for query (optional, default to available) /// ApiResponse of List<Pet> public ApiResponse< List > FindPetsByStatusWithHttpInfo (List status = null) { @@ -1235,7 +1235,7 @@ namespace IO.Swagger.Api /// Finds Pets by status Multiple status values can be provided with comma separated strings /// /// Thrown when fails to make API call - /// Status values that need to be considered for query + /// Status values that need to be considered for query (optional, default to available) /// Task of List<Pet> public async System.Threading.Tasks.Task> FindPetsByStatusAsync (List status = null) { @@ -1248,7 +1248,7 @@ namespace IO.Swagger.Api /// Finds Pets by status Multiple status values can be provided with comma separated strings /// /// Thrown when fails to make API call - /// Status values that need to be considered for query + /// Status values that need to be considered for query (optional, default to available) /// Task of ApiResponse (List<Pet>) public async System.Threading.Tasks.Task>> FindPetsByStatusAsyncWithHttpInfo (List status = null) { @@ -1319,7 +1319,7 @@ namespace IO.Swagger.Api /// Finds Pets by tags Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing. /// /// Thrown when fails to make API call - /// Tags to filter by + /// Tags to filter by (optional) /// List<Pet> public List FindPetsByTags (List tags = null) { @@ -1331,7 +1331,7 @@ namespace IO.Swagger.Api /// Finds Pets by tags Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing. /// /// Thrown when fails to make API call - /// Tags to filter by + /// Tags to filter by (optional) /// ApiResponse of List<Pet> public ApiResponse< List > FindPetsByTagsWithHttpInfo (List tags = null) { @@ -1402,7 +1402,7 @@ namespace IO.Swagger.Api /// Finds Pets by tags Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing. /// /// Thrown when fails to make API call - /// Tags to filter by + /// Tags to filter by (optional) /// Task of List<Pet> public async System.Threading.Tasks.Task> FindPetsByTagsAsync (List tags = null) { @@ -1415,7 +1415,7 @@ namespace IO.Swagger.Api /// Finds Pets by tags Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing. /// /// Thrown when fails to make API call - /// Tags to filter by + /// Tags to filter by (optional) /// Task of ApiResponse (List<Pet>) public async System.Threading.Tasks.Task>> FindPetsByTagsAsyncWithHttpInfo (List tags = null) { @@ -2044,7 +2044,7 @@ namespace IO.Swagger.Api /// Update an existing pet /// /// Thrown when fails to make API call - /// Pet object that needs to be added to the store + /// Pet object that needs to be added to the store (optional) /// public void UpdatePet (Pet body = null) { @@ -2055,7 +2055,7 @@ namespace IO.Swagger.Api /// Update an existing pet /// /// Thrown when fails to make API call - /// Pet object that needs to be added to the store + /// Pet object that needs to be added to the store (optional) /// ApiResponse of Object(void) public ApiResponse UpdatePetWithHttpInfo (Pet body = null) { @@ -2132,7 +2132,7 @@ namespace IO.Swagger.Api /// Update an existing pet /// /// Thrown when fails to make API call - /// Pet object that needs to be added to the store + /// Pet object that needs to be added to the store (optional) /// Task of void public async System.Threading.Tasks.Task UpdatePetAsync (Pet body = null) { @@ -2144,7 +2144,7 @@ namespace IO.Swagger.Api /// Update an existing pet /// /// Thrown when fails to make API call - /// Pet object that needs to be added to the store + /// Pet object that needs to be added to the store (optional) /// Task of ApiResponse public async System.Threading.Tasks.Task> UpdatePetAsyncWithHttpInfo (Pet body = null) { @@ -2222,8 +2222,8 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// ID of pet that needs to be updated - /// Updated name of the pet - /// Updated status of the pet + /// Updated name of the pet (optional) + /// Updated status of the pet (optional) /// public void UpdatePetWithForm (string petId, string name = null, string status = null) { @@ -2235,8 +2235,8 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// ID of pet that needs to be updated - /// Updated name of the pet - /// Updated status of the pet + /// Updated name of the pet (optional) + /// Updated status of the pet (optional) /// ApiResponse of Object(void) public ApiResponse UpdatePetWithFormWithHttpInfo (string petId, string name = null, string status = null) { @@ -2314,8 +2314,8 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// ID of pet that needs to be updated - /// Updated name of the pet - /// Updated status of the pet + /// Updated name of the pet (optional) + /// Updated status of the pet (optional) /// Task of void public async System.Threading.Tasks.Task UpdatePetWithFormAsync (string petId, string name = null, string status = null) { @@ -2328,8 +2328,8 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// ID of pet that needs to be updated - /// Updated name of the pet - /// Updated status of the pet + /// Updated name of the pet (optional) + /// Updated status of the pet (optional) /// Task of ApiResponse public async System.Threading.Tasks.Task> UpdatePetWithFormAsyncWithHttpInfo (string petId, string name = null, string status = null) { @@ -2405,8 +2405,8 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// ID of pet to update - /// Additional data to pass to server - /// file to upload + /// Additional data to pass to server (optional) + /// file to upload (optional) /// public void UploadFile (long? petId, string additionalMetadata = null, Stream file = null) { @@ -2418,8 +2418,8 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// ID of pet to update - /// Additional data to pass to server - /// file to upload + /// Additional data to pass to server (optional) + /// file to upload (optional) /// ApiResponse of Object(void) public ApiResponse UploadFileWithHttpInfo (long? petId, string additionalMetadata = null, Stream file = null) { @@ -2497,8 +2497,8 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// ID of pet to update - /// Additional data to pass to server - /// file to upload + /// Additional data to pass to server (optional) + /// file to upload (optional) /// Task of void public async System.Threading.Tasks.Task UploadFileAsync (long? petId, string additionalMetadata = null, Stream file = null) { @@ -2511,8 +2511,8 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// ID of pet to update - /// Additional data to pass to server - /// file to upload + /// Additional data to pass to server (optional) + /// file to upload (optional) /// Task of ApiResponse public async System.Threading.Tasks.Task> UploadFileAsyncWithHttpInfo (long? petId, string additionalMetadata = null, Stream file = null) { diff --git a/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/StoreApi.cs b/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/StoreApi.cs index 31d3fe1f71d..580adc1322c 100644 --- a/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/StoreApi.cs +++ b/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/StoreApi.cs @@ -46,7 +46,7 @@ namespace IO.Swagger.Api /// A single status value can be provided as a string /// /// Thrown when fails to make API call - /// Status value that needs to be considered for query + /// Status value that needs to be considered for query (optional, default to placed) /// List<Order> List FindOrdersByStatus (string status = null); @@ -57,7 +57,7 @@ namespace IO.Swagger.Api /// A single status value can be provided as a string /// /// Thrown when fails to make API call - /// Status value that needs to be considered for query + /// Status value that needs to be considered for query (optional, default to placed) /// ApiResponse of List<Order> ApiResponse> FindOrdersByStatusWithHttpInfo (string status = null); @@ -130,7 +130,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// order placed for purchasing the pet + /// order placed for purchasing the pet (optional) /// Order Order PlaceOrder (Order body = null); @@ -141,7 +141,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// order placed for purchasing the pet + /// order placed for purchasing the pet (optional) /// ApiResponse of Order ApiResponse PlaceOrderWithHttpInfo (Order body = null); @@ -178,7 +178,7 @@ namespace IO.Swagger.Api /// A single status value can be provided as a string /// /// Thrown when fails to make API call - /// Status value that needs to be considered for query + /// Status value that needs to be considered for query (optional, default to placed) /// Task of List<Order> System.Threading.Tasks.Task> FindOrdersByStatusAsync (string status = null); @@ -189,7 +189,7 @@ namespace IO.Swagger.Api /// A single status value can be provided as a string /// /// Thrown when fails to make API call - /// Status value that needs to be considered for query + /// Status value that needs to be considered for query (optional, default to placed) /// Task of ApiResponse (List<Order>) System.Threading.Tasks.Task>> FindOrdersByStatusAsyncWithHttpInfo (string status = null); @@ -262,7 +262,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// order placed for purchasing the pet + /// order placed for purchasing the pet (optional) /// Task of Order System.Threading.Tasks.Task PlaceOrderAsync (Order body = null); @@ -273,7 +273,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// order placed for purchasing the pet + /// order placed for purchasing the pet (optional) /// Task of ApiResponse (Order) System.Threading.Tasks.Task> PlaceOrderAsyncWithHttpInfo (Order body = null); @@ -529,7 +529,7 @@ namespace IO.Swagger.Api /// Finds orders by status A single status value can be provided as a string /// /// Thrown when fails to make API call - /// Status value that needs to be considered for query + /// Status value that needs to be considered for query (optional, default to placed) /// List<Order> public List FindOrdersByStatus (string status = null) { @@ -541,7 +541,7 @@ namespace IO.Swagger.Api /// Finds orders by status A single status value can be provided as a string /// /// Thrown when fails to make API call - /// Status value that needs to be considered for query + /// Status value that needs to be considered for query (optional, default to placed) /// ApiResponse of List<Order> public ApiResponse< List > FindOrdersByStatusWithHttpInfo (string status = null) { @@ -617,7 +617,7 @@ namespace IO.Swagger.Api /// Finds orders by status A single status value can be provided as a string /// /// Thrown when fails to make API call - /// Status value that needs to be considered for query + /// Status value that needs to be considered for query (optional, default to placed) /// Task of List<Order> public async System.Threading.Tasks.Task> FindOrdersByStatusAsync (string status = null) { @@ -630,7 +630,7 @@ namespace IO.Swagger.Api /// Finds orders by status A single status value can be provided as a string /// /// Thrown when fails to make API call - /// Status value that needs to be considered for query + /// Status value that needs to be considered for query (optional, default to placed) /// Task of ApiResponse (List<Order>) public async System.Threading.Tasks.Task>> FindOrdersByStatusAsyncWithHttpInfo (string status = null) { @@ -1209,7 +1209,7 @@ namespace IO.Swagger.Api /// Place an order for a pet /// /// Thrown when fails to make API call - /// order placed for purchasing the pet + /// order placed for purchasing the pet (optional) /// Order public Order PlaceOrder (Order body = null) { @@ -1221,7 +1221,7 @@ namespace IO.Swagger.Api /// Place an order for a pet /// /// Thrown when fails to make API call - /// order placed for purchasing the pet + /// order placed for purchasing the pet (optional) /// ApiResponse of Order public ApiResponse< Order > PlaceOrderWithHttpInfo (Order body = null) { @@ -1303,7 +1303,7 @@ namespace IO.Swagger.Api /// Place an order for a pet /// /// Thrown when fails to make API call - /// order placed for purchasing the pet + /// order placed for purchasing the pet (optional) /// Task of Order public async System.Threading.Tasks.Task PlaceOrderAsync (Order body = null) { @@ -1316,7 +1316,7 @@ namespace IO.Swagger.Api /// Place an order for a pet /// /// Thrown when fails to make API call - /// order placed for purchasing the pet + /// order placed for purchasing the pet (optional) /// Task of ApiResponse (Order) public async System.Threading.Tasks.Task> PlaceOrderAsyncWithHttpInfo (Order body = null) { diff --git a/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/UserApi.cs b/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/UserApi.cs index 29cc550eef2..71ad89f6397 100644 --- a/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/UserApi.cs +++ b/samples/client/petstore/csharp/SwaggerClientTest/Lib/SwaggerClient/src/main/csharp/IO/Swagger/Api/UserApi.cs @@ -24,7 +24,7 @@ namespace IO.Swagger.Api /// This can only be done by the logged in user. /// /// Thrown when fails to make API call - /// Created user object + /// Created user object (optional) /// void CreateUser (User body = null); @@ -35,7 +35,7 @@ namespace IO.Swagger.Api /// This can only be done by the logged in user. /// /// Thrown when fails to make API call - /// Created user object + /// Created user object (optional) /// ApiResponse of Object(void) ApiResponse CreateUserWithHttpInfo (User body = null); @@ -46,7 +46,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// List of user object + /// List of user object (optional) /// void CreateUsersWithArrayInput (List body = null); @@ -57,7 +57,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// List of user object + /// List of user object (optional) /// ApiResponse of Object(void) ApiResponse CreateUsersWithArrayInputWithHttpInfo (List body = null); @@ -68,7 +68,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// List of user object + /// List of user object (optional) /// void CreateUsersWithListInput (List body = null); @@ -79,7 +79,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// List of user object + /// List of user object (optional) /// ApiResponse of Object(void) ApiResponse CreateUsersWithListInputWithHttpInfo (List body = null); @@ -134,8 +134,8 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// The user name for login - /// The password for login in clear text + /// The user name for login (optional) + /// The password for login in clear text (optional) /// string string LoginUser (string username = null, string password = null); @@ -146,8 +146,8 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// The user name for login - /// The password for login in clear text + /// The user name for login (optional) + /// The password for login in clear text (optional) /// ApiResponse of string ApiResponse LoginUserWithHttpInfo (string username = null, string password = null); @@ -179,7 +179,7 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// name that need to be deleted - /// Updated user object + /// Updated user object (optional) /// void UpdateUser (string username, User body = null); @@ -191,7 +191,7 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// name that need to be deleted - /// Updated user object + /// Updated user object (optional) /// ApiResponse of Object(void) ApiResponse UpdateUserWithHttpInfo (string username, User body = null); @@ -206,7 +206,7 @@ namespace IO.Swagger.Api /// This can only be done by the logged in user. /// /// Thrown when fails to make API call - /// Created user object + /// Created user object (optional) /// Task of void System.Threading.Tasks.Task CreateUserAsync (User body = null); @@ -217,7 +217,7 @@ namespace IO.Swagger.Api /// This can only be done by the logged in user. /// /// Thrown when fails to make API call - /// Created user object + /// Created user object (optional) /// Task of ApiResponse System.Threading.Tasks.Task> CreateUserAsyncWithHttpInfo (User body = null); @@ -228,7 +228,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// List of user object + /// List of user object (optional) /// Task of void System.Threading.Tasks.Task CreateUsersWithArrayInputAsync (List body = null); @@ -239,7 +239,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// List of user object + /// List of user object (optional) /// Task of ApiResponse System.Threading.Tasks.Task> CreateUsersWithArrayInputAsyncWithHttpInfo (List body = null); @@ -250,7 +250,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// List of user object + /// List of user object (optional) /// Task of void System.Threading.Tasks.Task CreateUsersWithListInputAsync (List body = null); @@ -261,7 +261,7 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// List of user object + /// List of user object (optional) /// Task of ApiResponse System.Threading.Tasks.Task> CreateUsersWithListInputAsyncWithHttpInfo (List body = null); @@ -316,8 +316,8 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// The user name for login - /// The password for login in clear text + /// The user name for login (optional) + /// The password for login in clear text (optional) /// Task of string System.Threading.Tasks.Task LoginUserAsync (string username = null, string password = null); @@ -328,8 +328,8 @@ namespace IO.Swagger.Api /// /// /// Thrown when fails to make API call - /// The user name for login - /// The password for login in clear text + /// The user name for login (optional) + /// The password for login in clear text (optional) /// Task of ApiResponse (string) System.Threading.Tasks.Task> LoginUserAsyncWithHttpInfo (string username = null, string password = null); @@ -361,7 +361,7 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// name that need to be deleted - /// Updated user object + /// Updated user object (optional) /// Task of void System.Threading.Tasks.Task UpdateUserAsync (string username, User body = null); @@ -373,7 +373,7 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// name that need to be deleted - /// Updated user object + /// Updated user object (optional) /// Task of ApiResponse System.Threading.Tasks.Task> UpdateUserAsyncWithHttpInfo (string username, User body = null); @@ -473,7 +473,7 @@ namespace IO.Swagger.Api /// Create user This can only be done by the logged in user. /// /// Thrown when fails to make API call - /// Created user object + /// Created user object (optional) /// public void CreateUser (User body = null) { @@ -484,7 +484,7 @@ namespace IO.Swagger.Api /// Create user This can only be done by the logged in user. /// /// Thrown when fails to make API call - /// Created user object + /// Created user object (optional) /// ApiResponse of Object(void) public ApiResponse CreateUserWithHttpInfo (User body = null) { @@ -554,7 +554,7 @@ namespace IO.Swagger.Api /// Create user This can only be done by the logged in user. /// /// Thrown when fails to make API call - /// Created user object + /// Created user object (optional) /// Task of void public async System.Threading.Tasks.Task CreateUserAsync (User body = null) { @@ -566,7 +566,7 @@ namespace IO.Swagger.Api /// Create user This can only be done by the logged in user. /// /// Thrown when fails to make API call - /// Created user object + /// Created user object (optional) /// Task of ApiResponse public async System.Threading.Tasks.Task> CreateUserAsyncWithHttpInfo (User body = null) { @@ -635,7 +635,7 @@ namespace IO.Swagger.Api /// Creates list of users with given input array /// /// Thrown when fails to make API call - /// List of user object + /// List of user object (optional) /// public void CreateUsersWithArrayInput (List body = null) { @@ -646,7 +646,7 @@ namespace IO.Swagger.Api /// Creates list of users with given input array /// /// Thrown when fails to make API call - /// List of user object + /// List of user object (optional) /// ApiResponse of Object(void) public ApiResponse CreateUsersWithArrayInputWithHttpInfo (List body = null) { @@ -716,7 +716,7 @@ namespace IO.Swagger.Api /// Creates list of users with given input array /// /// Thrown when fails to make API call - /// List of user object + /// List of user object (optional) /// Task of void public async System.Threading.Tasks.Task CreateUsersWithArrayInputAsync (List body = null) { @@ -728,7 +728,7 @@ namespace IO.Swagger.Api /// Creates list of users with given input array /// /// Thrown when fails to make API call - /// List of user object + /// List of user object (optional) /// Task of ApiResponse public async System.Threading.Tasks.Task> CreateUsersWithArrayInputAsyncWithHttpInfo (List body = null) { @@ -797,7 +797,7 @@ namespace IO.Swagger.Api /// Creates list of users with given input array /// /// Thrown when fails to make API call - /// List of user object + /// List of user object (optional) /// public void CreateUsersWithListInput (List body = null) { @@ -808,7 +808,7 @@ namespace IO.Swagger.Api /// Creates list of users with given input array /// /// Thrown when fails to make API call - /// List of user object + /// List of user object (optional) /// ApiResponse of Object(void) public ApiResponse CreateUsersWithListInputWithHttpInfo (List body = null) { @@ -878,7 +878,7 @@ namespace IO.Swagger.Api /// Creates list of users with given input array /// /// Thrown when fails to make API call - /// List of user object + /// List of user object (optional) /// Task of void public async System.Threading.Tasks.Task CreateUsersWithListInputAsync (List body = null) { @@ -890,7 +890,7 @@ namespace IO.Swagger.Api /// Creates list of users with given input array /// /// Thrown when fails to make API call - /// List of user object + /// List of user object (optional) /// Task of ApiResponse public async System.Threading.Tasks.Task> CreateUsersWithListInputAsyncWithHttpInfo (List body = null) { @@ -1288,8 +1288,8 @@ namespace IO.Swagger.Api /// Logs user into the system /// /// Thrown when fails to make API call - /// The user name for login - /// The password for login in clear text + /// The user name for login (optional) + /// The password for login in clear text (optional) /// string public string LoginUser (string username = null, string password = null) { @@ -1301,8 +1301,8 @@ namespace IO.Swagger.Api /// Logs user into the system /// /// Thrown when fails to make API call - /// The user name for login - /// The password for login in clear text + /// The user name for login (optional) + /// The password for login in clear text (optional) /// ApiResponse of string public ApiResponse< string > LoginUserWithHttpInfo (string username = null, string password = null) { @@ -1367,8 +1367,8 @@ namespace IO.Swagger.Api /// Logs user into the system /// /// Thrown when fails to make API call - /// The user name for login - /// The password for login in clear text + /// The user name for login (optional) + /// The password for login in clear text (optional) /// Task of string public async System.Threading.Tasks.Task LoginUserAsync (string username = null, string password = null) { @@ -1381,8 +1381,8 @@ namespace IO.Swagger.Api /// Logs user into the system /// /// Thrown when fails to make API call - /// The user name for login - /// The password for login in clear text + /// The user name for login (optional) + /// The password for login in clear text (optional) /// Task of ApiResponse (string) public async System.Threading.Tasks.Task> LoginUserAsyncWithHttpInfo (string username = null, string password = null) { @@ -1591,7 +1591,7 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// name that need to be deleted - /// Updated user object + /// Updated user object (optional) /// public void UpdateUser (string username, User body = null) { @@ -1603,7 +1603,7 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// name that need to be deleted - /// Updated user object + /// Updated user object (optional) /// ApiResponse of Object(void) public ApiResponse UpdateUserWithHttpInfo (string username, User body = null) { @@ -1679,7 +1679,7 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// name that need to be deleted - /// Updated user object + /// Updated user object (optional) /// Task of void public async System.Threading.Tasks.Task UpdateUserAsync (string username, User body = null) { @@ -1692,7 +1692,7 @@ namespace IO.Swagger.Api /// /// Thrown when fails to make API call /// name that need to be deleted - /// Updated user object + /// Updated user object (optional) /// Task of ApiResponse public async System.Threading.Tasks.Task> UpdateUserAsyncWithHttpInfo (string username, User body = null) { diff --git a/samples/client/petstore/objc/SwaggerClient/SWGPetApi.m b/samples/client/petstore/objc/SwaggerClient/SWGPetApi.m index 41c54dc2973..2b7bab6144a 100644 --- a/samples/client/petstore/objc/SwaggerClient/SWGPetApi.m +++ b/samples/client/petstore/objc/SwaggerClient/SWGPetApi.m @@ -73,7 +73,7 @@ static SWGPetApi* singletonAPI = nil; /// /// Add a new pet to the store /// -/// @param body Pet object that needs to be added to the store +/// @param body Pet object that needs to be added to the store (optional) /// /// @returns void /// @@ -148,7 +148,7 @@ static SWGPetApi* singletonAPI = nil; /// /// Fake endpoint to test byte array in body parameter for adding a new pet to the store /// -/// @param body Pet object in the form of byte array +/// @param body Pet object in the form of byte array (optional) /// /// @returns void /// @@ -223,9 +223,9 @@ static SWGPetApi* singletonAPI = nil; /// /// Deletes a pet /// -/// @param petId Pet id to delete +/// @param petId Pet id to delete /// -/// @param apiKey +/// @param apiKey (optional) /// /// @returns void /// @@ -312,7 +312,7 @@ static SWGPetApi* singletonAPI = nil; /// /// Finds Pets by status /// Multiple status values can be provided with comma separated strings -/// @param status Status values that need to be considered for query +/// @param status Status values that need to be considered for query (optional, default to available) /// /// @returns NSArray* /// @@ -393,7 +393,7 @@ static SWGPetApi* singletonAPI = nil; /// /// Finds Pets by tags /// Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing. -/// @param tags Tags to filter by +/// @param tags Tags to filter by (optional) /// /// @returns NSArray* /// @@ -474,7 +474,7 @@ static SWGPetApi* singletonAPI = nil; /// /// Find pet by ID /// Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions -/// @param petId ID of pet that needs to be fetched +/// @param petId ID of pet that needs to be fetched /// /// @returns SWGPet* /// @@ -557,7 +557,7 @@ static SWGPetApi* singletonAPI = nil; /// /// Fake endpoint to test inline arbitrary object return by 'Find pet by ID' /// Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions -/// @param petId ID of pet that needs to be fetched +/// @param petId ID of pet that needs to be fetched /// /// @returns SWGInlineResponse200* /// @@ -640,7 +640,7 @@ static SWGPetApi* singletonAPI = nil; /// /// Fake endpoint to test byte array return by 'Find pet by ID' /// Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions -/// @param petId ID of pet that needs to be fetched +/// @param petId ID of pet that needs to be fetched /// /// @returns NSString* /// @@ -723,7 +723,7 @@ static SWGPetApi* singletonAPI = nil; /// /// Update an existing pet /// -/// @param body Pet object that needs to be added to the store +/// @param body Pet object that needs to be added to the store (optional) /// /// @returns void /// @@ -798,11 +798,11 @@ static SWGPetApi* singletonAPI = nil; /// /// Updates a pet in the store with form data /// -/// @param petId ID of pet that needs to be updated +/// @param petId ID of pet that needs to be updated /// -/// @param name Updated name of the pet +/// @param name Updated name of the pet (optional) /// -/// @param status Updated status of the pet +/// @param status Updated status of the pet (optional) /// /// @returns void /// @@ -899,11 +899,11 @@ static SWGPetApi* singletonAPI = nil; /// /// uploads an image /// -/// @param petId ID of pet to update +/// @param petId ID of pet to update /// -/// @param additionalMetadata Additional data to pass to server +/// @param additionalMetadata Additional data to pass to server (optional) /// -/// @param file file to upload +/// @param file file to upload (optional) /// /// @returns void /// diff --git a/samples/client/petstore/objc/SwaggerClient/SWGStoreApi.m b/samples/client/petstore/objc/SwaggerClient/SWGStoreApi.m index 6be6cb8da22..b66ba1f125b 100644 --- a/samples/client/petstore/objc/SwaggerClient/SWGStoreApi.m +++ b/samples/client/petstore/objc/SwaggerClient/SWGStoreApi.m @@ -72,7 +72,7 @@ static SWGStoreApi* singletonAPI = nil; /// /// Delete purchase order by ID /// For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors -/// @param orderId ID of the order that needs to be deleted +/// @param orderId ID of the order that needs to be deleted /// /// @returns void /// @@ -155,7 +155,7 @@ static SWGStoreApi* singletonAPI = nil; /// /// Finds orders by status /// A single status value can be provided as a string -/// @param status Status value that needs to be considered for query +/// @param status Status value that needs to be considered for query (optional, default to placed) /// /// @returns NSArray* /// @@ -380,7 +380,7 @@ static SWGStoreApi* singletonAPI = nil; /// /// Find purchase order by ID /// For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions -/// @param orderId ID of pet that needs to be fetched +/// @param orderId ID of pet that needs to be fetched /// /// @returns SWGOrder* /// @@ -463,7 +463,7 @@ static SWGStoreApi* singletonAPI = nil; /// /// Place an order for a pet /// -/// @param body order placed for purchasing the pet +/// @param body order placed for purchasing the pet (optional) /// /// @returns SWGOrder* /// diff --git a/samples/client/petstore/objc/SwaggerClient/SWGUserApi.m b/samples/client/petstore/objc/SwaggerClient/SWGUserApi.m index 407bc15f000..7699ca74bcf 100644 --- a/samples/client/petstore/objc/SwaggerClient/SWGUserApi.m +++ b/samples/client/petstore/objc/SwaggerClient/SWGUserApi.m @@ -72,7 +72,7 @@ static SWGUserApi* singletonAPI = nil; /// /// Create user /// This can only be done by the logged in user. -/// @param body Created user object +/// @param body Created user object (optional) /// /// @returns void /// @@ -147,7 +147,7 @@ static SWGUserApi* singletonAPI = nil; /// /// Creates list of users with given input array /// -/// @param body List of user object +/// @param body List of user object (optional) /// /// @returns void /// @@ -222,7 +222,7 @@ static SWGUserApi* singletonAPI = nil; /// /// Creates list of users with given input array /// -/// @param body List of user object +/// @param body List of user object (optional) /// /// @returns void /// @@ -297,7 +297,7 @@ static SWGUserApi* singletonAPI = nil; /// /// Delete user /// This can only be done by the logged in user. -/// @param username The name that needs to be deleted +/// @param username The name that needs to be deleted /// /// @returns void /// @@ -380,7 +380,7 @@ static SWGUserApi* singletonAPI = nil; /// /// Get user by user name /// -/// @param username The name that needs to be fetched. Use user1 for testing. +/// @param username The name that needs to be fetched. Use user1 for testing. /// /// @returns SWGUser* /// @@ -463,9 +463,9 @@ static SWGUserApi* singletonAPI = nil; /// /// Logs user into the system /// -/// @param username The user name for login +/// @param username The user name for login (optional) /// -/// @param password The password for login in clear text +/// @param password The password for login in clear text (optional) /// /// @returns NSString* /// @@ -622,9 +622,9 @@ static SWGUserApi* singletonAPI = nil; /// /// Updated user /// This can only be done by the logged in user. -/// @param username name that need to be deleted +/// @param username name that need to be deleted /// -/// @param body Updated user object +/// @param body Updated user object (optional) /// /// @returns void /// diff --git a/samples/client/petstore/php/SwaggerClient-php/README.md b/samples/client/petstore/php/SwaggerClient-php/README.md index addcbc63f39..39f43b94dbb 100644 --- a/samples/client/petstore/php/SwaggerClient-php/README.md +++ b/samples/client/petstore/php/SwaggerClient-php/README.md @@ -5,7 +5,7 @@ This SDK is automatically generated by the [Swagger Codegen](https://github.com/ - API verion: 1.0.0 - Package version: 1.0.0 -- Build date: 2016-03-17T16:51:52.647+08:00 +- Build date: 2016-03-17T17:35:57.786+08:00 - Build package: class io.swagger.codegen.languages.PhpClientCodegen ## Requirements diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/Api/PetApi.php b/samples/client/petstore/php/SwaggerClient-php/lib/Api/PetApi.php index b3bf40d11e0..5c2c0564c70 100644 --- a/samples/client/petstore/php/SwaggerClient-php/lib/Api/PetApi.php +++ b/samples/client/petstore/php/SwaggerClient-php/lib/Api/PetApi.php @@ -362,7 +362,7 @@ class PetApi * * Finds Pets by status * - * @param string[] $status Status values that need to be considered for query (optional) + * @param string[] $status Status values that need to be considered for query (optional, default to available) * @return \Swagger\Client\Model\Pet[] * @throws \Swagger\Client\ApiException on non-2xx response */ @@ -378,7 +378,7 @@ class PetApi * * Finds Pets by status * - * @param string[] $status Status values that need to be considered for query (optional) + * @param string[] $status Status values that need to be considered for query (optional, default to available) * @return Array of \Swagger\Client\Model\Pet[], HTTP status code, HTTP response headers (array of strings) * @throws \Swagger\Client\ApiException on non-2xx response */ diff --git a/samples/client/petstore/php/SwaggerClient-php/lib/Api/StoreApi.php b/samples/client/petstore/php/SwaggerClient-php/lib/Api/StoreApi.php index 91dc0cde444..b510b4a3b6e 100644 --- a/samples/client/petstore/php/SwaggerClient-php/lib/Api/StoreApi.php +++ b/samples/client/petstore/php/SwaggerClient-php/lib/Api/StoreApi.php @@ -183,7 +183,7 @@ class StoreApi * * Finds orders by status * - * @param string $status Status value that needs to be considered for query (optional) + * @param string $status Status value that needs to be considered for query (optional, default to placed) * @return \Swagger\Client\Model\Order[] * @throws \Swagger\Client\ApiException on non-2xx response */ @@ -199,7 +199,7 @@ class StoreApi * * Finds orders by status * - * @param string $status Status value that needs to be considered for query (optional) + * @param string $status Status value that needs to be considered for query (optional, default to placed) * @return Array of \Swagger\Client\Model\Order[], HTTP status code, HTTP response headers (array of strings) * @throws \Swagger\Client\ApiException on non-2xx response */ diff --git a/samples/client/petstore/scala/src/main/scala/io/swagger/client/api/PetApi.scala b/samples/client/petstore/scala/src/main/scala/io/swagger/client/api/PetApi.scala index cccc54415db..c52f7159e4c 100644 --- a/samples/client/petstore/scala/src/main/scala/io/swagger/client/api/PetApi.scala +++ b/samples/client/petstore/scala/src/main/scala/io/swagger/client/api/PetApi.scala @@ -27,7 +27,7 @@ class PetApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Add a new pet to the store * - * @param body Pet object that needs to be added to the store + * @param body Pet object that needs to be added to the store (optional) * @return void */ def addPet (body: Pet) = { @@ -74,7 +74,7 @@ class PetApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Fake endpoint to test byte array in body parameter for adding a new pet to the store * - * @param body Pet object in the form of byte array + * @param body Pet object in the form of byte array (optional) * @return void */ def addPetUsingByteArray (body: String) = { @@ -121,8 +121,8 @@ class PetApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Deletes a pet * - * @param petId Pet id to delete - * @param apiKey + * @param petId Pet id to delete + * @param apiKey (optional) * @return void */ def deletePet (petId: Long, apiKey: String) = { @@ -172,7 +172,7 @@ class PetApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Finds Pets by status * Multiple status values can be provided with comma separated strings - * @param status Status values that need to be considered for query + * @param status Status values that need to be considered for query (optional, default to available) * @return List[Pet] */ def findPetsByStatus (status: List[String] /* = available */) : Option[List[Pet]] = { @@ -221,7 +221,7 @@ class PetApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Finds Pets by tags * Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing. - * @param tags Tags to filter by + * @param tags Tags to filter by (optional) * @return List[Pet] */ def findPetsByTags (tags: List[String]) : Option[List[Pet]] = { @@ -270,7 +270,7 @@ class PetApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Find pet by ID * Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions - * @param petId ID of pet that needs to be fetched + * @param petId ID of pet that needs to be fetched * @return Pet */ def getPetById (petId: Long) : Option[Pet] = { @@ -320,7 +320,7 @@ class PetApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Fake endpoint to test inline arbitrary object return by 'Find pet by ID' * Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions - * @param petId ID of pet that needs to be fetched + * @param petId ID of pet that needs to be fetched * @return InlineResponse200 */ def getPetByIdInObject (petId: Long) : Option[InlineResponse200] = { @@ -370,7 +370,7 @@ class PetApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Fake endpoint to test byte array return by 'Find pet by ID' * Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions - * @param petId ID of pet that needs to be fetched + * @param petId ID of pet that needs to be fetched * @return String */ def petPetIdtestingByteArraytrueGet (petId: Long) : Option[String] = { @@ -420,7 +420,7 @@ class PetApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Update an existing pet * - * @param body Pet object that needs to be added to the store + * @param body Pet object that needs to be added to the store (optional) * @return void */ def updatePet (body: Pet) = { @@ -467,9 +467,9 @@ class PetApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Updates a pet in the store with form data * - * @param petId ID of pet that needs to be updated - * @param name Updated name of the pet - * @param status Updated status of the pet + * @param petId ID of pet that needs to be updated + * @param name Updated name of the pet (optional) + * @param status Updated status of the pet (optional) * @return void */ def updatePetWithForm (petId: String, name: String, status: String) = { @@ -524,9 +524,9 @@ class PetApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * uploads an image * - * @param petId ID of pet to update - * @param additionalMetadata Additional data to pass to server - * @param file file to upload + * @param petId ID of pet to update + * @param additionalMetadata Additional data to pass to server (optional) + * @param file file to upload (optional) * @return void */ def uploadFile (petId: Long, additionalMetadata: String, file: File) = { diff --git a/samples/client/petstore/scala/src/main/scala/io/swagger/client/api/StoreApi.scala b/samples/client/petstore/scala/src/main/scala/io/swagger/client/api/StoreApi.scala index 2b0289ae2dc..388c612976f 100644 --- a/samples/client/petstore/scala/src/main/scala/io/swagger/client/api/StoreApi.scala +++ b/samples/client/petstore/scala/src/main/scala/io/swagger/client/api/StoreApi.scala @@ -25,7 +25,7 @@ class StoreApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Delete purchase order by ID * For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors - * @param orderId ID of the order that needs to be deleted + * @param orderId ID of the order that needs to be deleted * @return void */ def deleteOrder (orderId: String) = { @@ -74,7 +74,7 @@ class StoreApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Finds orders by status * A single status value can be provided as a string - * @param status Status value that needs to be considered for query + * @param status Status value that needs to be considered for query (optional, default to placed) * @return List[Order] */ def findOrdersByStatus (status: String /* = placed */) : Option[List[Order]] = { @@ -217,7 +217,7 @@ class StoreApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Find purchase order by ID * For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions - * @param orderId ID of pet that needs to be fetched + * @param orderId ID of pet that needs to be fetched * @return Order */ def getOrderById (orderId: String) : Option[Order] = { @@ -267,7 +267,7 @@ class StoreApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Place an order for a pet * - * @param body order placed for purchasing the pet + * @param body order placed for purchasing the pet (optional) * @return Order */ def placeOrder (body: Order) : Option[Order] = { diff --git a/samples/client/petstore/scala/src/main/scala/io/swagger/client/api/UserApi.scala b/samples/client/petstore/scala/src/main/scala/io/swagger/client/api/UserApi.scala index e728ddfe311..e68922f3cce 100644 --- a/samples/client/petstore/scala/src/main/scala/io/swagger/client/api/UserApi.scala +++ b/samples/client/petstore/scala/src/main/scala/io/swagger/client/api/UserApi.scala @@ -25,7 +25,7 @@ class UserApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Create user * This can only be done by the logged in user. - * @param body Created user object + * @param body Created user object (optional) * @return void */ def createUser (body: User) = { @@ -72,7 +72,7 @@ class UserApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Creates list of users with given input array * - * @param body List of user object + * @param body List of user object (optional) * @return void */ def createUsersWithArrayInput (body: List[User]) = { @@ -119,7 +119,7 @@ class UserApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Creates list of users with given input array * - * @param body List of user object + * @param body List of user object (optional) * @return void */ def createUsersWithListInput (body: List[User]) = { @@ -166,7 +166,7 @@ class UserApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Delete user * This can only be done by the logged in user. - * @param username The name that needs to be deleted + * @param username The name that needs to be deleted * @return void */ def deleteUser (username: String) = { @@ -215,7 +215,7 @@ class UserApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Get user by user name * - * @param username The name that needs to be fetched. Use user1 for testing. + * @param username The name that needs to be fetched. Use user1 for testing. * @return User */ def getUserByName (username: String) : Option[User] = { @@ -265,8 +265,8 @@ class UserApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Logs user into the system * - * @param username The user name for login - * @param password The password for login in clear text + * @param username The user name for login (optional) + * @param password The password for login in clear text (optional) * @return String */ def loginUser (username: String, password: String) : Option[String] = { @@ -362,8 +362,8 @@ class UserApi(val defBasePath: String = "http://petstore.swagger.io/v2", /** * Updated user * This can only be done by the logged in user. - * @param username name that need to be deleted - * @param body Updated user object + * @param username name that need to be deleted + * @param body Updated user object (optional) * @return void */ def updateUser (username: String, body: User) = { diff --git a/samples/client/petstore/swift/PetstoreClient/Classes/Swaggers/APIs/PetAPI.swift b/samples/client/petstore/swift/PetstoreClient/Classes/Swaggers/APIs/PetAPI.swift index 3e24fae5153..ddb328e8ee5 100644 --- a/samples/client/petstore/swift/PetstoreClient/Classes/Swaggers/APIs/PetAPI.swift +++ b/samples/client/petstore/swift/PetstoreClient/Classes/Swaggers/APIs/PetAPI.swift @@ -15,7 +15,7 @@ public class PetAPI: APIBase { Add a new pet to the store - - parameter body: (body) Pet object that needs to be added to the store + - parameter body: (body) Pet object that needs to be added to the store (optional) - parameter completion: completion handler to receive the data and the error objects */ public class func addPet(body body: Pet?, completion: ((error: ErrorType?) -> Void)) { @@ -28,7 +28,7 @@ public class PetAPI: APIBase { Add a new pet to the store - - parameter body: (body) Pet object that needs to be added to the store + - parameter body: (body) Pet object that needs to be added to the store (optional) - returns: Promise */ public class func addPet(body body: Pet?) -> Promise { @@ -53,7 +53,7 @@ public class PetAPI: APIBase { - type: oauth2 - name: petstore_auth - - parameter body: (body) Pet object that needs to be added to the store + - parameter body: (body) Pet object that needs to be added to the store (optional) - returns: RequestBuilder */ @@ -72,7 +72,7 @@ public class PetAPI: APIBase { Fake endpoint to test byte array in body parameter for adding a new pet to the store - - parameter body: (body) Pet object in the form of byte array + - parameter body: (body) Pet object in the form of byte array (optional) - parameter completion: completion handler to receive the data and the error objects */ public class func addPetUsingByteArray(body body: String?, completion: ((error: ErrorType?) -> Void)) { @@ -85,7 +85,7 @@ public class PetAPI: APIBase { Fake endpoint to test byte array in body parameter for adding a new pet to the store - - parameter body: (body) Pet object in the form of byte array + - parameter body: (body) Pet object in the form of byte array (optional) - returns: Promise */ public class func addPetUsingByteArray(body body: String?) -> Promise { @@ -110,7 +110,7 @@ public class PetAPI: APIBase { - type: oauth2 - name: petstore_auth - - parameter body: (body) Pet object in the form of byte array + - parameter body: (body) Pet object in the form of byte array (optional) - returns: RequestBuilder */ @@ -129,7 +129,7 @@ public class PetAPI: APIBase { Deletes a pet - - parameter petId: (path) Pet id to delete + - parameter petId: (path) Pet id to delete - parameter completion: completion handler to receive the data and the error objects */ public class func deletePet(petId petId: Int, completion: ((error: ErrorType?) -> Void)) { @@ -142,7 +142,7 @@ public class PetAPI: APIBase { Deletes a pet - - parameter petId: (path) Pet id to delete + - parameter petId: (path) Pet id to delete - returns: Promise */ public class func deletePet(petId petId: Int) -> Promise { @@ -167,7 +167,7 @@ public class PetAPI: APIBase { - type: oauth2 - name: petstore_auth - - parameter petId: (path) Pet id to delete + - parameter petId: (path) Pet id to delete - returns: RequestBuilder */ @@ -188,7 +188,7 @@ public class PetAPI: APIBase { Finds Pets by status - - parameter status: (query) Status values that need to be considered for query + - parameter status: (query) Status values that need to be considered for query (optional, default to available) - parameter completion: completion handler to receive the data and the error objects */ public class func findPetsByStatus(status status: [String]?, completion: ((data: [Pet]?, error: ErrorType?) -> Void)) { @@ -201,7 +201,7 @@ public class PetAPI: APIBase { Finds Pets by status - - parameter status: (query) Status values that need to be considered for query + - parameter status: (query) Status values that need to be considered for query (optional, default to available) - returns: Promise<[Pet]> */ public class func findPetsByStatus(status status: [String]?) -> Promise<[Pet]> { @@ -272,7 +272,7 @@ public class PetAPI: APIBase { string , contentType=application/xml}] - - parameter status: (query) Status values that need to be considered for query + - parameter status: (query) Status values that need to be considered for query (optional, default to available) - returns: RequestBuilder<[Pet]> */ @@ -294,7 +294,7 @@ public class PetAPI: APIBase { Finds Pets by tags - - parameter tags: (query) Tags to filter by + - parameter tags: (query) Tags to filter by (optional) - parameter completion: completion handler to receive the data and the error objects */ public class func findPetsByTags(tags tags: [String]?, completion: ((data: [Pet]?, error: ErrorType?) -> Void)) { @@ -307,7 +307,7 @@ public class PetAPI: APIBase { Finds Pets by tags - - parameter tags: (query) Tags to filter by + - parameter tags: (query) Tags to filter by (optional) - returns: Promise<[Pet]> */ public class func findPetsByTags(tags tags: [String]?) -> Promise<[Pet]> { @@ -378,7 +378,7 @@ public class PetAPI: APIBase { string , contentType=application/xml}] - - parameter tags: (query) Tags to filter by + - parameter tags: (query) Tags to filter by (optional) - returns: RequestBuilder<[Pet]> */ @@ -400,7 +400,7 @@ public class PetAPI: APIBase { Find pet by ID - - parameter petId: (path) ID of pet that needs to be fetched + - parameter petId: (path) ID of pet that needs to be fetched - parameter completion: completion handler to receive the data and the error objects */ public class func getPetById(petId petId: Int, completion: ((data: Pet?, error: ErrorType?) -> Void)) { @@ -413,7 +413,7 @@ public class PetAPI: APIBase { Find pet by ID - - parameter petId: (path) ID of pet that needs to be fetched + - parameter petId: (path) ID of pet that needs to be fetched - returns: Promise */ public class func getPetById(petId petId: Int) -> Promise { @@ -487,7 +487,7 @@ public class PetAPI: APIBase { string , contentType=application/xml}] - - parameter petId: (path) ID of pet that needs to be fetched + - parameter petId: (path) ID of pet that needs to be fetched - returns: RequestBuilder */ @@ -508,7 +508,7 @@ public class PetAPI: APIBase { Fake endpoint to test inline arbitrary object return by 'Find pet by ID' - - parameter petId: (path) ID of pet that needs to be fetched + - parameter petId: (path) ID of pet that needs to be fetched - parameter completion: completion handler to receive the data and the error objects */ public class func getPetByIdInObject(petId petId: Int, completion: ((data: InlineResponse200?, error: ErrorType?) -> Void)) { @@ -521,7 +521,7 @@ public class PetAPI: APIBase { Fake endpoint to test inline arbitrary object return by 'Find pet by ID' - - parameter petId: (path) ID of pet that needs to be fetched + - parameter petId: (path) ID of pet that needs to be fetched - returns: Promise */ public class func getPetByIdInObject(petId petId: Int) -> Promise { @@ -583,7 +583,7 @@ public class PetAPI: APIBase { string , contentType=application/xml}] - - parameter petId: (path) ID of pet that needs to be fetched + - parameter petId: (path) ID of pet that needs to be fetched - returns: RequestBuilder */ @@ -604,7 +604,7 @@ public class PetAPI: APIBase { Fake endpoint to test byte array return by 'Find pet by ID' - - parameter petId: (path) ID of pet that needs to be fetched + - parameter petId: (path) ID of pet that needs to be fetched - parameter completion: completion handler to receive the data and the error objects */ public class func petPetIdtestingByteArraytrueGet(petId petId: Int, completion: ((data: String?, error: ErrorType?) -> Void)) { @@ -617,7 +617,7 @@ public class PetAPI: APIBase { Fake endpoint to test byte array return by 'Find pet by ID' - - parameter petId: (path) ID of pet that needs to be fetched + - parameter petId: (path) ID of pet that needs to be fetched - returns: Promise */ public class func petPetIdtestingByteArraytrueGet(petId petId: Int) -> Promise { @@ -647,7 +647,7 @@ public class PetAPI: APIBase { - examples: [{example="", contentType=application/json}, {example=not implemented io.swagger.models.properties.BinaryProperty@55e6ae9e, contentType=application/xml}] - examples: [{example="", contentType=application/json}, {example=not implemented io.swagger.models.properties.BinaryProperty@55e6ae9e, contentType=application/xml}] - - parameter petId: (path) ID of pet that needs to be fetched + - parameter petId: (path) ID of pet that needs to be fetched - returns: RequestBuilder */ @@ -668,7 +668,7 @@ public class PetAPI: APIBase { Update an existing pet - - parameter body: (body) Pet object that needs to be added to the store + - parameter body: (body) Pet object that needs to be added to the store (optional) - parameter completion: completion handler to receive the data and the error objects */ public class func updatePet(body body: Pet?, completion: ((error: ErrorType?) -> Void)) { @@ -681,7 +681,7 @@ public class PetAPI: APIBase { Update an existing pet - - parameter body: (body) Pet object that needs to be added to the store + - parameter body: (body) Pet object that needs to be added to the store (optional) - returns: Promise */ public class func updatePet(body body: Pet?) -> Promise { @@ -706,7 +706,7 @@ public class PetAPI: APIBase { - type: oauth2 - name: petstore_auth - - parameter body: (body) Pet object that needs to be added to the store + - parameter body: (body) Pet object that needs to be added to the store (optional) - returns: RequestBuilder */ @@ -725,9 +725,9 @@ public class PetAPI: APIBase { Updates a pet in the store with form data - - parameter petId: (path) ID of pet that needs to be updated - - parameter name: (form) Updated name of the pet - - parameter status: (form) Updated status of the pet + - parameter petId: (path) ID of pet that needs to be updated + - parameter name: (form) Updated name of the pet (optional) + - parameter status: (form) Updated status of the pet (optional) - parameter completion: completion handler to receive the data and the error objects */ public class func updatePetWithForm(petId petId: String, name: String?, status: String?, completion: ((error: ErrorType?) -> Void)) { @@ -740,9 +740,9 @@ public class PetAPI: APIBase { Updates a pet in the store with form data - - parameter petId: (path) ID of pet that needs to be updated - - parameter name: (form) Updated name of the pet - - parameter status: (form) Updated status of the pet + - parameter petId: (path) ID of pet that needs to be updated + - parameter name: (form) Updated name of the pet (optional) + - parameter status: (form) Updated status of the pet (optional) - returns: Promise */ public class func updatePetWithForm(petId petId: String, name: String?, status: String?) -> Promise { @@ -767,9 +767,9 @@ public class PetAPI: APIBase { - type: oauth2 - name: petstore_auth - - parameter petId: (path) ID of pet that needs to be updated - - parameter name: (form) Updated name of the pet - - parameter status: (form) Updated status of the pet + - parameter petId: (path) ID of pet that needs to be updated + - parameter name: (form) Updated name of the pet (optional) + - parameter status: (form) Updated status of the pet (optional) - returns: RequestBuilder */ @@ -793,9 +793,9 @@ public class PetAPI: APIBase { uploads an image - - parameter petId: (path) ID of pet to update - - parameter additionalMetadata: (form) Additional data to pass to server - - parameter _file: (form) file to upload + - parameter petId: (path) ID of pet to update + - parameter additionalMetadata: (form) Additional data to pass to server (optional) + - parameter _file: (form) file to upload (optional) - parameter completion: completion handler to receive the data and the error objects */ public class func uploadFile(petId petId: Int, additionalMetadata: String?, _file: NSURL?, completion: ((error: ErrorType?) -> Void)) { @@ -808,9 +808,9 @@ public class PetAPI: APIBase { uploads an image - - parameter petId: (path) ID of pet to update - - parameter additionalMetadata: (form) Additional data to pass to server - - parameter _file: (form) file to upload + - parameter petId: (path) ID of pet to update + - parameter additionalMetadata: (form) Additional data to pass to server (optional) + - parameter _file: (form) file to upload (optional) - returns: Promise */ public class func uploadFile(petId petId: Int, additionalMetadata: String?, _file: NSURL?) -> Promise { @@ -835,9 +835,9 @@ public class PetAPI: APIBase { - type: oauth2 - name: petstore_auth - - parameter petId: (path) ID of pet to update - - parameter additionalMetadata: (form) Additional data to pass to server - - parameter _file: (form) file to upload + - parameter petId: (path) ID of pet to update + - parameter additionalMetadata: (form) Additional data to pass to server (optional) + - parameter _file: (form) file to upload (optional) - returns: RequestBuilder */ diff --git a/samples/client/petstore/swift/PetstoreClient/Classes/Swaggers/APIs/StoreAPI.swift b/samples/client/petstore/swift/PetstoreClient/Classes/Swaggers/APIs/StoreAPI.swift index b3c08667c21..09390bc4728 100644 --- a/samples/client/petstore/swift/PetstoreClient/Classes/Swaggers/APIs/StoreAPI.swift +++ b/samples/client/petstore/swift/PetstoreClient/Classes/Swaggers/APIs/StoreAPI.swift @@ -15,7 +15,7 @@ public class StoreAPI: APIBase { Delete purchase order by ID - - parameter orderId: (path) ID of the order that needs to be deleted + - parameter orderId: (path) ID of the order that needs to be deleted - parameter completion: completion handler to receive the data and the error objects */ public class func deleteOrder(orderId orderId: String, completion: ((error: ErrorType?) -> Void)) { @@ -28,7 +28,7 @@ public class StoreAPI: APIBase { Delete purchase order by ID - - parameter orderId: (path) ID of the order that needs to be deleted + - parameter orderId: (path) ID of the order that needs to be deleted - returns: Promise */ public class func deleteOrder(orderId orderId: String) -> Promise { @@ -50,7 +50,7 @@ public class StoreAPI: APIBase { - DELETE /store/order/{orderId} - For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors - - parameter orderId: (path) ID of the order that needs to be deleted + - parameter orderId: (path) ID of the order that needs to be deleted - returns: RequestBuilder */ @@ -71,7 +71,7 @@ public class StoreAPI: APIBase { Finds orders by status - - parameter status: (query) Status value that needs to be considered for query + - parameter status: (query) Status value that needs to be considered for query (optional, default to placed) - parameter completion: completion handler to receive the data and the error objects */ public class func findOrdersByStatus(status status: String?, completion: ((data: [Order]?, error: ErrorType?) -> Void)) { @@ -84,7 +84,7 @@ public class StoreAPI: APIBase { Finds orders by status - - parameter status: (query) Status value that needs to be considered for query + - parameter status: (query) Status value that needs to be considered for query (optional, default to placed) - returns: Promise<[Order]> */ public class func findOrdersByStatus(status status: String?) -> Promise<[Order]> { @@ -142,7 +142,7 @@ public class StoreAPI: APIBase { true , contentType=application/xml}] - - parameter status: (query) Status value that needs to be considered for query + - parameter status: (query) Status value that needs to be considered for query (optional, default to placed) - returns: RequestBuilder<[Order]> */ @@ -280,7 +280,7 @@ public class StoreAPI: APIBase { Find purchase order by ID - - parameter orderId: (path) ID of pet that needs to be fetched + - parameter orderId: (path) ID of pet that needs to be fetched - parameter completion: completion handler to receive the data and the error objects */ public class func getOrderById(orderId orderId: String, completion: ((data: Order?, error: ErrorType?) -> Void)) { @@ -293,7 +293,7 @@ public class StoreAPI: APIBase { Find purchase order by ID - - parameter orderId: (path) ID of pet that needs to be fetched + - parameter orderId: (path) ID of pet that needs to be fetched - returns: Promise */ public class func getOrderById(orderId orderId: String) -> Promise { @@ -351,7 +351,7 @@ public class StoreAPI: APIBase { true , contentType=application/xml}] - - parameter orderId: (path) ID of pet that needs to be fetched + - parameter orderId: (path) ID of pet that needs to be fetched - returns: RequestBuilder */ @@ -372,7 +372,7 @@ public class StoreAPI: APIBase { Place an order for a pet - - parameter body: (body) order placed for purchasing the pet + - parameter body: (body) order placed for purchasing the pet (optional) - parameter completion: completion handler to receive the data and the error objects */ public class func placeOrder(body body: Order?, completion: ((data: Order?, error: ErrorType?) -> Void)) { @@ -385,7 +385,7 @@ public class StoreAPI: APIBase { Place an order for a pet - - parameter body: (body) order placed for purchasing the pet + - parameter body: (body) order placed for purchasing the pet (optional) - returns: Promise */ public class func placeOrder(body body: Order?) -> Promise { @@ -443,7 +443,7 @@ public class StoreAPI: APIBase { true , contentType=application/xml}] - - parameter body: (body) order placed for purchasing the pet + - parameter body: (body) order placed for purchasing the pet (optional) - returns: RequestBuilder */ diff --git a/samples/client/petstore/swift/PetstoreClient/Classes/Swaggers/APIs/UserAPI.swift b/samples/client/petstore/swift/PetstoreClient/Classes/Swaggers/APIs/UserAPI.swift index 5849fff1cb8..3f1d18dffb0 100644 --- a/samples/client/petstore/swift/PetstoreClient/Classes/Swaggers/APIs/UserAPI.swift +++ b/samples/client/petstore/swift/PetstoreClient/Classes/Swaggers/APIs/UserAPI.swift @@ -15,7 +15,7 @@ public class UserAPI: APIBase { Create user - - parameter body: (body) Created user object + - parameter body: (body) Created user object (optional) - parameter completion: completion handler to receive the data and the error objects */ public class func createUser(body body: User?, completion: ((error: ErrorType?) -> Void)) { @@ -28,7 +28,7 @@ public class UserAPI: APIBase { Create user - - parameter body: (body) Created user object + - parameter body: (body) Created user object (optional) - returns: Promise */ public class func createUser(body body: User?) -> Promise { @@ -50,7 +50,7 @@ public class UserAPI: APIBase { - POST /user - This can only be done by the logged in user. - - parameter body: (body) Created user object + - parameter body: (body) Created user object (optional) - returns: RequestBuilder */ @@ -69,7 +69,7 @@ public class UserAPI: APIBase { Creates list of users with given input array - - parameter body: (body) List of user object + - parameter body: (body) List of user object (optional) - parameter completion: completion handler to receive the data and the error objects */ public class func createUsersWithArrayInput(body body: [User]?, completion: ((error: ErrorType?) -> Void)) { @@ -82,7 +82,7 @@ public class UserAPI: APIBase { Creates list of users with given input array - - parameter body: (body) List of user object + - parameter body: (body) List of user object (optional) - returns: Promise */ public class func createUsersWithArrayInput(body body: [User]?) -> Promise { @@ -104,7 +104,7 @@ public class UserAPI: APIBase { - POST /user/createWithArray - - - parameter body: (body) List of user object + - parameter body: (body) List of user object (optional) - returns: RequestBuilder */ @@ -123,7 +123,7 @@ public class UserAPI: APIBase { Creates list of users with given input array - - parameter body: (body) List of user object + - parameter body: (body) List of user object (optional) - parameter completion: completion handler to receive the data and the error objects */ public class func createUsersWithListInput(body body: [User]?, completion: ((error: ErrorType?) -> Void)) { @@ -136,7 +136,7 @@ public class UserAPI: APIBase { Creates list of users with given input array - - parameter body: (body) List of user object + - parameter body: (body) List of user object (optional) - returns: Promise */ public class func createUsersWithListInput(body body: [User]?) -> Promise { @@ -158,7 +158,7 @@ public class UserAPI: APIBase { - POST /user/createWithList - - - parameter body: (body) List of user object + - parameter body: (body) List of user object (optional) - returns: RequestBuilder */ @@ -177,7 +177,7 @@ public class UserAPI: APIBase { Delete user - - parameter username: (path) The name that needs to be deleted + - parameter username: (path) The name that needs to be deleted - parameter completion: completion handler to receive the data and the error objects */ public class func deleteUser(username username: String, completion: ((error: ErrorType?) -> Void)) { @@ -190,7 +190,7 @@ public class UserAPI: APIBase { Delete user - - parameter username: (path) The name that needs to be deleted + - parameter username: (path) The name that needs to be deleted - returns: Promise */ public class func deleteUser(username username: String) -> Promise { @@ -215,7 +215,7 @@ public class UserAPI: APIBase { - type: basic - name: test_http_basic - - parameter username: (path) The name that needs to be deleted + - parameter username: (path) The name that needs to be deleted - returns: RequestBuilder */ @@ -236,7 +236,7 @@ public class UserAPI: APIBase { Get user by user name - - parameter username: (path) The name that needs to be fetched. Use user1 for testing. + - parameter username: (path) The name that needs to be fetched. Use user1 for testing. - parameter completion: completion handler to receive the data and the error objects */ public class func getUserByName(username username: String, completion: ((data: User?, error: ErrorType?) -> Void)) { @@ -249,7 +249,7 @@ public class UserAPI: APIBase { Get user by user name - - parameter username: (path) The name that needs to be fetched. Use user1 for testing. + - parameter username: (path) The name that needs to be fetched. Use user1 for testing. - returns: Promise */ public class func getUserByName(username username: String) -> Promise { @@ -281,7 +281,7 @@ public class UserAPI: APIBase { "userStatus" : 0 }, contentType=application/json}] - - parameter username: (path) The name that needs to be fetched. Use user1 for testing. + - parameter username: (path) The name that needs to be fetched. Use user1 for testing. - returns: RequestBuilder */ @@ -302,8 +302,8 @@ public class UserAPI: APIBase { Logs user into the system - - parameter username: (query) The user name for login - - parameter password: (query) The password for login in clear text + - parameter username: (query) The user name for login (optional) + - parameter password: (query) The password for login in clear text (optional) - parameter completion: completion handler to receive the data and the error objects */ public class func loginUser(username username: String?, password: String?, completion: ((data: String?, error: ErrorType?) -> Void)) { @@ -316,8 +316,8 @@ public class UserAPI: APIBase { Logs user into the system - - parameter username: (query) The user name for login - - parameter password: (query) The password for login in clear text + - parameter username: (query) The user name for login (optional) + - parameter password: (query) The password for login in clear text (optional) - returns: Promise */ public class func loginUser(username username: String?, password: String?) -> Promise { @@ -341,8 +341,8 @@ public class UserAPI: APIBase { - examples: [{example="aeiou", contentType=application/json}, {example=string, contentType=application/xml}] - examples: [{example="aeiou", contentType=application/json}, {example=string, contentType=application/xml}] - - parameter username: (query) The user name for login - - parameter password: (query) The password for login in clear text + - parameter username: (query) The user name for login (optional) + - parameter password: (query) The password for login in clear text (optional) - returns: RequestBuilder */ @@ -416,8 +416,8 @@ public class UserAPI: APIBase { Updated user - - parameter username: (path) name that need to be deleted - - parameter body: (body) Updated user object + - parameter username: (path) name that need to be deleted + - parameter body: (body) Updated user object (optional) - parameter completion: completion handler to receive the data and the error objects */ public class func updateUser(username username: String, body: User?, completion: ((error: ErrorType?) -> Void)) { @@ -430,8 +430,8 @@ public class UserAPI: APIBase { Updated user - - parameter username: (path) name that need to be deleted - - parameter body: (body) Updated user object + - parameter username: (path) name that need to be deleted + - parameter body: (body) Updated user object (optional) - returns: Promise */ public class func updateUser(username username: String, body: User?) -> Promise { @@ -453,8 +453,8 @@ public class UserAPI: APIBase { - PUT /user/{username} - This can only be done by the logged in user. - - parameter username: (path) name that need to be deleted - - parameter body: (body) Updated user object + - parameter username: (path) name that need to be deleted + - parameter body: (body) Updated user object (optional) - returns: RequestBuilder */