update optional parameters in jsdoc (#15032)

samples/client/petstore/javascript-es6/src/api/FakeApi.js

@@ -89,8 +89,8 @@ export default class FakeApi {
      * test http signature authentication
      * @param {module:model/Pet} pet Pet object that needs to be added to the store
      * @param {Object} opts Optional parameters
-     * @param {String} opts.query1 query parameter
-     * @param {String} opts.header1 header parameter
+     * @param {String} [query1] query parameter
+     * @param {String} [header1] header parameter
      * @param {module:api/FakeApi~fakeHttpSignatureTestCallback} callback The callback function, accepting three arguments: error, data, response
      */
     fakeHttpSignatureTest(pet, opts, callback) {
@@ -134,7 +134,7 @@ export default class FakeApi {
     /**
      * Test serialization of outer boolean types
      * @param {Object} opts Optional parameters
-     * @param {Boolean} opts.body Input boolean as post body
+     * @param {Boolean} [body] Input boolean as post body
      * @param {module:api/FakeApi~fakeOuterBooleanSerializeCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link Boolean}
      */
@@ -173,7 +173,7 @@ export default class FakeApi {
     /**
      * Test serialization of object with outer number type
      * @param {Object} opts Optional parameters
-     * @param {module:model/OuterComposite} opts.outerComposite Input composite as post body
+     * @param {module:model/OuterComposite} [outerComposite] Input composite as post body
      * @param {module:api/FakeApi~fakeOuterCompositeSerializeCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/OuterComposite}
      */
@@ -212,7 +212,7 @@ export default class FakeApi {
     /**
      * Test serialization of outer number types
      * @param {Object} opts Optional parameters
-     * @param {Number} opts.body Input number as post body
+     * @param {Number} [body] Input number as post body
      * @param {module:api/FakeApi~fakeOuterNumberSerializeCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link Number}
      */
@@ -251,7 +251,7 @@ export default class FakeApi {
     /**
      * Test serialization of outer string types
      * @param {Object} opts Optional parameters
-     * @param {String} opts.body Input string as post body
+     * @param {String} [body] Input string as post body
      * @param {module:api/FakeApi~fakeOuterStringSerializeCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link String}
      */
@@ -503,16 +503,16 @@ export default class FakeApi {
      * @param {String} patternWithoutDelimiter None
      * @param {Blob} _byte None
      * @param {Object} opts Optional parameters
-     * @param {Number} opts.integer None
-     * @param {Number} opts.int32 None
-     * @param {Number} opts.int64 None
-     * @param {Number} opts._float None
-     * @param {String} opts.string None
-     * @param {File} opts.binary None
-     * @param {Date} opts.date None
-     * @param {Date} opts.dateTime None
-     * @param {String} opts.password None
-     * @param {String} opts.callback None
+     * @param {Number} [integer] None
+     * @param {Number} [int32] None
+     * @param {Number} [int64] None
+     * @param {Number} [_float] None
+     * @param {String} [string] None
+     * @param {File} [binary] None
+     * @param {Date} [date] None
+     * @param {Date} [dateTime] None
+     * @param {String} [password] None
+     * @param {String} [callback] None
      * @param {module:api/FakeApi~testEndpointParametersCallback} callback The callback function, accepting three arguments: error, data, response
      */
     testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, opts, callback) {
@@ -581,15 +581,15 @@ export default class FakeApi {
      * To test enum parameters
      * To test enum parameters
      * @param {Object} opts Optional parameters
-     * @param {Array.<module:model/String>} opts.enumHeaderStringArray Header parameter enum test (string array)
-     * @param {module:model/String} opts.enumHeaderString Header parameter enum test (string) (default to '-efg')
-     * @param {Array.<module:model/String>} opts.enumQueryStringArray Query parameter enum test (string array)
-     * @param {module:model/String} opts.enumQueryString Query parameter enum test (string) (default to '-efg')
-     * @param {module:model/Number} opts.enumQueryInteger Query parameter enum test (double)
-     * @param {module:model/Number} opts.enumQueryDouble Query parameter enum test (double)
-     * @param {Array.<module:model/EnumClass>} opts.enumQueryModelArray 
-     * @param {Array.<module:model/String>} opts.enumFormStringArray Form parameter enum test (string array) (default to '$')
-     * @param {module:model/String} opts.enumFormString Form parameter enum test (string) (default to '-efg')
+     * @param {Array.<module:model/String>} [enumHeaderStringArray] Header parameter enum test (string array)
+     * @param {module:model/String} [enumHeaderString = '-efg')] Header parameter enum test (string)
+     * @param {Array.<module:model/String>} [enumQueryStringArray] Query parameter enum test (string array)
+     * @param {module:model/String} [enumQueryString = '-efg')] Query parameter enum test (string)
+     * @param {module:model/Number} [enumQueryInteger] Query parameter enum test (double)
+     * @param {module:model/Number} [enumQueryDouble] Query parameter enum test (double)
+     * @param {Array.<module:model/EnumClass>} [enumQueryModelArray] 
+     * @param {Array.<module:model/String>} [enumFormStringArray = '$')] Form parameter enum test (string array)
+     * @param {module:model/String} [enumFormString = '-efg')] Form parameter enum test (string)
      * @param {module:api/FakeApi~testEnumParametersCallback} callback The callback function, accepting three arguments: error, data, response
      */
     testEnumParameters(opts, callback) {
@@ -640,9 +640,9 @@ export default class FakeApi {
      * @param {Boolean} requiredBooleanGroup Required Boolean in group parameters
      * @param {Number} requiredInt64Group Required Integer in group parameters
      * @param {Object} opts Optional parameters
-     * @param {Number} opts.stringGroup String in group parameters
-     * @param {Boolean} opts.booleanGroup Boolean in group parameters
-     * @param {Number} opts.int64Group Integer in group parameters
+     * @param {Number} [stringGroup] String in group parameters
+     * @param {Boolean} [booleanGroup] Boolean in group parameters
+     * @param {Number} [int64Group] Integer in group parameters
      * @param {module:api/FakeApi~testGroupParametersCallback} callback The callback function, accepting three arguments: error, data, response
      */
     testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, opts, callback) {
@@ -793,7 +793,7 @@ export default class FakeApi {
      * @param {Array.<String>} context 
      * @param {String} allowEmpty 
      * @param {Object} opts Optional parameters
-     * @param {Object.<String, {String: String}>} opts.language 
+     * @param {Object.<String, {String: String}>} [language] 
      * @param {module:api/FakeApi~testQueryParameterCollectionFormatCallback} callback The callback function, accepting three arguments: error, data, response
      */
     testQueryParameterCollectionFormat(pipe, ioutil, http, url, context, allowEmpty, opts, callback) {

samples/client/petstore/javascript-es6/src/api/PetApi.js

@@ -99,7 +99,7 @@ export default class PetApi {
      * 
      * @param {Number} petId Pet id to delete
      * @param {Object} opts Optional parameters
-     * @param {String} opts.apiKey 
+     * @param {String} [apiKey] 
      * @param {module:api/PetApi~deletePetCallback} callback The callback function, accepting three arguments: error, data, response
      */
     deletePet(petId, opts, callback) {
@@ -325,8 +325,8 @@ export default class PetApi {
      * 
      * @param {Number} petId ID of pet that needs to be updated
      * @param {Object} opts Optional parameters
-     * @param {String} opts.name Updated name of the pet
-     * @param {String} opts.status Updated status of the pet
+     * @param {String} [name] Updated name of the pet
+     * @param {String} [status] Updated status of the pet
      * @param {module:api/PetApi~updatePetWithFormCallback} callback The callback function, accepting three arguments: error, data, response
      */
     updatePetWithForm(petId, opts, callback) {
@@ -373,8 +373,8 @@ export default class PetApi {
      * 
      * @param {Number} petId ID of pet to update
      * @param {Object} opts Optional parameters
-     * @param {String} opts.additionalMetadata Additional data to pass to server
-     * @param {File} opts.file file to upload
+     * @param {String} [additionalMetadata] Additional data to pass to server
+     * @param {File} [file] file to upload
      * @param {module:api/PetApi~uploadFileCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/ApiResponse}
      */
@@ -423,7 +423,7 @@ export default class PetApi {
      * @param {Number} petId ID of pet to update
      * @param {File} requiredFile file to upload
      * @param {Object} opts Optional parameters
-     * @param {String} opts.additionalMetadata Additional data to pass to server
+     * @param {String} [additionalMetadata] Additional data to pass to server
      * @param {module:api/PetApi~uploadFileWithRequiredFileCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/ApiResponse}
      */