address PR feedback

Signed-off-by: Connor Younglund <younglund_connor@bah.com>
This commit is contained in:
Connor Younglund
2022-12-02 15:56:15 -05:00
parent 6756292c24
commit 1c5ee67616
3 changed files with 13 additions and 5 deletions
+4 -2
View File
@@ -15,9 +15,11 @@ stackoverflow:
baseUrl: https://api.stackexchange.com/2.2 # alternative: your internal stack overflow instance
```
### Stack Overflow for Teams (private stack overflow instance)
### Stack Overflow for Teams
If you have a private stack overflow instance you will need to supply an API key as well. You can read more about how to set this up by going to [Stack Overflows Help Page](https://stackoverflow.help/en/articles/4385859-stack-overflow-for-teams-api)
If you have an private Stack Overflow instance and/or a private Stack Overflow Team you will need to supply an API key. You can read more about how to set this up by going to [Stack Overflow's Help Page](https://stackoverflow.help/en/articles/4385859-stack-overflow-for-teams-api).
A private Stack Overflow Team requires both an API key and an API Access Token. Step 3 ("Generate an Access Token via OAuth") from the previously mentioned Help Page explains the process for generating an API Access Token with no expiration.
```yaml
stackoverflow:
+7 -1
View File
@@ -25,9 +25,15 @@ export interface Config {
baseUrl?: string;
/**
* The api key to authenticate to Stack Overflow API
* The API key to authenticate to Stack Overflow API
* @visibility secret
*/
apiKey?: string;
/**
* The API Access Token to authenticate to Stack Overflow API
* @visibility secret
*/
apiAccessToken?: string;
};
}