Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Some jsdocs fixes #100

Merged
merged 1 commit into from
May 1, 2019
Merged

Some jsdocs fixes #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ jsdoc/

.envrc
.DS_Store
.idea
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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].



Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/JSDOC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
});
```
Expand Down