Updating README

Signed-off-by: Chris Hawkins <cmdkeen@users.noreply.github.com>
This commit is contained in:
Chris Hawkins
2023-03-29 17:08:29 +01:00
committed by Chris
parent a0ac7496ad
commit 3cd651234b
+9 -2
View File
@@ -17,9 +17,9 @@ stackoverflow:
### Stack Overflow for Teams
If you have a 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).
If you have a private Stack Overflow instance and/or a private Stack Overflow Team you will need to supply an API key or Personal Access Token. 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.
The existing API key approach remains the default, to support the new v2.3 API and PAT authentication model you need to pass the team name and the new PAT into the existing apiAccessToken parameter. See [15770](https://github.com/backstage/backstage/issues/15770) for more details.
```yaml
stackoverflow:
@@ -28,6 +28,13 @@ stackoverflow:
apiAccessToken: $STACK_OVERFLOW_API_ACCESS_TOKEN
```
```yaml
stackoverflow:
baseUrl: https://api.stackexchange.com/2.3 # alternative: your internal stack overflow instance
teamName: $STACK_OVERFLOW_TEAM_NAME
apiAccessToken: $STACK_OVERFLOW_API_ACCESS_TOKEN
```
## Areas of Responsibility
This stack overflow backend plugin is primarily responsible for the following: