Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

API request: Course JSON with participants and their exercise status

未关闭
#185 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
38/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
ruby
领域
api, backend

调研方向

Start by reading the existing /:instanceId/courses/:courseId/points.json, exercise_status/:studentId.json, and /:instanceId/participants.json API entry points. Trace how each supplies course participants, student information, and exercise status. Done means /:instanceId/courses/:courseId/participants.json returns the course id and each participant with the proposed information and exercise-status fields in one response.

由索引模型根据 Issue 内容生成。

描述

enhancement lowprio

There's a need for better API in TMC Server for resolving which students have been in a specific course and what is their exercise status. Now to get students of a specific course from TMC you need to navigate to

/:instanceId/courses/:courseId/points.json

and get student IDs from "users" attribute.

On the other hand, you can get exercise status from

/:instanceId/courses/:courseId/exercise_status/:studentId.json

Finally, for complete student information you need to get them from

/:instanceId/participants.json.

To solve all of this with just one request, we suggest the following path:

/:instanceId/courses/:courseId/participants.json

which returns something like this:

{ "id": "courseId", "participants": 
   [
      { "id": "1", "username": "name", "first_name": "first", "last_name": "last",
         "exercise_status": [
            { "exercise1": "status" }, { "exercise2": "status" }
         ]
      }
   ]
} 

This way we can easily find out which students are in the course, their information and which exercises they have been working on.

主要语言
Ruby
星标
51
派生
42
平均合并
1 小时 27 分钟
30 天内合并 PR
1

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

testmycode/tmc-server 的其他 Issue

查看 testmycode/tmc-server 的全部 Issue

相似的 Issue

更多 Ruby Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。