devhelm 0.1.2__tar.gz → 0.2.0__tar.gz

{devhelm-0.1.2 → devhelm-0.2.0}/.github/workflows/spec-check.yml

@@ -23,7 +23,7 @@ jobs:
 
       - name: Download latest OpenAPI spec from monorepo
         run: |
-          gh api repos/devhelmhq/mono/contents/docs/openapi/monitoring-api.yaml \
+          gh api repos/devhelmhq/mono/contents/docs/openapi/monitoring-api.json \
             -H "Accept: application/vnd.github.raw+json" \
             -o docs/openapi/monitoring-api.json
         env:

{devhelm-0.1.2 → devhelm-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devhelm
-Version: 0.1.2
+Version: 0.2.0
 Summary: DevHelm SDK for Python — typed client for monitors, incidents, alerting, and more
 Project-URL: Homepage, https://github.com/devhelmhq/sdk-python
 Project-URL: Repository, https://github.com/devhelmhq/sdk-python.git
@@ -132,21 +132,38 @@ print(results.has_more)
 
 ## Error Handling
 
+The SDK raises three top-level error types (see
+[`040-codegen-policies.md`](https://github.com/devhelmhq/mono/blob/main/cowork/design/040-codegen-policies.md)):
+
+- `DevhelmValidationError` — local request/response shape validation failed.
+- `DevhelmApiError` — the API returned a non-2xx status. Subclassed by HTTP
+  class for ergonomics: `DevhelmAuthError` (401/403), `DevhelmNotFoundError`
+  (404), `DevhelmConflictError` (409), `DevhelmRateLimitError` (429),
+  `DevhelmServerError` (5xx).
+- `DevhelmTransportError` — the request never reached a server response
+  (connection refused, timeout, TLS failure, etc.).
+
+Every `DevhelmApiError` carries:
+
+- `status` — the HTTP status code
+- `code` — coarse machine-readable category (e.g. `NOT_FOUND`,
+  `RATE_LIMITED`); switch on this, not the human-readable `message`
+- `request_id` — the per-request id from the `X-Request-Id` response header;
+  always include this in support tickets
+
 ```python
-from devhelm import Devhelm, DevhelmError, AuthError
+from devhelm import Devhelm, DevhelmAuthError, DevhelmError
 
 client = Devhelm(token="bad-token", org_id="1", workspace_id="1")
 
 try:
     client.monitors.list()
-except AuthError as e:
-    print(f"Auth failed: {e.message} (HTTP {e.status})")
+except DevhelmAuthError as e:
+    print(f"Auth failed: {e.message} (HTTP {e.status}, request_id={e.request_id})")
 except DevhelmError as e:
     print(f"API error [{e.code}]: {e.message}")
 ```
 
-Error codes: `AUTH`, `NOT_FOUND`, `CONFLICT`, `VALIDATION`, `API`.
-
 ## Development
 
 ```bash

{devhelm-0.1.2 → devhelm-0.2.0}/README.md

@@ -108,21 +108,38 @@ print(results.has_more)
 
 ## Error Handling
 
+The SDK raises three top-level error types (see
+[`040-codegen-policies.md`](https://github.com/devhelmhq/mono/blob/main/cowork/design/040-codegen-policies.md)):
+
+- `DevhelmValidationError` — local request/response shape validation failed.
+- `DevhelmApiError` — the API returned a non-2xx status. Subclassed by HTTP
+  class for ergonomics: `DevhelmAuthError` (401/403), `DevhelmNotFoundError`
+  (404), `DevhelmConflictError` (409), `DevhelmRateLimitError` (429),
+  `DevhelmServerError` (5xx).
+- `DevhelmTransportError` — the request never reached a server response
+  (connection refused, timeout, TLS failure, etc.).
+
+Every `DevhelmApiError` carries:
+
+- `status` — the HTTP status code
+- `code` — coarse machine-readable category (e.g. `NOT_FOUND`,
+  `RATE_LIMITED`); switch on this, not the human-readable `message`
+- `request_id` — the per-request id from the `X-Request-Id` response header;
+  always include this in support tickets
+
 ```python
-from devhelm import Devhelm, DevhelmError, AuthError
+from devhelm import Devhelm, DevhelmAuthError, DevhelmError
 
 client = Devhelm(token="bad-token", org_id="1", workspace_id="1")
 
 try:
     client.monitors.list()
-except AuthError as e:
-    print(f"Auth failed: {e.message} (HTTP {e.status})")
+except DevhelmAuthError as e:
+    print(f"Auth failed: {e.message} (HTTP {e.status}, request_id={e.request_id})")
 except DevhelmError as e:
     print(f"API error [{e.code}]: {e.message}")
 ```
 
-Error codes: `AUTH`, `NOT_FOUND`, `CONFLICT`, `VALIDATION`, `API`.
-
 ## Development
 
 ```bash