From 2e0d30dd96aeb2fef50965d039179191f4e5be88 Mon Sep 17 00:00:00 2001 From: caballeto Date: Tue, 5 May 2026 19:45:03 +0200 Subject: [PATCH] docs(README): add managedBy to monitors.create example MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index e4a6d6d..f8d5c69 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,11 @@ monitor = client.monitors.create({ "config": {"url": "https://api.example.com/health", "method": "GET"}, "frequencySeconds": 60, "regions": ["us-east"], + # `managedBy` records who reconciles drift on this resource. Use + # "DASHBOARD" (the default for one-off SDK scripts), "CLI" if the + # monitor lives in a `devhelm.yml` you re-deploy, or "TERRAFORM" + # if it lives in `.tf` you re-apply. + "managedBy": "DASHBOARD", }) # Get a single monitor