Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Konsolidierung fehlender Endpunkte für Remote-Backend-Frontend (notwendig vs. wünschenswert)

Abierto
  • ¿Algo no está bien?
#44 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Tranquilo
Stack tecnológico
php
Área
api, backend

Línea de trabajo

Empieza inspeccionando los endpoints existentes de la Core CRUD API y sus convenciones para respuestas, errores, autorización y paginación. El issue abarca la gestión de addons, las operaciones de caché y sistema, y YForm CRUD, así que identifica los puntos de entrada relevantes y divide el MVP en implementaciones específicas, con criterios de finalización explícitos y pruebas para cada grupo de endpoints.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Kontext

Bei der Entwicklung eines Remote-Backend-Frontends für REDAXO (Control-Plane über API) ist aufgefallen, dass mehrere zentrale Betriebs- und Daten-Endpunkte fehlen.

Im aktuellen Stand sind Core-CRUD-Endpunkte (Structure/Media/Templates/Modules/Users/Clangs/Metainfo) vorhanden, aber für den produktiven Remote-Betrieb fehlen wichtige API-Bausteine.

Notwendig (MVP)

1) Addon-Management
  • GET /addons — Addon-Liste inkl. installed/active Status
  • GET /addons/{id} — Addon-Details (Version, Requirements, Dependencies)
  • PATCH /addons/{id}/status — aktivieren/deaktivieren
2) Addon Lifecycle
  • POST /addons/{id}/install
  • POST /addons/{id}/uninstall
  • POST /addons/{id}/activate
  • POST /addons/{id}/deactivate
  • POST /addons/{id}/upgrade
3) Cache-Management
  • GET /cache/status — Größe/Status/Last-Rebuild
  • DELETE /cache/all
  • DELETE /cache/{type} — z. B. db, templates, packages
4) System-Information / Betrieb
  • GET /system/info — PHP/REDAXO/Basisinfos
  • GET /system/disk — Disk Space
  • GET /system/database — DB-Größe/Tabellenanzahl
  • GET /system/health — Basis-Healthcheck
5) YForm API (für datengetriebene Remote-Backends essenziell)
  • GET /yform/tables
  • GET /yform/tables/{table}
  • GET /yform/tables/{table}/fields
  • GET /yform/tables/{table}/records
  • GET /yform/tables/{table}/records/{id}
  • POST /yform/tables/{table}/records
  • PATCH /yform/tables/{table}/records/{id}
  • DELETE /yform/tables/{table}/records/{id}

Wünschenswert (Ausbau)

Addon Ops / UX
  • GET /addons/{id}/health — Readiness/Requirement-Check
  • POST /addons/{id}/setup/check — Preflight vor Install/Aktivierung
  • GET /addons/{id}/logs — letzte Install/Update-Logs
YForm Komfort-Endpunkte
  • GET /yform/tables/{table}/options/{field} — Select/Choice-Optionen
  • GET /yform/lookups/{table} — Lightweight-Lookups (id + label)
  • POST /yform/tables/{table}/validate — Payload validieren ohne Persistenz
Optional für Betrieb
  • Erweiterter Healthcheck mit Teilstatus (db, filesystem, cache, addons)
  • Einheitliche Betriebs-Metriken für Dashboard-Kacheln

Anforderungen (für alle neuen Endpunkte)

  • Einheitliches Response-Schema (wie bestehende API)
  • Saubere Fehlercodes (400, 403, 404, 409, 422, 500)
  • Klare Admin-Berechtigung für mutierende Operationen (POST/PATCH/DELETE)
  • Konsistentes Paging/Sorting/Filtering bei Listen

Warum Priorität

Diese Lücken sind im praktischen Aufbau eines Remote-Backends direkt aufgetreten.
Ohne diese Endpunkte bleibt das Dashboard zwar für Basis-CRUD nutzbar, aber nicht als vollständige Control-Plane für Betrieb, Wartung, Addon-Lifecycle und YForm-Datenmanagement.

Lenguaje dominante
PHP
Estrellas
20
Forks
0
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de FriendsOfREDAXO/api

Todos los issues de FriendsOfREDAXO/api

Issues similares

Más issues de PHP

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.