Skip to content

Commit 2e0d30d

Browse files
docs(README): add managedBy to monitors.create example
The Quick Start example omitted the `managedBy` field, which the API requires. Every fresh user copying the snippet from PyPI got `DevhelmValidationError: managedBy: Field required` on their first SDK call (verified by a fresh-user devex agent run against prod). Adds `"managedBy": "DASHBOARD"` with an inline explainer comment so users understand what the field means and when to override it. Mirrors the same fix being shipped to docs.devhelm.io and to the TypeScript SDK README. The cleaner long-term answer is server-side defaulting from the X-DevHelm-Surface header — tracked separately. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 731bbb7 commit 2e0d30d

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ monitor = client.monitors.create({
3131
"config": {"url": "https://api.example.com/health", "method": "GET"},
3232
"frequencySeconds": 60,
3333
"regions": ["us-east"],
34+
# `managedBy` records who reconciles drift on this resource. Use
35+
# "DASHBOARD" (the default for one-off SDK scripts), "CLI" if the
36+
# monitor lives in a `devhelm.yml` you re-deploy, or "TERRAFORM"
37+
# if it lives in `.tf` you re-apply.
38+
"managedBy": "DASHBOARD",
3439
})
3540

3641
# Get a single monitor

0 commit comments

Comments
 (0)