From 3cd651234b0af7e4444fc387f465a38516f76869 Mon Sep 17 00:00:00 2001 From: Chris Hawkins Date: Wed, 29 Mar 2023 17:08:29 +0100 Subject: [PATCH] Updating README Signed-off-by: Chris Hawkins --- plugins/stack-overflow-backend/README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/plugins/stack-overflow-backend/README.md b/plugins/stack-overflow-backend/README.md index 4bcc755404..e6d9d50a74 100644 --- a/plugins/stack-overflow-backend/README.md +++ b/plugins/stack-overflow-backend/README.md @@ -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: