chore(deps): bump amf-client-js + api-model-generator for OAS 3.1/3.2 (TD-0333486) - #905
Draft
alexpmule wants to merge 1 commit into
Draft
chore(deps): bump amf-client-js + api-model-generator for OAS 3.1/3.2 (TD-0333486)#905alexpmule wants to merge 1 commit into
alexpmule wants to merge 1 commit into
Conversation
Bump amf-client-js ^5.4.4 -> ^5.11.7902 and @api-components/api-model-generator ^0.2.14 -> ^0.3.1 so the console's model-generation path runs on an AMF line that understands OAS 3.1 (webhooks, if/then/else) and OAS 3.2 (QUERY, SSE). The generator was pinned to a nested amf-client-js 4.7.8 that predates OAS 3.1/3.2 support; without bumping it, generating 3.1/3.2 fixtures fails. This is the enabling dependency step for TD-0333486 (rendering work lands separately). Verified: rollup build succeeds; AMF 5.11.x parses 3.1/3.2 specs and emits webhooks as a `webhooks` collection of EndPoint nodes (sibling to `endpoint`), plus QUERY method and text/event-stream SSE. TD-0333486
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
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
Bump the two dependencies on the console's model-generation path so it runs on an AMF line that supports OAS 3.1 and 3.2:
amf-client-js^5.4.4→^5.11.7902@api-components/api-model-generator^0.2.14→^0.3.1Why
Enabling step for TD-0333486 (render OAS 3.1/3.2 in the console). The rendering work lands in follow-up PRs; this PR only moves the dependency floor so fixtures for the new constructs can be generated at all.
The generator was pinned to a nested
amf-client-js@4.7.8that predates OAS 3.1/3.2. Bumpingamf-client-jsalone is cosmetic — the fixture path (demo/model.js→api-model-generator) kept resolving 4.7.8. Bumping the generator to0.3.1(which depends onamf-client-js@^5.10.2) is what actually dedupes the fixture path onto the 5.11.x line.Verification
npm run build(rollup) succeeds with the bumped deps.conforms: true).apiContract#webhookscollection ofEndPointnodes — a sibling toapiContract#endpoint, same node type as REST endpoints (not a separate API type). A webhook'spathis a name (newPet), not a served URL.method: QUERY).text/event-stream+itemSchema).Follow-ups (not in this PR)
api-model-generatorneeds code, not just a bump. ItsgetConfigurationswitch stops atOAS 3.0and throwsUnknown API type: OAS 3.1/3.2, even though the underlyingamf-client-jsexposesOASConfiguration.OAS31()/OAS32(). Adding those cases is a separate change in that (ACM-owned) package.apiContract#endpoint, so thewebhookscollection is silently dropped today. Rendering webhooks = read the collection + surface it (section vs. badge — product decision) + suppress try-it (gRPC precedent).Notes
amf-client-js@4.7.8remains under@api-components/api-summary's own nestedapi-model-generator@0.2.14(transitive devDep). It is not on the fixture/runtime path; left untouched to avoid forcing a transitive without vendor validation.5.11.7902is a snapshot/RC line (the stablelatestis5.10.2-10, no OAS 3.2). Consuming it pins a pre-release — acceptable for the spike/enabling step; revisit if a GA lands.TD-0333486