docs: README "API Design" lists endpoints that do not exist

Aperta
#54 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

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

documentation

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 against routes/*.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

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di khemssharma/StudyNotion

Tutte le issue di khemssharma/StudyNotion

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.