github-starred/vikunja
2
0
Fork 0
mirror of https://github.com/go-vikunja/vikunja.git synced 2026-07-16 14:52:35 -05:00
Code Issues 690 Packages Projects Releases 11 Wiki Activity

Add api_min_compatible field to /api/v1/info for client compatibility #2590

New Issue
Open
opened 2026-03-22 14:13:50 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-03-22 14:13:50 -05:00
Owner
Copy Link

Originally created by @ilvez on GitHub (Mar 14, 2026).

Problem

The mobile app (and potentially other third-party clients) has no reliable way to determine if it's compatible with a given server version. Currently the app hardcodes an exact server version (supportedServerVersion = Version(2, 1, 0)) and shows a "Version mismatch — use at your own risk!" warning whenever the server reports anything different.

This creates a few problems:

  • Every server upgrade triggers the warning until a new app version is published with an updated constant
  • Users see the warning on every app launch (and on share-to-app), even when nothing is actually broken
  • The app can't distinguish between "server is newer but still compatible" and "server made breaking API changes"
  • Related issues: go-vikunja/app#235, go-vikunja/app#204, go-vikunja/app#241

Proposal

Add a single new field to the /api/v1/info response:

{
  "version": "2.2.0",
  "api_min_compatible": "2.1.0",
  ...
}

api_min_compatible declares the oldest client target version that still works with this server. It only gets bumped when a breaking API change ships (endpoint removal/rename, changed request/response shape, etc.).

Client-side logic

A client built for version X is compatible if:

api_min_compatible <= X <= server version
  • If X < api_min_compatible → client is too old, warn/block
  • If X > server version → server is too old, warn
  • Otherwise → compatible, no warning needed
  • If field is missing (older server) → fall back to current behavior

Why this approach

  • One new field, no new endpoints or headers
  • Server-side it's just a constant that gets updated on breaking changes
  • Backwards compatible — clients that don't know about the field ignore it, clients that do get smarter behavior
  • The existing boolean feature flags in /info (caldav_enabled, task_comments_enabled, etc.) already cover per-feature discovery — this only needs to cover API-level breaking changes

Alternatives considered

  • Per-feature capability strings (e.g. capabilities: ["tasks.v2", "reactions"]) — more granular but adds complexity that isn't needed given the project's release cadence. Existing boolean flags already serve this purpose.
  • API version headers per-request — requires changes across all endpoints, high implementation cost.
  • Monotonically increasing schema version number — loses semver semantics, harder to reason about.
Originally created by @ilvez on GitHub (Mar 14, 2026). ## Problem The mobile app (and potentially other third-party clients) has no reliable way to determine if it's compatible with a given server version. Currently the app hardcodes an exact server version (`supportedServerVersion = Version(2, 1, 0)`) and shows a "Version mismatch — use at your own risk!" warning whenever the server reports anything different. This creates a few problems: - Every server upgrade triggers the warning until a new app version is published with an updated constant - Users see the warning on **every app launch** (and on share-to-app), even when nothing is actually broken - The app can't distinguish between "server is newer but still compatible" and "server made breaking API changes" - Related issues: go-vikunja/app#235, go-vikunja/app#204, go-vikunja/app#241 ## Proposal Add a single new field to the `/api/v1/info` response: ```json { "version": "2.2.0", "api_min_compatible": "2.1.0", ... } ``` `api_min_compatible` declares the oldest client target version that still works with this server. It only gets bumped when a breaking API change ships (endpoint removal/rename, changed request/response shape, etc.). ### Client-side logic A client built for version X is compatible if: ``` api_min_compatible <= X <= server version ``` - If `X < api_min_compatible` → client is too old, warn/block - If `X > server version` → server is too old, warn - Otherwise → compatible, no warning needed - If field is missing (older server) → fall back to current behavior ### Why this approach - One new field, no new endpoints or headers - Server-side it's just a constant that gets updated on breaking changes - Backwards compatible — clients that don't know about the field ignore it, clients that do get smarter behavior - The existing boolean feature flags in `/info` (`caldav_enabled`, `task_comments_enabled`, etc.) already cover per-feature discovery — this only needs to cover API-level breaking changes ### Alternatives considered - **Per-feature capability strings** (e.g. `capabilities: ["tasks.v2", "reactions"]`) — more granular but adds complexity that isn't needed given the project's release cadence. Existing boolean flags already serve this purpose. - **API version headers per-request** — requires changes across all endpoints, high implementation cost. - **Monotonically increasing schema version number** — loses semver semantics, harder to reason about.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
area/api
area/attachments
area/auth
area/avatars
area/backup-restore
area/caldav
area/calendar-view
area/comments
area/config
area/database
area/desktop
area/docker
area/email
area/favorites
area/filters
area/frontend
area/gantt
area/i18n
area/import-export
area/internal-code
area/kanban
area/labels
area/list-view
area/mobile
area/notifications
area/permissions
area/projects
area/pwa
area/recurring-tasks
area/reminders
area/search
area/shortcuts
area/subtasks
area/sync
area/table-view
area/task-editor
area/task-metadata
area/task-relations
area/teams
area/theming
area/time-tracking
area/typesense
area/views
area/webhooks
bug
changes requested
concern/accessibility
concern/performance
concern/regression
concern/ux
confirmed
db/mysql
dependencies
enhancement
good first issue
help wanted
integration/inbound
integration/outbound
kind/bug
kind/feature
needs reproduction
pull-request
Mirrored from GitHub Pull Request
 question
security
support
upstream issue
waiting for reply
wontfix
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/vikunja#2590
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?