docs: README "API Design" lists endpoints that do not exist
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 48/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- express, javascript, node.js
- Domain
- api, documentation
Research direction
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.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- JavaScript
- Stars
- 23
- Forks
- 8
- Avg merge
- 11m
- Merged PRs (30d)
- 4
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from khemssharma/StudyNotion
-
docs: README is missing the sections its introduction promises; outdated clone URL and Node versionOpendocumentation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
khemssharma/StudyNotion#55 ·
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 35/100
khemssharma/StudyNotion#59 ·
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 45/100
khemssharma/StudyNotion#58 ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 38/100
khemssharma/StudyNotion#57 ·
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 45/100
khemssharma/StudyNotion#56 ·
All issues in khemssharma/StudyNotion
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
OWASP/CheatSheetSeries#3018 ·
Maintainers usually reply within 1 day
-
Radix number block generates NaN after switching a negative or decimal number to binary, octal or hexPossibly taken @matthewalberto claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
mit-cml/appinventor-sources#4246 · 1 comment ·
Maintainers usually reply within 1 day
-
marketing
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 83/100
GoogleChrome/modern-web-guidance-src#3675 · 2 comments ·
Maintainers usually reply within 1 day