fix: expose server summary() on ServerInterface for v3 documents#1199
Open
AayushSaini101 wants to merge 1 commit into
Open
fix: expose server summary() on ServerInterface for v3 documents#1199AayushSaini101 wants to merge 1 commit into
AayushSaini101 wants to merge 1 commit into
Conversation
|
|
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.



Summary
Fixes #1076 by exposing
server.summary()andserver.hasSummary()on theshared
ServerInterface, with v3 test coverage.Problem
AsyncAPI v3 defines an optional
summaryfield on the Server Object, and thev3
Servermodel already reads it viaCoreModel. However,ServerInterfacedid not include
summary(), so TypeScript users accessing servers throughdocument.allServers()did not get proper type support for this method.Why only
ServerInterfaceneeded to changeNo changes to the v3
Serverclass were required because:ServerextendsCoreModel, which already implementshasSummary()andsummary()ServerInterface)Why v2 was not changed
summary(onlydescription,url,protocol, etc.)summarySummaryMixinInterfacewould force stub methods on v2ServerPartial<SummaryMixinInterface>was used so:summary()as expectedpackages/parser/src/models/server.tsneeded a production code changeChanges
server.ts: extendServerInterfacewithPartial<SummaryMixinInterface>server.spec.ts(v3): unit tests for.summary()and absent summaryasyncapi.spec.ts(v3): testallServers()exposessummaryparse.spec.ts: integration test for v3allServers().summary()Test plan
allServers()test passesparse()integration test passes