WCIF v2 Upgrade Notice

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

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
49/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
react, typescript
Área
backend

Línea de trabajo

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.

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

Descripción

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!

Lenguaje dominante
TypeScript
Estrellas
11
Forks
13
Merge medio
2 h 8 min
PR fusionados (30 d)
5

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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

Todos los issues de coder13/Competitor-groups

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.