Skip to content

Commit

Permalink
docs: Clarify that enterpriseBaseURL requires /api/v3 suffix
Browse files Browse the repository at this point in the history
Relates to argoproj/notifications-engine#205

Signed-off-by: Andreas Lindhé <[email protected]>
  • Loading branch information
lindhe committed Nov 15, 2023
1 parent 3dffaa4 commit 519ba50
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/operator-manual/notifications/services/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ The GitHub notification service changes commit status using [GitHub Apps](https:
* `appID` - the app id
* `installationID` - the app installation id
* `privateKey` - the app private key
* `enterpriseBaseURL` - optional URL, e.g. https://git.example.com/
* `enterpriseBaseURL` - optional URL, e.g. https://git.example.com/api/v3

> ⚠️ _NOTE:_ Specifying `/api/v3` in the `enterpriseBaseURL` is required until [argoproj/notifications-engine#205](https://github.com/argoproj/notifications-engine/issues/205) is resolved.
## Configuration

Expand Down

0 comments on commit 519ba50

Please sign in to comment.