From d9717ebf3dc2cc720ea32c0cdf96dabc94e2b58b Mon Sep 17 00:00:00 2001 From: Arvind Joshi Date: Tue, 30 Apr 2019 15:43:28 -0700 Subject: [PATCH] Some jsdocs fixes --- .gitignore | 1 + README.md | 6 +++--- docs/JSDOC.md | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index d01c4517d..703ea19f2 100644 --- a/.gitignore +++ b/.gitignore @@ -11,3 +11,4 @@ jsdoc/ .envrc .DS_Store +.idea diff --git a/README.md b/README.md index 44664f19a..39782ed4c 100644 --- a/README.md +++ b/README.md @@ -33,9 +33,8 @@ const client = new okta.Client({ It is also possible to provide configuration through environment variables or YAML files. Please see [Configuration](#configuration) for examples. -All interaction with the [Okta Platform API] is done through client methods. Some examples are below, but for a full list of methods please refer to the JsDoc page for the client: - -https://developer.okta.com/okta-sdk-nodejs/jsdocs/Client.html +All interactions with the [Okta Platform API] is done through client methods. Some examples are below, but for a full + list of methods please refer to the JsDoc page for the [Client]. @@ -727,6 +726,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) if you would like to propose changes to t [Applications: Add Application]: https://developer.okta.com/docs/api/resources/apps.html#add-application [Applications: User Operations]:https://developer.okta.com/docs/api/resources/apps.html#application-user-operations [Basic Authentication Application]: https://developer.okta.com/docs/api/resources/apps.html#add-basic-authentication-application +[Client]: https://developer.okta.com/okta-sdk-nodejs/jsdocs/Client.html [DefaultRequestExecutor]: src/default-request-executor.js [Groups: Add Group]: https://developer.okta.com/docs/api/resources/groups.html#add-group [isomorphic-fetch]: https://github.com/matthew-andrews/isomorphic-fetch diff --git a/docs/JSDOC.md b/docs/JSDOC.md index 44241fee3..229730ee3 100644 --- a/docs/JSDOC.md +++ b/docs/JSDOC.md @@ -20,7 +20,7 @@ All usage of this SDK begins with the creation of a client, the client handles t const okta = require('@okta/okta-sdk-nodejs'); const client = new okta.Client({ - orgUrl: 'https://dev-1234.oktapreview.com/' + orgUrl: 'https://dev-1234.oktapreview.com/', token: 'xYzabc' // Obtained from Developer Dashboard }); ```