docs: README "API Design" lists endpoints that do not exist
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 48/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- express, javascript, node.js
- Ambito
- api, documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- JavaScript
- Stelle
- 23
- Fork
- 8
- Merge medio
- 11m
- PR unite (30g)
- 4
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di khemssharma/StudyNotion
-
docs: README is missing the sections its introduction promises; outdated clone URL and Node versionApertadocumentation
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
khemssharma/StudyNotion#55 ·
-
enhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
khemssharma/StudyNotion#59 ·
-
enhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
khemssharma/StudyNotion#58 ·
-
enhancement
Difficoltà 5/5 Più di una settimana Idoneità per principianti 38/100
khemssharma/StudyNotion#57 ·
-
enhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
khemssharma/StudyNotion#56 ·
Tutte le issue di khemssharma/StudyNotion
Issue simili
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 72/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
OWASP/CheatSheetSeries#3018 ·
I maintainer di solito rispondono entro 1 giorno
-
Radix number block generates NaN after switching a negative or decimal number to binary, octal or hexForse già presa @matthewalberto l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
mit-cml/appinventor-sources#4246 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
marketing
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 83/100
GoogleChrome/modern-web-guidance-src#3675 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno