@W-23748894 feat: dedicated Webhooks section on API Summary - #63
Merged
Merged
Conversation
Render OAS 3.1/3.2 top-level webhooks in their own Webhooks table-of-contents section, separate from endpoints, so consumers can distinguish event-driven callbacks from request/response operations. Webhooks are apiContract#EndPoint nodes sharing the endpoint view-model shape, so the existing endpoint template is reused. Includes an OAS 3.1 demo fixture and rendering tests. W-23748894
The Webhooks section reads the apiContract#webhooks namespace vocabulary term, added to amf-helper-mixin in 4.5.38; 4.5.36 lacks it and the section would silently render nothing under a clean install. Aligns the floor and lockfile with api-navigation, the other webhooks consumer. W-23748894
alexpmule
force-pushed
the
W-23748894-summary-webhooks
branch
from
August 26, 2026 12:33
6a0d29d to
cc5d6dd
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.
What
Adds a dedicated Webhooks section to the API Summary page's table of
contents, rendering OAS 3.1/3.2 top-level
webhooksseparately from endpoints.Why
Part of TD-0333486 (OAS 3.1/3.2 API Console support) — the third and final
component fix. The summary page previously listed only endpoints; top-level
webhooks (event-driven callbacks) were not surfaced at all. Users viewing an
OAS 3.1/3.2 API summary now see webhooks in their own labelled section,
distinct from request/response endpoints.
How
_computeWebhooks(webApi)reads theapiContract#webhooksvocabulary term(an array of
apiContract#EndPointnodes) and builds the same view-modelshape already used for endpoints.
_webhooksTemplate()renders a separate "Webhooks" TOC section, reusing theexisting
_endpointTemplate— webhooks are byte-identicalEndPointnodes,and the mixin resolves navigation selection by
@id, so no new shape type isneeded.
Styles.js: the.webhooks-titlelabel shares the existing endpoints-titlestyling.
ApiSummary.d.ts: type declarations for the new members (hand-maintained).chore(deps): raises theamf-helper-mixinfloor to^4.5.38(and thelockfile). The
apiContract#webhooksvocabulary term was added in 4.5.38;4.5.36 lacks it and the section would silently render nothing on a clean
install. Matches api-navigation, the other webhooks consumer.
Testing
Webhooks rendering (OAS 3.1)test block (6 tests) against a new demofixture
demo/oas31-webhooks/oas31-webhooks.yaml.npm run lint/lint:types: no new issues (only pre-existing errors inuntouched files —
karma.conf.js,test/amf-loader.js, and gRPC-merge linesin
ApiSummary.js/api-summary.test.js).Related
Screenshots