Skip to content

Commit 1114d54

Browse files
committed
docs(spec): regenerate reference pages for the webhook ADR-0010 envelope
`gen:docs` only — the property tables for `automation/Webhook` and the `integration/WebhookConfig` extension gain the `protection` block and the seven `_lock*`/`_provenance`/`_package*` rows. Checked for the #3746 trap: no page description or frontmatter moved, so no internal comment leaked onto a public reference page. Part of #4001 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Ehu85kbvMcrNTUJjwxvLJ9
1 parent 58a511a commit 1114d54

2 files changed

Lines changed: 16 additions & 0 deletions

File tree

content/docs/references/automation/webhook.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,14 @@ const result = WebhookSchema.parse(data);
9292
| **secret** | `string` | optional | Signing secret for HMAC signature verification |
9393
| **isActive** | `boolean` || Whether webhook is active |
9494
| **description** | `string` | optional | Webhook description |
95+
| **protection** | `{ lock: Enum<'none' \| 'no-overlay' \| 'no-delete' \| 'full'>; reason: string; docsUrl?: string }` | optional | Package author protection block — lock policy for this webhook. |
96+
| **_lock** | `Enum<'none' \| 'no-overlay' \| 'no-delete' \| 'full'>` | optional | Item-level lock — controls overlay & delete (ADR-0010). |
97+
| **_lockReason** | `string` | optional | Human-readable reason shown when a write is refused by _lock. |
98+
| **_lockSource** | `Enum<'artifact' \| 'package' \| 'env-forced'>` | optional | Layer that set _lock (artifact \| package \| env-forced). |
99+
| **_provenance** | `Enum<'package' \| 'org' \| 'env-forced'>` | optional | Origin of the item (package \| org \| env-forced). |
100+
| **_packageId** | `string` | optional | Owning package machine id. |
101+
| **_packageVersion** | `string` | optional | Owning package version. |
102+
| **_lockDocsUrl** | `string` | optional | Optional documentation link surfaced next to _lockReason. |
95103

96104

97105
---

content/docs/references/integration/connector.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -517,6 +517,14 @@ Synchronization strategy
517517
| **secret** | `string` | optional | Signing secret for HMAC signature verification |
518518
| **isActive** | `boolean` || Whether webhook is active |
519519
| **description** | `string` | optional | Webhook description |
520+
| **protection** | `{ lock: Enum<'none' \| 'no-overlay' \| 'no-delete' \| 'full'>; reason: string; docsUrl?: string }` | optional | Package author protection block — lock policy for this webhook. |
521+
| **_lock** | `Enum<'none' \| 'no-overlay' \| 'no-delete' \| 'full'>` | optional | Item-level lock — controls overlay & delete (ADR-0010). |
522+
| **_lockReason** | `string` | optional | Human-readable reason shown when a write is refused by _lock. |
523+
| **_lockSource** | `Enum<'artifact' \| 'package' \| 'env-forced'>` | optional | Layer that set _lock (artifact \| package \| env-forced). |
524+
| **_provenance** | `Enum<'package' \| 'org' \| 'env-forced'>` | optional | Origin of the item (package \| org \| env-forced). |
525+
| **_packageId** | `string` | optional | Owning package machine id. |
526+
| **_packageVersion** | `string` | optional | Owning package version. |
527+
| **_lockDocsUrl** | `string` | optional | Optional documentation link surfaced next to _lockReason. |
520528
| **events** | `Enum<'record.created' \| 'record.updated' \| 'record.deleted' \| 'sync.started' \| 'sync.completed' \| 'sync.failed' \| 'auth.expired' \| 'rate_limit.exceeded'>[]` | optional | Connector events to subscribe to (not yet enforced — no runtime dispatches these; see #3197) |
521529
| **signatureAlgorithm** | `Enum<'hmac_sha256' \| 'hmac_sha512' \| 'none'>` || Webhook signature algorithm |
522530

0 commit comments

Comments
 (0)