VRCX API Update Prep #786

Closed
opened 2026-04-05 16:26:45 +02:00 by MrUnknownDE · 0 comments
Owner

Originally created by @DubyaDude on 8/18/2024

This is an issue to track preparation of the API upgrade. Currently the API is live for testing under https://api1.vrcx.app/
Source: https://github.com/vrcx-team/VRCX-API

The main goals for this API change is:

  • Parity with the current API to make this a drop in replacement with V0 once tested.
  • Allow us to utilize Cloudflare caching to reduce loads on the server.
  • Allow us to merge nightly (Natsumis fork) and main repository (vrcx-team) into one repository.
  • Allow for easy future expansion.

How does the API differ from current?

  • You may see some fields be swapped out/new fields as the data model isn't 1:1, but for the purpose of the VRCX updater, the fields that matter should be identical.
  • stable will contain all releases from the main repository that are not marked as a pre-release.
  • nightly will contain all releases from the main repository that are marked as a pre-release merged with all releases from the nightly fork.
  • The prerelease field will always be false due to some legacy logic.

Checklist

*Originally created by @DubyaDude on 8/18/2024* This is an issue to track preparation of the API upgrade. Currently the API is live for testing under https://api1.vrcx.app/ Source: https://github.com/vrcx-team/VRCX-API ## The main goals for this API change is: - Parity with the current API to make this a drop in replacement with V0 once tested. - Allow us to utilize Cloudflare caching to reduce loads on the server. - Allow us to merge nightly (Natsumis fork) and main repository (vrcx-team) into one repository. - Allow for easy future expansion. ## How does the API differ from current? - You may see some fields be swapped out/new fields as the data model isn't 1:1, but for the purpose of the VRCX updater, the fields that matter should be identical. - `stable` will contain all releases from the main repository that are not marked as a pre-release. - `nightly` will contain all releases from the main repository that are marked as a pre-release merged with all releases from the nightly fork. - The `prerelease` field will always be false due to some legacy logic. ## Checklist - [X] Release API for testing under v1 subdomain - [x] [Remove legacy updater logic](https://github.com/vrcx-team/VRCX/blob/a7cad548672aabf306b5b89de233fc1b4a06749e/html/src/app.js#L25723-L25729). - https://github.com/vrcx-team/VRCX/pull/876 - [x] Remove all references of grabbing GitHub releases directly in favor for `https://api0.vrcx.app/` - https://github.com/vrcx-team/VRCX/pull/876 - [x] Change the old pypys domain to redirect to `https://api0.vrcx.app/`. - [x] Deploy new API under v0 subdomain.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github/VRCX#786