Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
#1,045 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
api, backend

Direzione di ricerca

Inizia esaminando la logica esistente del modello e del controller, quindi determina come il blueprint mod_api proposto si inserisce nell’applicazione. Aggiungi gli endpoint versionati per i risultati dei test e le categorie, con risposte JSON coerenti e la gestione dei test mancanti. Aggiungi test di integrazione per i casi di successo e di risorsa non trovata in tests/test_api/ ed esegui la suite di test nose2.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

[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.

Lingua principale
Python
Stelle
30
Fork
85
Merge medio
6g 8h
PR unite (30g)
22

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di CCExtractor/sample-platform

Tutte le issue di CCExtractor/sample-platform

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.