Documenter l'API REST du backend (docs/API.md)
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 58/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Tranquilo
- Stack tecnológico
- go, openapi
- Área
- api, documentation
Línea de trabajo
Start with backend/main.go to enumerate registered routes, then inspect backend/api/handler/ and backend/api/service/ for access requirements and exact payload structures. Check the apierror format and invitation flow, then link the finished API reference from the README’s Documentation section. Done means every route, required header and minimum role, mutation example, error format, and end-to-end invitation flow is documented.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Objectif
Produire la documentation complète des endpoints REST exposés par le backend Go. Ce document sert de contrat d'interface entre le frontend et le backend, et de point d'entrée pour toute intégration tierce.
User story
En tant que développeur frontend ou intégrateur, je veux consulter la liste exhaustive des routes, leurs payloads et les en-têtes attendus, afin d'appeler l'API correctement sans lire le code Go.
Tâches
- Créer
docs/API.md. Une spécification OpenAPI est également acceptable si le contributeur préfère. - Recenser les routes — analyser
backend/main.go, où toutes les routes sont enregistrées, et le dossierbackend/api/handler/. Couvrir/api/auth/*,/api/bands/*,/api/song/*,/api/setlist/*,/api/interlude/*. - Documenter l'authentification — indiquer clairement, pour chaque route, si elle est publique, si elle exige le token Bearer (
JWTAuth), et si elle exige l'en-tête de contexte de groupeX-Band-ID. Signaler les routes protégées parAdminOnly. - Payloads et réponses — pour chaque endpoint, un exemple de corps de requête et la réponse attendue. Les structures exactes se trouvent dans
backend/api/service/(CreateSongPayload, etc.). - Codes d'erreur — documenter le format d'erreur renvoyé par
apierroret les codes existants. - Mécanique d'invitation — expliquer le flux d'invitation par token, qui n'est pas évident à la lecture des seules routes.
- Lier depuis le README, dans la section Documentation existante.
Critères d'acceptation
- Toutes les routes enregistrées dans
main.gofigurent dans le document - Chaque endpoint indique sa méthode, son chemin, ses en-têtes requis et son rôle minimum
- Chaque endpoint de mutation a un exemple de payload JSON
- Le format des erreurs est documenté
- Le flux d'invitation est expliqué de bout en bout
- Le README pointe vers
docs/API.md
⚠️ Point de vigilance
Les payloads réels sont définis dans les services, pas dans les handlers. C'est backend/api/service/ qu'il faut lire pour connaître la forme exacte des JSON attendus.
- Lenguaje dominante
- Python
- Estrellas
- 2
- Forks
- 0
- Merge medio
- 21 min
- PR fusionados (30 d)
- 2
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de Doud75/Setly
-
agent-ready chore
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
-
Connexion avec Apple (SSO)Abiertobackend enhancement frontend security
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
-
agent-ready backend enhancement frontend security
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
-
agent-ready backend enhancement frontend security
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
-
agent-ready backend bug frontend security
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
Todos los issues de Doud75/Setly
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
marketcalls/openalgo#2472 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 95/100
marimo-team/marimo#11949 ·
Los mantenedores suelen responder en 1 día
-
bug server-time v2
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
modelcontextprotocol/servers#5559 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
jxxghp/MoviePilot#7449 ·
Los mantenedores suelen responder en 1 día
-
devops help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
guaardvark/guaardvark#421 ·
Los mantenedores suelen responder en 2 días