From 3e04da3926b41f1f9f4d5217a88d194c48d1e5bb Mon Sep 17 00:00:00 2001 From: Masahiko AMANO Date: Fri, 3 Jul 2026 10:30:55 +0300 Subject: [PATCH] docs(project): clarify API path vs product version in openapi Add a short Versioning note: info.version tracks the 3.0.0 product release while the /api/v1 path is the API compatibility version, and the two are independent. Pre-empts the "why v1 under 3.0.0?" confusion. Co-Authored-By: Claude Opus 4.8 --- openapi.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/openapi.yaml b/openapi.yaml index 97a65fe..b131080 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -4,6 +4,11 @@ info: description: | REST API for Tanabata File Manager — a multi-user, tag-based web file manager. + ## Versioning + The `version` field above is the product release (tracks the app's 3.0.0). + The URL path version (`/api/v1`) is the API compatibility version and changes + only on a breaking contract change — the two are intentionally independent. + ## Authentication All endpoints require a Bearer JWT token in the `Authorization` header, except `POST /auth/login`, `POST /auth/refresh` (which carry their own