From e806de2f7c6bb1985133ab0a77186448ae4a0be1 Mon Sep 17 00:00:00 2001
From: Alexandros Bouras <alexandros.bouras@zendis.de>
Date: Fri, 28 Feb 2025 08:47:05 +0000
Subject: [PATCH] Edit index.mdx - edit only some vocabulary
---
src/pages/concepts/configuration/index.mdx | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/pages/concepts/configuration/index.mdx b/src/pages/concepts/configuration/index.mdx
index 2db0d1e..99df904 100644
--- a/src/pages/concepts/configuration/index.mdx
+++ b/src/pages/concepts/configuration/index.mdx
@@ -8,7 +8,7 @@ import { Callout } from 'nextra/components'
-The badge api is configured using a yaml configuration file with the name `.badge-api.yaml`. The program looks for this file in the current working directory and inside `/etc/badge-api/`.
+The badge API is configured using a yaml configuration file with the name `.badge-api.yaml`. The program looks for this file in the current working directory and inside `/etc/badge-api/`.
The configuration file consists of several key sections, including:
@@ -36,12 +36,12 @@ gitClients:
#### Token Permissions
-The token is used to authenticate the badge api against the git provider api. For regular usage the token does not need any special permissions. It is only used because even for open source projects **gitlab** requires authentication for `/member` endpoints.
+The token is used to authenticate the badge API against the git provider API. For regular usage the token does not need any special permissions. It is only used because even for open source projects **gitlab** requires authentication for `/member` endpoints.
Nevertheless, there is a special case if you provide [manual checks](#manual-check-type) with a decision json file stored in a private repository. In this case, the badge api uses the provided token to access the json file as well (if the baseURL matches). For this operation the token needs to have at least the `read_repository` permission (project access token is fine as well). The same applies to `svgUrls` which are stored in private repositories.
-The api identifies the correct token by the provided `baseUrl` and `type` in the configuration file.
+The API identifies the correct token by the provided `baseUrl` and `type` in the configuration file.
### Badges Configuration
--
GitLab