Mark users and users_json are optional

Also describe that one of them is mandatory.
auth0 · Mar 6, 2020 · 6aaf3b9 · 6aaf3b9
1 parent e4954aa
commit 6aaf3b9
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/src/management/JobsManager.js b/src/management/JobsManager.js
@@ -146,8 +146,8 @@ JobsManager.prototype.get = function(params, cb) {
  *
  * @param   {Object}    data                        Users import data.
  * @param   {String}    data.connection_id          connection_id of the connection to which users will be imported.
- * @param   {String}    data.users                  Path to the users data file.
- * @param   {String}    data.users_json             JSON data for the users.
+ * @param   {String}    [data.users]                Path to the users data file. Either users or users_json is mandatory.
+ * @param   {String}    [data.users_json]           JSON data for the users.
  * @param   {String}    data.upsert                 OPTIONAL: set to true to upsert users, defaults to false
  * @param   {String}    data.send_completion_email  OPTIONAL: defaults to true
  * @param   {Function}  [cb]                        Callback function.

diff --git a/src/management/index.js b/src/management/index.js
@@ -2035,8 +2035,8 @@ utils.wrapPropertyMethod(ManagementClient, 'getJob', 'jobs.get');
  *
  * @param   {Object}    data                        Users import data.
  * @param   {String}    data.connection_id          connection_id of the connection to which users will be imported.
- * @param   {String}    data.users                  Path to the users data file.
- * @param   {String}    data.users_json             JSON data for the users.
+ * @param   {String}    [data.users]                Path to the users data file. Either users or users_json is mandatory.
+ * @param   {String}    [data.users_json]           JSON data for the users.
  * @param   {String}    data.upsert                 OPTIONAL: set to true to upsert users, defaults to false
  * @param   {String}    data.send_completion_email  OPTIONAL: defaults to true
  * @param   {Function}  [cb]                        Callback function.