Skip to content

Commit f55746d

Browse files
committed
docs(webapp): clarify reconfigure admin route's default vs retention paths
JSDoc referenced `v3.reconfigureStreamBasinForOrg` (a job that doesn't exist — the actual one is `v3.reconcileStreamBasinForOrg`) and didn't make clear that the default path runs the full reconciler, which can deprovision a basin if the org is now on a free plan. Spell that out so an operator hitting this route by hand isn't surprised.
1 parent b065509 commit f55746d

1 file changed

Lines changed: 14 additions & 10 deletions

File tree

apps/webapp/app/routes/admin.api.v1.stream-basins.reconfigure.ts

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,21 @@ import {
99
import { commonWorker } from "~/v3/commonWorker.server";
1010

1111
/**
12-
* Admin trigger for `v3.reconfigureStreamBasinForOrg`. The plan-change
13-
* path in `setPlan` enqueues this automatically when billing is wired;
14-
* this route exists for ops + e2e testing.
12+
* Admin trigger for stream-basin reconfiguration. The plan-change path
13+
* in `setPlan` enqueues the same reconcile job automatically when
14+
* billing is wired; this route exists for ops + e2e testing.
1515
*
16-
* - Default (`{ orgId }`): enqueues the worker job which resolves the
17-
* retention from the org's plan and PATCHes the basin to match.
18-
* No-op when billing isn't configured (OSS).
19-
* - With `retention`: bypasses the billing lookup and runs reconfigure
20-
* inline against the given duration string (e.g. `"7d"`, `"30d"`,
21-
* `"365d"`, `"1y"`). Useful for validating the PATCH wire shape
22-
* end-to-end and as a manual override (e.g. enterprise contracts).
16+
* - Default (`{ orgId }`): enqueues `v3.reconcileStreamBasinForOrg`,
17+
* the full reconciler. It resolves retention from the org's current
18+
* plan and either provisions, reconfigures, or deprovisions the basin
19+
* to match — including nulling `streamBasinName` if the org is now on
20+
* a free plan. No-op when billing isn't configured (OSS) or when
21+
* `REALTIME_STREAMS_PER_ORG_BASINS_ENABLED=false`.
22+
* - With `retention`: skips the worker queue and the reconciler entirely.
23+
* Calls `reconfigureBasinForOrg` inline with the given duration string
24+
* (e.g. `"7d"`, `"30d"`, `"365d"`, `"1y"`). Useful for validating the
25+
* PATCH wire shape end-to-end and as a manual override (e.g.
26+
* enterprise contracts) — does NOT touch the column or check the plan.
2327
*/
2428
const BodySchema = z
2529
.object({

0 commit comments

Comments
 (0)