From 738f77456e215e59d4ed02f94d5309fad32acbcf Mon Sep 17 00:00:00 2001 From: Hasit Mistry <hasit@coderabbit.ai> Date: Mon, 17 Feb 2025 17:58:36 -0800 Subject: [PATCH] Update OAuth2 configuration documentation for clarity and response format --- docs/self-hosted/azure-devops.md | 9 ++++++++- docs/self-hosted/bitbucket.md | 9 ++++++++- docs/self-hosted/github.md | 9 ++++++++- docs/self-hosted/gitlab.md | 9 ++++++++- 4 files changed, 32 insertions(+), 4 deletions(-) diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md index 858dd3b5..48d8df42 100644 --- a/docs/self-hosted/azure-devops.md +++ b/docs/self-hosted/azure-devops.md @@ -70,7 +70,14 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name> AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>] # OAuth2 Configuration (optional) -# This will use client credentials grant flow to get an access token, and use that token in headers while making requests to AZURE_OPENAI_ENDPOINT. +# This will use client_credentials flow to get an access token, +# and use it to make requests to the LLM provider. +# It is expected that the response from the OAuth2 server will be in the format +# { +# "access_token": "<access-token>", +# "token_type": "Bearer", +# "expires_in": 3599, +# } OAUTH2_ENDPOINT=[<endpoint>] OAUTH2_CLIENT_ID=[<client-id>] OAUTH2_CLIENT_SECRET=[<client-secret>] diff --git a/docs/self-hosted/bitbucket.md b/docs/self-hosted/bitbucket.md index 746727a8..f81709c3 100644 --- a/docs/self-hosted/bitbucket.md +++ b/docs/self-hosted/bitbucket.md @@ -62,7 +62,14 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name> AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>] # OAuth2 Configuration (optional) -# This will use client credentials grant flow to get an access token, and use that token in headers while making requests to AZURE_OPENAI_ENDPOINT. +# This will use client_credentials flow to get an access token, +# and use it to make requests to the LLM provider. +# It is expected that the response from the OAuth2 server will be in the format +# { +# "access_token": "<access-token>", +# "token_type": "Bearer", +# "expires_in": 3599, +# } OAUTH2_ENDPOINT=[<endpoint>] OAUTH2_CLIENT_ID=[<client-id>] OAUTH2_CLIENT_SECRET=[<client-secret>] diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md index 821f951f..18cef2b1 100644 --- a/docs/self-hosted/github.md +++ b/docs/self-hosted/github.md @@ -73,7 +73,14 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name> AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>] # OAuth2 Configuration (optional) -# This will use client credentials grant flow to get an access token, and use that token in headers while making requests to AZURE_OPENAI_ENDPOINT. +# This will use client_credentials flow to get an access token, +# and use it to make requests to the LLM provider. +# It is expected that the response from the OAuth2 server will be in the format +# { +# "access_token": "<access-token>", +# "token_type": "Bearer", +# "expires_in": 3599, +# } OAUTH2_ENDPOINT=[<endpoint>] OAUTH2_CLIENT_ID=[<client-id>] OAUTH2_CLIENT_SECRET=[<client-secret>] diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md index eabe410e..654cef40 100644 --- a/docs/self-hosted/gitlab.md +++ b/docs/self-hosted/gitlab.md @@ -68,7 +68,14 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name> AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>] # OAuth2 Configuration (optional) -# This will use client credentials grant flow to get an access token, and use that token in headers while making requests to AZURE_OPENAI_ENDPOINT. +# This will use client_credentials flow to get an access token, +# and use it to make requests to the LLM provider. +# It is expected that the response from the OAuth2 server will be in the format +# { +# "access_token": "<access-token>", +# "token_type": "Bearer", +# "expires_in": 3599, +# } OAUTH2_ENDPOINT=[<endpoint>] OAUTH2_CLIENT_ID=[<client-id>] OAUTH2_CLIENT_SECRET=[<client-secret>]