@W-23748894 feat(webhooks): render OAS 3.1/3.2 top-level webhooks in a dedicated section - #82
Merged
Conversation
alexpmule
force-pushed
the
W-23748894-webhooks
branch
2 times, most recently
from
August 19, 2026 18:28
1176ee4 to
8c9af67
Compare
…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>
…olver The top-level webhooks resolver (_computeWebhooks + apiContract#webhooks namespace key) ships in amf-helper-mixin 4.5.38. Below that floor the webhooks collection resolves empty and the feature silently no-ops. Regenerate the lockfile so CI installs 4.5.38.
alexpmule
force-pushed
the
W-23748894-webhooks
branch
from
August 20, 2026 00:47
8c9af67 to
9d411c3
Compare
TypeScript checkJs infers instance properties from `this.x =` assignments in the .js, not from the .d.ts. webhooksOpened was only ever read (never assigned), so tsc reported ts(2339) 'Property webhooksOpened does not exist on type ApiNavigation' at the template usages. Initialize it to false alongside the other boolean flags, matching endpointsOpened.
The demo had no API exercising top-level webhooks, so the Webhooks nav section was never visible when previewing the component. Add the OAS 3.1 webhooks fixture (reused from api-type-document) as a selectable demo API, whitelisting the generated models in .gitignore like grpc-test. Also add a smoke test that loads the generated model (compact + full) and asserts the Webhooks section renders — closing the P2 gap where no test consumed the real generated `apiContract#webhooks` predicate.
alexpmule
marked this pull request as ready for review
August 20, 2026 13:09
…nerator to 0.4.0 Bump @api-components/api-model-generator ^0.2.14 -> ^0.4.0 so the demo/test models are generated from the in-repo OAS 3.1 spec (amf-client-js 5.11 supports OAS 3.1/3.2; 4.7.x did not). Rework test/webhooks.test.js to load the generated oas31-webhooks model via AmfLoader instead of hand-building AMF inline. Add @graph-aware expansion to test/amf-loader.js (amf-client-js 5.11 emits flattened @graph models). Stop committing the generated model: drop the .gitignore whitelist and untrack demo/oas31-webhooks(.compact).json (now prepare artifacts). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
spezzirriemiliano
approved these changes
Aug 20, 2026
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
2 participants
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.38 (published), 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
The resolver (
_computeWebhooks+ theapiContract#webhooksnamespace key) ships inamf-helper-mixin4.5.38 (now published). This PR raises the peer floor to^4.5.38and regenerates the lockfile so CI installs it. Below 4.5.38 the resolver does not exist and the feature silently no-ops with no error/log/metric.Tests
Green in chromium + firefox. Inline AMF expanded-model fixtures. Webhooks suite verified green against the real published mixin 4.5.38 (6/6).
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.Result tested: