8000 Update OAuth2 configuration documentation for clarity and response fo… · coderabbitai/coderabbit-docs@738f774 · GitHub
[go: up one dir, main page]

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 738f774

Browse files
committed
Update OAuth2 configuration documentation for clarity and response format
1 parent 8e18121 commit 738f774

File tree

4 files changed

+32
-4
lines changed

4 files changed

+32
-4
lines changed

docs/self-hosted/azure-devops.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,14 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>
7070
AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]
7171

7272
# OAuth2 Configuration (optional)
73-
# 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.
73+
# This will use client_credentials flow to get an access token,
74+
# and use it to make requests to the LLM provider.
75+
# It is expected that the response from the OAuth2 server will be in the format
76+
# {
77+
# "access_token": "<access-token>",
78+
# "token_type": "Bearer",
79+
# "expires_in": 3599,
80+
# }
7481
OAUTH2_ENDPOINT=[<endpoint>]
7582
OAUTH2_CLIENT_ID=[<client-id>]
7683
OAUTH2_CLIENT_SECRET=[<client-secret>]

docs/self-hosted/bitbucket.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,14 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>
6262
AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]
6363

6464
# OAuth2 Configuration (optional)
65-
# 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.
65+
# This will use client_credentials flow to get an access token,
66+
# and use it to make requests to the LLM provider.
67+
# It is expected that the response from the OAuth2 server will be in the format
68+
# {
69+
# "access_token": "<access-token>",
70+
# "token_type": "Bearer",
71+
# "expires_in": 3599,
72+
# }
6673
OAUTH2_ENDPOINT=[<endpoint>]
6774
OAUTH2_CLIENT_ID=[<client-id>]
6875
OAUTH2_CLIENT_SECRET=[<client-secret>]

docs/self-hosted/github.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,14 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>
7373
AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]
7474

7575
# OAuth2 Configuration (optional)
76-
# 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.
76+
# This will use client_credentials flow to get an access token,
77+
# and use it to make requests to the LLM provider.
78+
# It is expected that the response from the OAuth2 server will be in the format
79+
# {
80+
# "access_token": "<access-token>",
81+
# "token_type": "Bearer",
82+
# "expires_in": 3599,
83+
# }
7784
OAUTH2_ENDPOINT=[<endpoint>]
7885
OAUTH2_CLIENT_ID=[<client-id>]
7986
OAUTH2_CLIENT_SECRET=[<client-secret>]

docs/self-hosted/gitlab.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,14 @@ AZURE_O1_DEPLOYMENT_NAME=<o1-deployment-name>
6868
AZURE_O1MINI_DEPLOYMENT_NAME=[<o1-mini-deployment-name>]
6969

7070
# OAuth2 Configuration (optional)
71-
# 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.
71+
# This will use client_credentials flow to get an access token,
72+
# and use it to make requests to the LLM provider.
73+
# It is expected that the response from the OAuth2 server will be in the format
74+
# {
75+
# "access_token": "<access-token>",
76+
# "token_type": "Bearer",
77+
# "expires_in": 3599,
78+
# }
7279
OAUTH2_ENDPOINT=[<endpoint>]
7380
OAUTH2_CLIENT_ID=[<client-id>]
7481
OAUTH2_CLIENT_SECRET=[<client-secret>]

0 commit comments

Comments
 (0)
0