api: five reads that were declared as writes are now GET

The permission model being built reads the HTTP method to decide whether a
non-owner may make a call: safe methods are reads, everything else is a write.
That only works if the method tells the truth. These five read something and
returned it while announcing themselves as writes, so a member would have been
denied a read they are entitled to because of a habit in how the route was
declared.

  /api/file-browser/video-info         POST {url}  -> GET ?url=
  /api/file-browser/video-playlist     POST {url}  -> GET ?url=
  /api/server-settings/ocr/models      POST {url}  -> GET ?url=
  /api/transmission/_officer/port-test POST        -> GET
  /api/jellyfin/_config/:id/test       POST|GET    -> GET only

The last one already answered to both, which is worse than either: a method that
means nothing cannot be the thing authorisation reads.

Deliberately stops at five. A sweep of all 100 mutating routes found many more
reads wearing POST, and they are staying, for two reasons that are not going
away: some need a request body GET cannot carry (/stt takes multipart audio;
/tts, /ocr, /transcribe take payloads), and some carry a credential, where a
query string is the wrong place — access logs, shell history and Referer headers
all capture those, request bodies do not (/tts/voices takes an apiKey, the four
/test endpoints take connection secrets, /local-providers/probe takes auth).

So the method alone can never carry the permission model, and the registry will
need an explicit per-route classification regardless. Converting these five is
worth it because it is free; converting the rest would be a breaking change
across 117 mobile call sites that buys nothing.

Web callers updated in the same commit; the sidecar contract comments now match.
Mobile has exactly one caller to change — transmissionPortTest in
packages/core/src/services/transmission.ts — and no shim was added, because an
endpoint answering to both methods is the problem this commit exists to fix.

