docs: README "API Design" lists endpoints that do not exist
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 48/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- express, javascript, node.js
- Área
- api, documentation
Línea de trabajo
Read the README's API Design section and compare it with the auth and course route files under routes/*.js, which define 33 routes. The suggested fix calls for an OpenAPI spec and CI checks, so first map the documented endpoints to the mounted routes and decide how the spec will be checked against them. Done means the README links an accurate spec and CI detects routes missing from either side.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
The README's API Design section lists ten endpoints such as POST /api/auth/signup, POST /api/auth/verify-otp, GET /api/courses/:id and POST /api/courses/:id/rate. None of them exists in the code: the real routes are mounted under /api/v1/… and use action names, for example POST /api/v1/auth/signup, GET /api/v1/course/getAllCourses and POST /api/v1/course/getCourseDetails. The auth and course route files alone define 33 routes.
Suggested fix
- Replace the list with an OpenAPI spec (
openapi.yaml) generated from or checked againstroutes/*.js, and link a rendered version (Redocly or Swagger UI) from the README. - Add a CI step that fails when a route exists in the code but not in the spec, or the other way round.
Found while reviewing StudyNotion with Claude Code.
- Lenguaje dominante
- JavaScript
- Estrellas
- 23
- Forks
- 8
- Merge medio
- 11 min
- PR fusionados (30 d)
- 4
Preparar el entorno
- Sin Dockerfile ni 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 khemssharma/StudyNotion
-
docs: README is missing the sections its introduction promises; outdated clone URL and Node versionAbiertodocumentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
khemssharma/StudyNotion#55 ·
-
enhancement
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
khemssharma/StudyNotion#59 ·
-
enhancement
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
khemssharma/StudyNotion#58 ·
-
enhancement
Dificultad 5/5 Más de una semana Aptitud para principiantes 38/100
khemssharma/StudyNotion#57 ·
-
enhancement
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
khemssharma/StudyNotion#56 ·
Todos los issues de khemssharma/StudyNotion
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
OWASP/CheatSheetSeries#3018 ·
Los mantenedores suelen responder en 1 día
-
Radix number block generates NaN after switching a negative or decimal number to binary, octal or hexPosiblemente ocupada @matthewalberto la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
mit-cml/appinventor-sources#4246 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
marketing
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 83/100
GoogleChrome/modern-web-guidance-src#3675 · 2 comentarios ·
Los mantenedores suelen responder en 1 día