WCIF v2 Upgrade Notice

Aberta
#92 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
49/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
react, typescript
Domínio
backend

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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!

Linguagem predominante
TypeScript
Estrelas
11
Forks
13
Merge médio
2h 8min
PRs com merge (30d)
5

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de coder13/Competitor-groups

Todas as issues de coder13/Competitor-groups

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.