docs/api-method-changes-2026-08-06.md is the handoff for the mobile team: what
changed, the one line to edit, what deliberately did NOT change and why, and how
to verify.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-08-06 13:38:49 +00:00
co-authored by Claude Opus 5
parent 33ecfa989d
commit e54d71da71
11 changed files with 180 additions and 20 deletions
@@ -32,7 +32,9 @@ export const OCRSection = () => {
const fetchModels = async (u: string) => {
setModelsLoading(true);
try {
const res = await client.post<{ models?: string[]; error?: string }>('/server-settings/ocr/models', { url: u });
const res = await client.get<{ models?: string[]; error?: string }>(
`/server-settings/ocr/models?url=${encodeURIComponent(u)}`,
);
if (res.models) setModels(res.models);
else setModels([]);
} catch {
@@ -111,7 +113,9 @@ export const OCRSection = () => {
className="p-0.5 rounded hover:bg-duck-dark/10 dark:hover:bg-foreground/10 cursor-pointer transition-colors disabled:opacity-40"
title="Refresh models"
>
<RefreshCw className={`h-3 w-3 text-duck-dark/50 dark:text-foreground/50 ${modelsLoading ? 'animate-spin' : ''}`} />
<RefreshCw
className={`h-3 w-3 text-duck-dark/50 dark:text-foreground/50 ${modelsLoading ? 'animate-spin' : ''}`}
/>
</button>
</div>
{models.length > 0 ? (
@@ -121,7 +125,9 @@ export const OCRSection = () => {
</SelectTrigger>
<SelectContent className="z-[600] max-h-[300px]">
{models.map((m) => (
<SelectItem key={m} value={m}>{m}</SelectItem>
<SelectItem key={m} value={m}>
{m}
</SelectItem>
))}
</SelectContent>
</Select>
+7 -4
View File
@@ -1331,8 +1331,10 @@ router.get('/download-video/:jobId', (ctx) => {
// Prefetch a single video's metadata (title / thumbnail / duration / uploader) — proxied straight to
// ReClip's /api/info so the download dialog can show a preview card before committing. Errors (private
// video, timeout, …) come back as { error } with a 200 so the client can render them inline.
router.post('/video-info', async (ctx) => {
const { url } = ctx.get('body') as { url?: string };
// GET, not POST: it reads and writes nothing. The method is not cosmetic — the permission model reads
// it to decide whether a non-owner may call this, and a read filed as a write is a read they lose.
router.get('/video-info', async (ctx) => {
const url = ctx.req.query('url');
if (!url) throw errors.BAD_REQUEST('url is required');
const res = await fetch(`${RECLIP_BASE}/api/info`, {
method: 'POST',
@@ -1347,8 +1349,9 @@ router.post('/video-info', async (ctx) => {
// Expand a playlist URL into its individual video URLs (ReClip's /api/playlist → { urls }). The client
// then prefetches /video-info per url to build the per-entry cards.
router.post('/video-playlist', async (ctx) => {
const { url } = ctx.get('body') as { url?: string };
// GET for the same reason as /video-info above.
router.get('/video-playlist', async (ctx) => {
const url = ctx.req.query('url');
if (!url) throw errors.BAD_REQUEST('url is required');
const res = await fetch(`${RECLIP_BASE}/api/playlist`, {
method: 'POST',
+5 -2
View File
@@ -27,8 +27,11 @@ ocrRouter.put('/', async (ctx) => {
return ctx.json({ success: true });
});
ocrRouter.post('/models', async (ctx) => {
const body = await ctx.req.json<{ url: string }>();
// GET: it asks a provider what models it has and returns the answer. Nothing is written, and the only
// input is a URL — no credential, so a query string is the right place for it. Kept POST until
// 2026-08-06 purely by habit, and the permission model reads the method.
ocrRouter.get('/models', async (ctx) => {
const body = { url: ctx.req.query('url') ?? '' };
if (!body.url) return ctx.json({ error: 'URL required' }, 400);
try {
+4 -1
View File
@@ -226,8 +226,11 @@ export async function handleConfigRoute(req: Request, userId: number, subpath: s
return serverList(userId);
}
// GET only. It probes one server and reports whether it answered — nothing is written, and nothing is
// switched (that is `activate`, below). It accepted POST as well until 2026-08-06, which made the
// method meaningless for deciding whether this is a read; the permission model needs that answer.
if (action === 'test') {
if (req.method !== 'POST' && req.method !== 'GET') return bad('method not allowed', 405);
if (req.method !== 'GET') return bad('method not allowed', 405);
return testServer(userId, id);
}
+1 -1
View File
@@ -21,7 +21,7 @@ import { getConfig, probe } from './upstream';
// for an access token and never stored
// PATCH /_config/:id same fields, all optional; no password keeps the stored token
// POST /_config/:id/activate switch to that server
// POST /_config/:id/test probe one server without switching to it
// GET /_config/:id/test probe one server without switching to it
// DEL /_config/:id remove it; the newest survivor is promoted if it was active
//
// GET /_officer/home views + resume + next-up + latest-per-view, one round trip
+1 -1
View File
@@ -31,7 +31,7 @@ import { getTransmissionConfig } from './upstream';
// POST /_officer/torrents/rename {id, path, name}
// POST /_officer/torrents/remove {ids, deleteLocalData}
// GET /_officer/free-space?path= free space at a path
// POST /_officer/port-test is the peer port reachable from outside
// GET /_officer/port-test is the peer port reachable from outside
// POST /_officer/blocklist-update refresh the blocklist, returns the new size
// anything else 404
//
+4 -1
View File
@@ -198,8 +198,11 @@ async function handleFreeSpace(ctx: OfficerContext): Promise<Response> {
return Response.json({ path: result.path, bytes: result['size-bytes'] });
}
// GET: it asks the daemon whether the peer port is reachable and returns the answer. Nothing changes,
// on this side or Transmission's. Blocklist-update below stays POST because it genuinely refetches and
// replaces the list — the two look alike and are not.
async function handlePortTest(ctx: OfficerContext): Promise<Response> {
if (ctx.req.method !== 'POST') return methodNotAllowed();
if (ctx.req.method !== 'GET') return methodNotAllowed();
const result = await rpc<{ 'port-is-open': boolean }>(ctx.userId, 'port-test');
return Response.json({ open: result['port-is-open'] });
}
@@ -282,7 +282,7 @@ export type AddServerInput = { label: string; url: string; username: string; pas
export type EditServerInput = { id: number; label?: string; url?: string; username?: string; password?: string };
export function useJellyfinServerActions() {
const { post, patch, delete: del } = useClient();
const { get, post, patch, delete: del } = useClient();
const qc = useQueryClient();
// Adding, editing, switching and removing all change what every other query here can even answer — a switch
// in particular changes the answer to all of them without changing any of their inputs.
@@ -309,11 +309,12 @@ export function useJellyfinServerActions() {
onSuccess: invalidate,
});
// GET — probes one server and reports whether it answered. It does not switch to it (that is
// `activate`) and writes nothing. useMutation is still right: it is fired by a button, not rendered.
const test = useMutation({
mutationFn: (id: number) =>
post<{ ok: boolean; version?: string | null; serverName?: string | null; ms: number }>(
get<{ ok: boolean; version?: string | null; serverName?: string | null; ms: number }>(
`/jellyfin/_config/${id}/test`,
{},
),
onSuccess: invalidate,
});
@@ -197,11 +197,14 @@ export function useTorrentMutations() {
}
export function useMaintenance() {
const { post } = useClient();
const { get, post } = useClient();
const qc = useQueryClient();
const portTest = useMutation({
mutationFn: () => post<{ open: boolean }>('/transmission/_officer/port-test'),
// GET — it asks the daemon a question and changes nothing on either side. Still a useMutation
// because it is fired by a button rather than rendered from cache: that is a UI concern, not an
// HTTP one. blocklistUpdate below stays POST, because it really does refetch and replace the list.
mutationFn: () => get<{ open: boolean }>('/transmission/_officer/port-test'),
onSuccess: (data) => (data.open ? toast.success('Peer port is open') : toast.error('Peer port is closed')),
onError: (err) => toast.error(errorMessage(err, 'Port test failed')),
});
@@ -55,11 +55,14 @@ export const useFilesAPI = (root: string = 'home') => {
client.get<DownloadVideoStatus>(withRoot(`/file-browser/download-video/${jobId}`)),
// Prefetch one video's metadata (ReClip /api/info via the platform proxy). Returns { error } inline.
videoInfo: (url: string) => client.post<VideoInfo>(withRoot('/file-browser/video-info'), { url }),
videoInfo: (url: string) =>
client.get<VideoInfo>(withRoot(`/file-browser/video-info?url=${encodeURIComponent(url)}`)),
// Expand a playlist URL into its individual video URLs (ReClip /api/playlist).
videoPlaylist: (url: string) =>
client.post<{ urls?: string[]; error?: string }>(withRoot('/file-browser/video-playlist'), { url }),
client.get<{ urls?: string[]; error?: string }>(
withRoot(`/file-browser/video-playlist?url=${encodeURIComponent(url)}`),
),
tts: (path: string, opts?: { saveNextTo?: boolean }) =>
client.post<{ audioPath: string; audioRoot: string }>('/file-browser/tts', { path, root, ...opts }),