tech/tanabata
1
1
Fork 0
Code Pull Requests Actions Releases 1 Activity

docs(project): clarify API path vs product version in openapi
deploy / deploy (push) Successful in 1m0s
Details

Browse Source 
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 <noreply@anthropic.com>
This commit is contained in:
Masahiko AMANO
2026-07-03 10:30:55 +03:00
parent 87d3c27b65
commit 3e04da3926
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
openapi.yaml
+5
View File
@@ -4,6 +4,11 @@ info:
description: | description: |
REST API for Tanabata File Manager — a multi-user, tag-based web file manager. 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 ## Authentication
All endpoints require a Bearer JWT token in the `Authorization` header, All endpoints require a Bearer JWT token in the `Authorization` header,
except `POST /auth/login`, `POST /auth/refresh` (which carry their own except `POST /auth/login`, `POST /auth/refresh` (which carry their own