Skip to content

Commit ccd5f57

Browse files
committed
docs: fix responseType JSDoc and clarify auth samples
Correct the copy-pasted responseType documentation and note that auth samples are illustrative, pointing to the DummyAuthenticationProvider test helper.
1 parent 5438ae9 commit ccd5f57

3 files changed

Lines changed: 5 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Here are some ways you can contribute to this documentation:
1414
- To make small changes to an article, [Contribute using GitHub](#contribute-using-github).
1515
- To make large changes, or changes that involve code, [Contribute using Git](#contribute-using-git).
1616
- Report documentation bugs via GitHub Issues
17-
- Request new documentation at the [Office Developer Platform UserVoice](http://officespdev.uservoice.com) site.
17+
- Request new documentation or report documentation issues via [GitHub Issues](https://github.com/microsoftgraph/msgraph-sdk-javascript/issues) in this repository.
1818

1919
## Contribute using GitHub
2020

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,9 @@ The Microsoft Graph client is designed to make it simple to make calls to Micros
120120

121121
For information on how to create a client instance, see [Creating Client Instance](./docs/CreatingClientInstance.md)
122122

123+
> **Note:** Authentication provider samples in the README and docs are illustrative. They show how to wire an `AuthenticationProvider` into the client; they are not production-ready credential handling. For unit tests and mocking, see [`test/DummyAuthenticationProvider.ts`](./test/DummyAuthenticationProvider.ts) and the helpers under [`test/`](./test/).
124+
125+
123126
### 3. Make requests to the graph
124127

125128
Once you have authentication setup and an instance of Client, you can begin to make calls to the service. All requests should start with `client.api(path)` and end with an [action](./docs/Actions.md).

src/GraphRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@ export class GraphRequest {
502502

503503
/**
504504
* @public
505-
* Sets the api endpoint version for a request
505+
* Sets the response type for a request
506506
* @param {ResponseType} responseType - The response type value
507507
* @returns The same GraphRequest instance that is being called with
508508
*/

0 commit comments

Comments
 (0)