Skip to content

Latest commit

 

History

History

api_contracts

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

API Contracts (machine-readable)

Datum: 2026-10-29 Status: Active Bezug: Maschinenlesbare API-Vertragsuebersichten fuer AI-Agenten Primary (Quelle der Wahrheit): include/, src/, tests/**

Dieses Verzeichnis enthält API-Vertragsübersichten in tabellarischer Form.

Ziel

  • Öffentliche Schnittstellen für KI-Agenten eindeutig und schnell erfassbar machen
  • Vertragsverletzungen (Preconditions/Postconditions/Error-Semantik) früh erkennen

Tabellen-Schema (verbindlich)

API Namespace/Typ Input Contract Output Contract Errors Thread-Safety Ownership/Lifetime Notes

Befüllung

  • Pro Modul eigene Datei (z. B. tensor_api_contracts.md)
  • Nur verifizierte Informationen aus include/**, src/**, Tests übernehmen
  • Bei Verhaltensänderungen im selben PR synchron aktualisieren

Installation

Keine Installation erforderlich; dieses Verzeichnis ist Teil des Repository-Inhalts.

Usage

Dateien hier als Referenz lesen und bei inhaltlichen Änderungen im selben PR mit den betroffenen Code-/Dokumentationsänderungen synchron halten.