WCIF v2 Upgrade Notice

Aperta
  • Qualcosa non va?
#92 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
49/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
react, typescript
Ambito
backend

Direzione di ricerca

Start by finding where the app fetches WCIF from /api/v0/competitions/{id}/wcif or /wcif/public, then read the WCIF v2.2 changelog and specification linked in the issue. Update the fetch and any handling affected by the version changes, and validate payloads with PUT /api/v0/competitions/wcif/check; the migration is done when the app works with WCIF v2.2.

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

Descrizione

Hi from the WCA Software Team! We're checking who still uses the old WCIF v1 endpoints before we deprecate them, and this project fetches WCIF from /api/v0/competitions/{id}/wcif or /wcif/public. Both still return WCIF v1.2.

WCIF v2.2 is now available, and we plan to deprecate v1 on 2026-11-02. After that date the unversioned endpoints may stop working as expected. Also note that competitions using features v1 can't represent (such as Linked/Dual Rounds) may already return 403 on v1.

How To Migrate

  • Request /api/v0/competitions/{id}/wcif/version/2 for an authenticated fetch, or /wcif/version/2 with no token for public data. Pinning the major version is recommended. /wcif/latest also works, but it will move to future major versions.
  • Use the changelog to see which changes have been made, and update your app accordingly
  • Use the check endpoint to ensure that your new payloads comply with the schema: PUT /api/v0/competitions/wcif/check (no version number specified in the URL - it is specified by the formatVersion in your WCIF payload

Useful Links

Sign up for the developer mailing list in your profile preferences to get future updates. Let us know here if anything blocks the migration. Thanks for building for the community!

Lingua principale
TypeScript
Stelle
11
Fork
13
Merge medio
2h 8m
PR unite (30g)
5

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 coder13/Competitor-groups

Tutte le issue di coder13/Competitor-groups

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.