Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

API request: Course JSON with participants and their exercise status

Đang mở
#185 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
38/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
ruby
Lĩnh vực
api, backend

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Ruby
Star
51
Fork
42
Merge trung bình
1 giờ 27 phút
Pull request đã merge (30 ngày)
1

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của testmycode/tmc-server

Tất cả issue của testmycode/tmc-server

Issue tương tự

Thêm issue về Ruby

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.