heavy-duty/cast
7
0
Fork 0
Code Issues 4 Pull requests Projects Releases 3 Packages Wiki Activity Actions

Merge pull request #80 from claude-hdb/docs/draft-backup-api-honesty

Browse source 
docs(draft): correct stale "backup schedules not exposed by the API" claim (#72)
This commit is contained in:
Daniel Marin 2026-07-16 17:43:17 +02:00 committed by GitHub
commit 30c0b91709
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
src/draft.ts
View file

@ -585,13 +585,15 @@ function databaseSpec(
`image "${image}" — no version could be read from its tag, so none was written and \`apply\` would create this database on Coolify's default image.`,
);
}
// Coolify exposes no backup schedule on a database's GET, so a `backup:` block
// cannot be recovered. It is create-time-only in cast (see README's known
// limitations), so a rebuild from this draft would come up with NO BACKUPS —
// the quietest possible loss, and the one you discover at the worst moment.
// Coolify DOES expose a database's backup schedule — GET /databases/{uuid}/backups
// answers, and `diff`/`apply` read and write it (#51). What the DRAFT path cannot
// yet do is CAPTURE it: `inventory --emit-draft` does not read that route, so a
// `backup:` block is not recovered here. Until it is taught to, a rebuild from
// this draft still comes up with NO BACKUPS — the quietest possible loss, and the
// one you discover at the worst moment — unless the block is declared by hand.
flag(
"backup",
"backup schedules are not exposed by Coolify's API and are NOT in this draft. If this database is backed up, a rebuild from here would not be. Check the Coolify UI (Backups tab) and declare `backup: { frequency, retention }` yourself.",
"backup schedules are NOT in this draft — `inventory --emit-draft` does not yet read `GET /databases/{uuid}/backups` (which `diff` and `apply` do, #51). If this database is backed up, a rebuild from here would not be until you declare it. Read the schedule from a `cast diff` or the Coolify UI (Backups tab) and set `backup: { frequency, retention }` yourself.",
);
return { type, ...(version ? { version } : {}) };
}
@ -798,7 +800,7 @@ const NO_API_COVERAGE: Array<[string, string]> = [
],
[
"backup schedules",
"a database's backup config is not exposed on its GET. A rebuild from this draft has NO backups until you declare them.",
"the API exposes them (`GET /databases/{uuid}/backups`, which `diff`/`apply` use — #51), but `inventory --emit-draft` does not yet read that route, so no `backup:` block is captured. A rebuild from this draft has NO backups until you declare them.",
],
[
"database kinds cast does not model",

2
test/draft-cli.test.ts
View file

@ -352,7 +352,7 @@ describe("cast inventory --emit-draft (#27)", () => {
expect(md).toContain("destination_id 3");
expect(md).toContain("legacy-analytics"); // a MySQL cast cannot model
expect(md).toContain("custom_labels"); // Basic Auth / Traefik labels
expect(md).toContain("backup"); // not exposed by the API
expect(md).toContain("backup"); // API exposes it, draft doesn't capture it yet (#51)
expect(md).toContain("legacy.flag"); // not a name a template can hold
// And the standing sections, emitted on every run whatever was found: