docs: README "API Design" lists endpoints that do not exist
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 48/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- express, javascript, node.js
- 領域
- api, documentation
調査の方向性
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.
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- JavaScript
- スター
- 23
- フォーク
- 8
- 平均マージ
- 11分
- マージ済み PR(30日)
- 4
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
khemssharma/StudyNotion のほかの issue
-
docs: README is missing the sections its introduction promises; outdated clone URL and Node versionオープンdocumentation
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
khemssharma/StudyNotion#55 ·
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
khemssharma/StudyNotion#59 ·
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
khemssharma/StudyNotion#58 ·
-
enhancement
難易度 5/5 1週間以上 初心者へのやさしさ 38/100
khemssharma/StudyNotion#57 ·
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
khemssharma/StudyNotion#56 ·
khemssharma/StudyNotion の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
OWASP/CheatSheetSeries#3018 ·
メンテナーはふだん 1 日以内に返信
-
Radix number block generates NaN after switching a negative or decimal number to binary, octal or hex対応中かも @matthewalberto が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
mit-cml/appinventor-sources#4246 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
marketing
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 83/100
GoogleChrome/modern-web-guidance-src#3675 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信