Skip to content

Commit

Permalink
The docs script was failing because some were malformed (#693)
Browse files Browse the repository at this point in the history
  • Loading branch information
adamjmcgrath authored Jan 26, 2022
1 parent 532a4bf commit 7f766d9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 13 deletions.
5 changes: 2 additions & 3 deletions src/management/HooksManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -181,13 +181,12 @@ class HooksManager {
/**
* Get Hook secrets
*
* @example
* @param callback
* var params = {id : 'HOOK_ID'}
* @example <caption>
* This method takes a first argument as the hookId and returns the secrets for the hook. The secret values will be hidden.
* </caption>
*
* var params = {id : 'HOOK_ID'}
*
* management.hooks.getSecrets( {id : 'HOOK_ID'}, function (err, secrets) {
* console.log(secrets);
* });
Expand Down
15 changes: 5 additions & 10 deletions src/management/OrganizationsManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -225,12 +225,10 @@ class OrganizationsManager {
/**
* Get Enabled Connections in a Organization
*
* @example
* @param callback
* var params = {id : 'ORGANIZATION_ID'}
* @example <caption>
* This method takes an organization ID and returns the enabled connections in an Organization
* </caption>
* var params = {id : 'ORGANIZATION_ID'}
*
* management.organizations.getEnabledConnections( {id : 'ORGANIZATION_ID'}, function (err, enabled_connections) {
* console.log(enabled_connections);
Expand All @@ -247,20 +245,18 @@ class OrganizationsManager {
/**
* Get Enabled Connection in a Organization
*
* @example
* var params = {id : 'ORGANIZATION_ID', connection_id: 'CONNECTION_ID'}
* @param callback
* @example <caption>
* This methods takes the organization ID and connection ID and returns the enabled connection
* </caption>
* var params = {id : 'ORGANIZATION_ID', connection_id: 'CONNECTION_ID'}
*
* management.organizations.getEnabledConnections( {id : 'ORGANIZATION_ID', connection_id: 'CONNECTION_ID'}, function (err, enabled_connection) {
* console.log(enabled_connection);
* });
* @param {object} params Organization parameters.
* @param {string} params.id Organization ID.
* @param {string} params.connection_id Connection ID.
* @param {Function} [cb] Callback function.
* @param {Function} [callback] Callback function.
* @returns {Promise|undefined}
*/
getEnabledConnection(params, callback) {
Expand Down Expand Up @@ -400,13 +396,12 @@ class OrganizationsManager {
/**
* Get Members in a Organization
*
* @example
* var params = {id : 'ORGANIZATION_ID'}
* @example <caption>
* @param callback
* This method takes an organization ID and returns the members in an Organization
* </caption>
*
* var params = {id : 'ORGANIZATION_ID'}
*
* management.organizations.getMembers( {id : 'ORGANIZATION_ID'}, function (err, members) {
* console.log(members);
* });
Expand Down

0 comments on commit 7f766d9

Please sign in to comment.