docs: add missing title property to webhook API schemas#2249
docs: add missing title property to webhook API schemas#2249marcel-rbro wants to merge 1 commit intomasterfrom
Conversation
Closes #2035 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Preview for this PR was built for commit |
marcel-rbro
left a comment
There was a problem hiding this comment.
Review: LGTM
The change correctly adds the missing title property to all three relevant webhook OpenAPI schemas.
What looks good
-
Pattern consistency: The
titleproperty definition (type: [string, "null"]withexamples) exactly matches the pattern used by the adjacentdescriptionproperty in all three files. Good adherence to existing conventions. -
Cross-schema consistency: The definition is identical across
Webhook.yaml,WebhookCreate.yaml, andWebhookUpdate.yaml, which is correct since they should all support the sametitlefield. -
Logical placement:
titleis placed immediately beforedescriptionin each schema, which is a natural grouping. -
Example value:
Actor run succeeded webhookis appropriate - it matches theACTOR.RUN.SUCCEEDEDevent type used in other examples in the same files, making the schema self-consistent. -
All CI checks pass: Lint, spec validation, bundled spec build, docs build, and spell check all green.
Considered but not an issue
I checked whether WebhookShort.yaml (used by the list webhooks endpoint via ListOfWebhooks.yaml) also needs title. It does not - WebhookShort already omits description, payloadTemplate, and headersTemplate, so omitting title is consistent with the "short" representation pattern.
No changes requested. This is a clean, minimal fix that addresses issue #2035.
Summary
titleproperty toWebhookCreate,WebhookUpdate, andWebhookOpenAPI schemastitlefield on webhooks, but it was not documented in the OpenAPI specCloses #2035
Test plan
titleproperty in rendered API docsGenerated with Claude Code