Skip to content

Commit

Permalink
docs: Fix the jsdoc in openshift-rest-client.js (#188)
Browse files Browse the repository at this point in the history
fixes #187
  • Loading branch information
lholmquist authored Jan 14, 2020
1 parent 898f2ae commit cf4b93a
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions lib/openshift-rest-client.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,13 @@ const spec = JSON.parse(zlib.gunzipSync(fs.readFileSync(path.join(__dirname, 'sp
* Builds the rest client based on provided or default kubernetes configuration.
*
* @param {object} [settings] - settings object for the openshiftClient function
* @param {string} [settings.url] - Openshift cluster url
* @param {string} [settings.authUrl] - Openshift Basic auth url
* @param {object} [settings.auth] -
* @param {string} [settings.auth.username] - username to authenticate to Openshift
* @param {string} [settings.auth.password] - password to authenticate to Openshift
* @param {boolean} [settings.insecureSkipTlsVerify] - flag to ignore TLS verification
* @param {object} [settings.config] - custom config object
* @param {string} [settings.config.url] - Openshift cluster url
* @param {string} [settings.config.authUrl] - Openshift Basic auth url
* @param {object} [settings.config.auth] -
* @param {string} [settings.config.auth.username] - username to authenticate to Openshift
* @param {string} [settings.config.auth.password] - password to authenticate to Openshift
* @param {boolean} [settings.config.insecureSkipTlsVerify] - flag to ignore TLS verification
* @returns {Promise} Returns the Rest Client
*/
async function openshiftClient (settings = {}) {
Expand Down

0 comments on commit cf4b93a

Please sign in to comment.