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

[PROPOSAL] Add versioned REST API endpoints for test results for NG frontend

Abierto
  • ¿Algo no está bien?
#1,045 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 6 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
api, backend

Línea de trabajo

Comienza revisando la lógica existente del modelo y del controlador, y determina después cómo encaja el blueprint mod_api propuesto en la aplicación. Añade los endpoints versionados de resultados de pruebas y categorías con respuestas JSON coherentes y gestión de pruebas inexistentes. Añade pruebas de integración para resultados correctos y no encontrados en tests/test_api/ y ejecuta la suite de pruebas de nose2.

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

Descripción

[PROPOSAL] Add versioned REST API endpoints for test results to support Sample Platform NG frontend

Problem

The current platform primarily serves HTML pages and has very limited API surface. The NG frontend direction needs stable, versioned JSON endpoints for test summary/results/files/progress and category metadata.

Proposed endpoints
  • GET /api/v1/tests/<id>/summary
  • GET /api/v1/tests/<id>/results
  • GET /api/v1/tests/<id>/files
  • GET /api/v1/tests/<id>/progress
  • GET /api/v1/categories
Proposed implementation notes
  • Introduce a dedicated mod_api blueprint.
  • Reuse existing model/controller logic where possible to avoid behavior drift.
  • Return structured JSON with consistent status envelope and 404 handling for missing tests.
  • Add focused API tests for success and not-found paths.
Why this is valuable
  • Unblocks frontend/API decoupling for NG work.
  • Creates a clear contract for external consumers and automation.
  • Reduces coupling to server-rendered templates.
Verification plan
  • Add integration tests under tests/test_api/.
  • Validate endpoint behavior locally with nose2 test suite.

In raising this issue, I confirm the following (please check boxes, eg [X]):

  • I have read and understood the contributors guide.
  • I have checked that the bug-fix I am reporting can be replicated, or that the feature I am suggesting isn't already present.
  • I have checked that the issue I'm posting isn't already reported.
  • I have checked that the issue I'm posting isn't already solved and no duplicates exist in closed issues and in opened issues
  • I have checked the pull requests tab for existing solutions/implementations to my issue/suggestion.

My familiarity with the project is as follows (check one, eg [X]):

  • I have never visited/used the platform.
  • I have used the platform just a couple of times.
  • I have used the platform extensively, but have not contributed previously.
  • I am an active contributor to the platform.
Lenguaje dominante
Python
Estrellas
30
Forks
87
Merge medio
5 d 8 h
PR fusionados (30 d)
17

Preparar el entorno

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 CCExtractor/sample-platform

Todos los issues de CCExtractor/sample-platform

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.