From 7ace7d3c19eef7e5339f877548d6bb143f567c77 Mon Sep 17 00:00:00 2001
From: Sebastian Kawelke <sebastian.kawelke@l3montree.com>
Date: Tue, 11 Mar 2025 16:01:56 +0100
Subject: [PATCH] Translates various checks
Signed-off-by: Sebastian Kawelke <sebastian.kawelke@l3montree.com>
---
src/pages/de/api-docs/_meta.ts | 2 +-
src/pages/de/api-docs/index.mdx | 16 +++++++-------
src/pages/de/api-docs/v1/_meta.ts | 5 +++--
.../de/api-docs/v1/badge-explanation.mdx | 16 +++++++-------
src/pages/de/api-docs/v1/badges.mdx | 17 +++++++--------
.../api-docs/v1/sarif-per-repo-endpoint.mdx | 21 ++++++++++---------
6 files changed, 39 insertions(+), 38 deletions(-)
diff --git a/src/pages/de/api-docs/_meta.ts b/src/pages/de/api-docs/_meta.ts
index 5ecd98b..c3e7383 100644
--- a/src/pages/de/api-docs/_meta.ts
+++ b/src/pages/de/api-docs/_meta.ts
@@ -2,6 +2,6 @@
// SPDX-License-Identifier: MIT
export default {
- index: { title: 'Overview' },
+ index: { title: 'Ãœberblick' },
v1: { title: 'API v1' },
}
diff --git a/src/pages/de/api-docs/index.mdx b/src/pages/de/api-docs/index.mdx
index cfdcadc..423e215 100644
--- a/src/pages/de/api-docs/index.mdx
+++ b/src/pages/de/api-docs/index.mdx
@@ -12,24 +12,24 @@ import {
EyeSlashIcon
} from '@heroicons/react/24/outline'
-# API Documentation
+# API Dokumentation
-The ZenDiS Badge API repository scanner provides a JSON API to interact with. The following endpoints are available:
+Die Badge API bietet eine RESTful JSON-API an. Die folgenden Endpunkte sind verfügbar:
<Cards>
<Cards.Card
icon={<EyeSlashIcon />}
- title="SARIF Report per Repository"
- href="api-docs/v1/sarif-per-repo-endpoint"
+ title="SARIF Report pro Repository"
+ href="/de/api-docs/v1/sarif-per-repo-endpoint"
/>
<Cards.Card
icon={<LinkIcon />}
- title="Badge of a Repository as SVG"
- href="api-docs/v1/badges#get-svg-badge"
+ title="Badge eines Repositorys als SVG"
+ href="/de/api-docs/v1/badges#get-svg-badge"
/>
<Cards.Card
icon={<CubeIcon />}
- title="Explanation of a Badge of a Repository"
- href="api-docs/v1/badges#get-badge-explanation"
+ title="Erklärung einer Badge eines Repositorys"
+ href="/de/api-docs/v1/badges#get-badge-explanation"
/>
</Cards>
\ No newline at end of file
diff --git a/src/pages/de/api-docs/v1/_meta.ts b/src/pages/de/api-docs/v1/_meta.ts
index 5c939c3..eccddbe 100644
--- a/src/pages/de/api-docs/v1/_meta.ts
+++ b/src/pages/de/api-docs/v1/_meta.ts
@@ -2,6 +2,7 @@
// SPDX-License-Identifier: MIT
export default {
- 'sarif-per-repo-endpoint': { title: 'SARIF per Repo' },
- badges: { title: 'Badge per Repo and BadgeId' },
+ 'sarif-per-repo-endpoint': { title: 'SARIF pro Repo' },
+ badges: { title: 'Badge pro Repo and Badge-ID' },
+ 'badge-explanation': { title: 'Erklärung einer Badge' },
}
diff --git a/src/pages/de/api-docs/v1/badge-explanation.mdx b/src/pages/de/api-docs/v1/badge-explanation.mdx
index 2d41777..50c57b8 100644
--- a/src/pages/de/api-docs/v1/badge-explanation.mdx
+++ b/src/pages/de/api-docs/v1/badge-explanation.mdx
@@ -7,24 +7,24 @@ SPDX-License-Identifier: MIT */}
import { Tabs, Callout } from 'nextra/components'
-# Badge Explanation
+# Erklärung einer Badge
-## Get the explanation of a badge
+## Erklärung zu einer Badge erhalten
<Callout type="info">
`GET /api/v1/repositories/{repositoryUrl}/badges/{badgeID}/sarif`
</Callout>
-This endpoint returns the the explanation of a badge for the given repository URL and badge ID.
+Dieser Endpunkt gibt die Erklärung einer Badges für die angegebene Repository-URL und Badge-ID zurück.
-This endpoint gets parameterized with the repository URL and the badge ID. The repository URL is the URL of the repository that should
-be or was already scanned. **The URL must be URL encoded**
+Dieser Endpunkt wird mit der Repository-URL und der Badge-ID parametrisiert. Die Repository-URL ist die
+URL des Repositorys, das gescannt werden soll oder bereits gescannt wurde. **Die URL muss URL-encodiert sein.**
(`https://gitlab.opencode.de/zendis-repo-scanner` → `https%3A%2F%2Fgitlab.opencode.de%2Fzendis-repo-scanner`).
-The badge ID is the title of the badge that should be returned. The available badges and therefore the badge IDs are defined in the
-[.badge-api.yaml](/en/concepts/configuration) of the badge api instance.
+Die Badge-ID ist der Titel der Badge, der zurückgegeben werden soll. Die verfügbaren Badges und damit die Badge-IDs werden in der
+[.badge-api.yaml](/de/concepts/configuration) der Instanz der API definiert.
-### Example Request
+### Beispiel Anfrage
<Tabs items={['GO', 'JavaScript', 'curl']}>
<Tabs.Tab>
diff --git a/src/pages/de/api-docs/v1/badges.mdx b/src/pages/de/api-docs/v1/badges.mdx
index 85e445f..fa9638b 100644
--- a/src/pages/de/api-docs/v1/badges.mdx
+++ b/src/pages/de/api-docs/v1/badges.mdx
@@ -7,25 +7,24 @@ SPDX-License-Identifier: MIT */}
import { Tabs, Callout } from 'nextra/components'
-# Badges
+# Badge pro Repository und Badge-ID
-## Get SVG Badge
+## SVG einer Badge
<Callout type="info">
`GET /api/v1/repositories/{repositoryUrl}/badges/{badgeID}`
</Callout>
-This endpoint returns the **SVG badge** for the given repository URL and badge ID.
+Dieser Endpunkt gibt die **SVG-Badge** für die angegebene Repository-URL und Badge-ID zurück.
-This endpoint gets parameterized with the repository URL and the badge ID. The repository URL is the URL of the repository that should
-be or was already scanned. **The URL must be URL encoded**
+Dieser Endpunkt wird mit der Repository-URL und der Badge-ID parametrisiert. Die Repository-URL ist die URL des Repositorys, das
+gescannt werden soll oder bereits gescannt wurde. **Die URL muss URL-encodiert sein**
(`https://gitlab.opencode.de/zendis-repo-scanner` → `https%3A%2F%2Fgitlab.opencode.de%2Fzendis-repo-scanner`).
-The badge ID is the title of the badge that should be returned. The available badges and therefore the badge IDs are defined in the
-[.badge-api.yaml](/en/concepts/configuration) of the badge api instance.
-
-### Example Request
+Die Badge-ID ist der Titel der Badge, der zurückgegeben werden soll. Die verfügbaren Badges und damit die Badge-IDs werden in der
+[.badge-api.yaml](/de/concepts/configuration) der Instanz der API definiert.
+### Beispiel Anfrage
<Tabs items={['GO', 'JavaScript', 'curl']}>
<Tabs.Tab>
```go filename="main.go" copy
diff --git a/src/pages/de/api-docs/v1/sarif-per-repo-endpoint.mdx b/src/pages/de/api-docs/v1/sarif-per-repo-endpoint.mdx
index dc137c8..4bf213b 100644
--- a/src/pages/de/api-docs/v1/sarif-per-repo-endpoint.mdx
+++ b/src/pages/de/api-docs/v1/sarif-per-repo-endpoint.mdx
@@ -7,24 +7,25 @@ SPDX-License-Identifier: MIT */}
import { Tabs, Callout } from 'nextra/components'
-# SARIF per Repository
+# SARIF pro Repository
<Callout type="info">
`GET /api/v1/repositories/{repositoryUrl}/sarif`
</Callout>
-This endpoint gets parameterized with the **full repository URL**. The repository URL is the URL of the repository that should be scanned.
-**The URL must be URL encoded**
+Dieser Endpunkt wird mit der **vollständigen Repository-URL** parametrisiert. Die Repository-URL ist die URL des zu scannenden Repositorys.
+**Die URL muss URL-encodiert sein**
(`https://gitlab.opencode.de/zendis-repo-scanner` → `https%3A%2F%2Fgitlab.opencode.de%2Fzendis-repo-scanner`).
-Using this format opens the possibility to scan repositories from other platforms like GitHub, Bitbucket, etc. Besides
-that, caching is simplified because the URL is unique (instead of using the project ID and a platform URL as query string for
-example) and the URL is human-readable, at least after URL decoding. This might improve debugging in the future.
+Die Verwendung dieses Formats eröffnet die Möglichkeit, Repositorys von anderen Plattformen wie GitHub, Bitbucket usw.
+zu scannen. Außerdem wird das Caching vereinfacht, da die URL eindeutig ist (anstatt beispielsweise die Projekt-ID und
+eine Plattform-URL als Query-String zu verwenden) und die URL zumindest nach der URL-Dekodierung für Menschen
+lesbar ist. Dies könnte in Zukunft die Fehlerbehebung verbessern.
-The result is returned in [SARIF format](https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning).
-**SARIF simplifies possible later integration with other tools. It is an open standard and widely supported.**
+Die Antwort der API ist im [SARIF format](https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning).
+**SARIF vereinfacht eine mögliche spätere Integration mit anderen Tools. Es handelt sich um einen offenen Standard, der breite Unterstützung findet.**
-### Example Request
+### Beispiel Anfrage
<Tabs items={['GO', 'JavaScript', 'curl']}>
<Tabs.Tab>
@@ -70,7 +71,7 @@ The result is returned in [SARIF format](https://docs.github.com/en/code-securit
</Tabs.Tab>
</Tabs>
-### Example JSON Response
+### Beispiel Antwort
```json
{
--
GitLab