Merge pull request #294 from auth0/feature-doc-search_engine

Add search_engine to JSDOC
auth0 · Sep 28, 2018 · 0cdb074 · 0cdb074
2 parents 58d45f2 + 07ea7ae
commit 0cdb074
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/src/management/index.js b/src/management/index.js
@@ -860,6 +860,7 @@ utils.wrapPropertyMethod(ManagementClient, 'updateRule', 'rules.update');
  *
  * // Pagination settings.
  * var params = {
+ *   search_engine: 'v3',
  *   per_page: 10,
  *   page: 0
  * };
@@ -868,10 +869,11 @@ utils.wrapPropertyMethod(ManagementClient, 'updateRule', 'rules.update');
  *   console.log(users.length);
  * });
  *
- * @param   {Object}    [params]          Users params.
- * @param   {Number}    [params.per_page] Number of results per page.
- * @param   {Number}    [params.page]     Page number, zero indexed.
- * @param   {Function}  [cb]              Callback function.
+ * @param   {Object}    [params]               Users params.
+ * @param   {Number}    [params.search_engine] The version of the search engine to use.
+ * @param   {Number}    [params.per_page]      Number of results per page.
+ * @param   {Number}    [params.page]          Page number, zero indexed.
+ * @param   {Function}  [cb]                   Callback function.
  *
  * @return  {Promise|undefined}
  */
@@ -1925,5 +1927,4 @@ utils.wrapPropertyMethod(ManagementClient, 'getRulesConfigs', 'rulesConfigs.getA
  */
 utils.wrapPropertyMethod(ManagementClient, 'deleteRulesConfig', 'rulesConfigs.delete');
 
-
 module.exports = ManagementClient;