@W-23748894 feat(webhooks): render OAS 3.1/3.2 top-level webhooks in a dedicated section - #82
Draft
alexpmule wants to merge 1 commit into
Draft
@W-23748894 feat(webhooks): render OAS 3.1/3.2 top-level webhooks in a dedicated section#82alexpmule wants to merge 1 commit into
alexpmule wants to merge 1 commit into
Conversation
…section Top-level webhooks (OAS 3.1/3.2) now render in their own "Webhooks" nav section, sibling to "Endpoints". A webhook compiles to an apiContract#EndPoint node identical to a regular endpoint; the only distinction is the WebAPI root references it via apiContract#webhooks. _traverseWebhooks routes those nodes into a distinct `webhooks` collection via a collectionKey param on _appendEndpointItem, so they never leak into the Endpoints list. The label defaults to the event name (path, renderPath=false) since a webhook has no core#name. Query filtering is shared with endpoints via _filterEndpointItems. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
alexpmule
force-pushed
the
W-23748894-webhooks
branch
from
August 18, 2026 22:16
eebe3aa to
1176ee4
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@W-23748894
What
Renders OAS 3.1/3.2 top-level webhooks as first-class documentation.
Part of the webhooks feature for TD-0333486. Depends on
@api-components/amf-helper-mixin>= 4.5.36 (PRW-23748894-webhookson that repo), which resolves top-levelapiContract#webhooksvia an additive fallback.Per-repo behavior:
Why
Webhooks are top-level in OAS 3.1/3.2 (not under
paths). AC4: webhooks must render as their own first-class section with Try-It suppressed.Dependency / publish gate
Ship the mixin (4.5.36) first, then raise the peer floor to
^4.5.36here. Below 4.5.36 the resolver fallback does not exist and the feature silently no-ops with no error/log/metric.Tests
Green in chromium + firefox. Inline AMF expanded-model fixtures.
Known QA notes (P2, non-blocking, tracked for the PR discussion)
.actionDOM-absence assertion.apiContract#webhookspredicate would pass GREEN and break prod. A smoke test against a real compact model (at least in nav) is recommended.Scope
Draft for review.