WCIF v2 Upgrade Notice

未关闭
#92 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
49/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
react, typescript
领域
backend

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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!

主要语言
TypeScript
星标
11
派生
13
平均合并
2 小时 8 分钟
30 天内合并 PR
5

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

coder13/Competitor-groups 的其他 Issue

查看 coder13/Competitor-groups 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。