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 摘要。