1 Schema Refresh
muke edited this page 2026-03-02 12:10:10 +01:00
# Schema-Refresh

Diese Seite beschreibt das kleine Hilfswerkzeug zum Erzeugen von JSON-Schemata
für Phorge-Objekte (aktuell: Maniphest). Ziel ist es, benutzerdefinierte
(`custom.*`) Felder automatisch zu erkennen und zusammen mit einer stabilen
Liste der Standardfelder abzulegen.

## Wozu?

- Erleichtert die Arbeit mit benutzerdefinierten Feldern beim Import/Mapping
- Liefert eine referenzierbare JSON-Datei für automatisierte Prozesse
- Ermöglicht eine schnelle Übersicht über vorhandene Custom-Felder

## Erzeugte Dateien

- `var/schemas/maniphest.custom.json` — erkannte Custom-Felder (detektierte Typen)
- `var/schemas/maniphest.standard.json` — stabile Liste der standardmäßigen Maniphest-Felder

Die Dateien werden atomar geschrieben (tmp -> rename) um Korruption zu vermeiden.

## Aufruf

Das Tool ist als CLI-Wrapper implementiert und befindet sich in `cli/schema_refresh.php`.

Beispiel (aus dem Projektverzeichnis):

```bash
docker compose -f docker-compose.yml exec -T app php /app/cli/schema_refresh.php maniphest

Optionale Parameter können in der Implementierung (pages, limit, sample_size) gesetzt werden.

Hinweise

  • Die Erkennung verwendet heuristische Typen (phid, integer, float, date, array, string).
  • Die standard.json ist als stabile Referenz gedacht; Änderungen hier sollten bewusst erfolgen.
  • Dieses Skript ist für Entwicklungs- und Betriebsteams gedacht und benötigt gültige Phorge-API-Zugangsdaten in config/config.php.

Vorschlag: Cron / CI

Für regelmäßig aktualisierte Umgebungen kann der Aufruf als Cron-Job oder CI-Step eingetragen werden (z. B. weekly), um Custom-Felder aktuell zu halten.


Siehe auch: Tasks, API-Integration