Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

API request: Course JSON with participants and their exercise status

Abierto
#185 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
38/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
ruby
Área
api, backend

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Ruby
Estrellas
51
Forks
42
Merge medio
1 h 27 min
PR fusionados (30 d)
1

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de testmycode/tmc-server

Todos los issues de testmycode/tmc-server

Issues similares

Más issues de Ruby

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.