update optional parameters in jsdoc (#15032)

This commit is contained in:
William Cheng
2023-03-24 18:25:20 +08:00
committed by GitHub
parent d1f92acaea
commit bde5c10092
8 changed files with 107 additions and 107 deletions

View File

@@ -74,8 +74,8 @@ export default class FakeApi extends ApiClient {
* 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 requestInit Dynamic configuration. @see {@link https://github.com/apollographql/apollo-server/pull/1277}
* @return {Promise}
*/
@@ -114,7 +114,7 @@ export default class FakeApi extends ApiClient {
/**
* 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 requestInit Dynamic configuration. @see {@link https://github.com/apollographql/apollo-server/pull/1277}
* @return {Promise<Boolean>}
*/
@@ -147,7 +147,7 @@ export default class FakeApi extends ApiClient {
/**
* 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 requestInit Dynamic configuration. @see {@link https://github.com/apollographql/apollo-server/pull/1277}
* @return {Promise<module:model/OuterComposite>}
*/
@@ -180,7 +180,7 @@ export default class FakeApi extends ApiClient {
/**
* 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 requestInit Dynamic configuration. @see {@link https://github.com/apollographql/apollo-server/pull/1277}
* @return {Promise<Number>}
*/
@@ -213,7 +213,7 @@ export default class FakeApi extends ApiClient {
/**
* 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 requestInit Dynamic configuration. @see {@link https://github.com/apollographql/apollo-server/pull/1277}
* @return {Promise<String>}
*/
@@ -432,16 +432,16 @@ export default class FakeApi extends ApiClient {
* @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 requestInit Dynamic configuration. @see {@link https://github.com/apollographql/apollo-server/pull/1277}
* @return {Promise}
*/
@@ -505,15 +505,15 @@ export default class FakeApi extends ApiClient {
* 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 requestInit Dynamic configuration. @see {@link https://github.com/apollographql/apollo-server/pull/1277}
* @return {Promise}
*/
@@ -559,9 +559,9 @@ export default class FakeApi extends ApiClient {
* @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 requestInit Dynamic configuration. @see {@link https://github.com/apollographql/apollo-server/pull/1277}
* @return {Promise}
*/
@@ -697,7 +697,7 @@ export default class FakeApi extends ApiClient {
* @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 requestInit Dynamic configuration. @see {@link https://github.com/apollographql/apollo-server/pull/1277}
* @return {Promise}
*/

View File

@@ -85,7 +85,7 @@ export default class PetApi extends ApiClient {
*
* @param {Number} petId Pet id to delete
* @param {Object} opts Optional parameters
* @param {String} opts.apiKey
* @param {String} [apiKey]
* @param requestInit Dynamic configuration. @see {@link https://github.com/apollographql/apollo-server/pull/1277}
* @return {Promise}
*/
@@ -283,8 +283,8 @@ export default class PetApi extends ApiClient {
*
* @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 requestInit Dynamic configuration. @see {@link https://github.com/apollographql/apollo-server/pull/1277}
* @return {Promise}
*/
@@ -326,8 +326,8 @@ export default class PetApi extends ApiClient {
*
* @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 requestInit Dynamic configuration. @see {@link https://github.com/apollographql/apollo-server/pull/1277}
* @return {Promise<module:model/ApiResponse>}
*/
@@ -370,7 +370,7 @@ export default class PetApi extends ApiClient {
* @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 requestInit Dynamic configuration. @see {@link https://github.com/apollographql/apollo-server/pull/1277}
* @return {Promise<module:model/ApiResponse>}
*/