Benjamin_Boenisch/breakpilot-compliance
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(api-docs): API-Exposure-Klassifikation — Intern vs. Oeffentlich
Some checks failed
CI / go-lint (push) Has been skipped
Details
CI / python-lint (push) Has been skipped
Details
CI / nodejs-lint (push) Has been skipped
Details
CI / test-go-ai-compliance (push) Failing after 36s
Details
CI / test-python-backend-compliance (push) Successful in 33s
Details
CI / test-python-document-crawler (push) Successful in 20s
Details
CI / test-python-dsms-gateway (push) Successful in 16s
Details

Browse Source 
Alle ~640 Endpoints nach Netzwerk-Exposition klassifiziert: public (5 Module, ~30 EP),
partner/Integration (6 Module, ~25 EP), internal (25+ Module, ~550 EP), admin/Wartung (4 EP).
Badges, Filter und Stats in API-Docs + Developer Portal.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Benjamin Admin
2026-03-08 13:31:16 +01:00
parent 56758e8b55
commit 6ff9f1f2f3
5 changed files with 287 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
developer-portal/app/api/page.tsx
View File

@@ -1,6 +1,20 @@
import Link from 'next/link'
import { DevPortalLayout, ApiEndpoint, InfoBox } from '@/components/DevPortalLayout'
function ExposureBadge({ type }: { type: 'public' | 'partner' | 'internal' | 'admin' }) {
const config = {
public: { label: 'Oeffentlich', className: 'bg-green-100 text-green-800' },
partner: { label: 'Integration', className: 'bg-blue-100 text-blue-800' },
internal: { label: 'Intern', className: 'bg-gray-100 text-gray-700' },
admin: { label: 'Wartung', className: 'bg-orange-100 text-orange-800' },
}[type]
return (
<span className={`inline-block text-[10px] font-medium px-1.5 py-0.5 rounded ml-2 ${config.className}`}>
{config.label}
</span>
)
}
export default function ApiReferencePage() {
return (
<DevPortalLayout
@@ -18,6 +32,18 @@ export default function ApiReferencePage() {
Für Self-Hosted-Installationen verwenden Sie Ihre eigene Domain.
</p>
<InfoBox type="info" title="API Exposure">
Jeder Endpoint ist mit einer Exposure-Kategorie gekennzeichnet:
<span className="inline-block text-[10px] font-medium px-1.5 py-0.5 rounded bg-green-100 text-green-800 mx-1">Oeffentlich</span>
Internet-exponiert,
<span className="inline-block text-[10px] font-medium px-1.5 py-0.5 rounded bg-blue-100 text-blue-800 mx-1">Integration</span>
API-Key-authentifiziert,
<span className="inline-block text-[10px] font-medium px-1.5 py-0.5 rounded bg-gray-100 text-gray-700 mx-1">Intern</span>
nur Admin-Dashboard,
<span className="inline-block text-[10px] font-medium px-1.5 py-0.5 rounded bg-orange-100 text-orange-800 mx-1">Wartung</span>
nur Setup.
</InfoBox>
<h2>Authentifizierung</h2>
<p>
Alle API-Anfragen erfordern einen gültigen API Key im Header:
@@ -33,7 +59,7 @@ export default function ApiReferencePage() {
<h2>API Endpoints</h2>
<h3>State Management</h3>
<h3>State Management <ExposureBadge type="internal" /></h3>
<p>
Verwalten Sie den SDK-State für Ihren Tenant.
</p>
@@ -60,7 +86,7 @@ export default function ApiReferencePage() {
</Link>
</p>
<h3>RAG Search</h3>
<h3>RAG Search <ExposureBadge type="partner" /></h3>
<p>
Durchsuchen Sie den Compliance-Korpus (DSGVO, AI Act, NIS2).
</p>
@@ -82,7 +108,7 @@ export default function ApiReferencePage() {
</Link>
</p>
<h3>Document Generation</h3>
<h3>Document Generation <ExposureBadge type="internal" /></h3>
<p>
Generieren Sie Compliance-Dokumente automatisch.
</p>
@@ -109,7 +135,7 @@ export default function ApiReferencePage() {
</Link>
</p>
<h3>Export</h3>
<h3>Export <ExposureBadge type="internal" /></h3>
<p>
Exportieren Sie den Compliance-Stand in verschiedenen Formaten.
</p>
@@ -126,7 +152,7 @@ export default function ApiReferencePage() {
</Link>
</p>
<h3>Consent Management</h3>
<h3>Consent Management <ExposureBadge type="public" /></h3>
<p>
Verwalten Sie Einwilligungen, rechtliche Dokumente und Cookie-Banner-Konfigurationen.
</p>
@@ -142,7 +168,7 @@ export default function ApiReferencePage() {
</Link>
</p>
<h3>DSFA — Datenschutz-Folgenabschätzung</h3>
<h3>DSFA — Datenschutz-Folgenabschätzung <ExposureBadge type="internal" /></h3>
<p>
Verwalten Sie Datenschutz-Folgenabschätzungen gemäß Art. 35 DSGVO mit vollständigem
Audit-Trail, Status-Workflow und Risikobewertung.