fix(types): add missing title and summary fields to v3 ServerObject (#1137)#1148
Open
armorbreak001 wants to merge 1 commit intoasyncapi:masterfrom
Open
fix(types): add missing title and summary fields to v3 ServerObject (#1137)#1148armorbreak001 wants to merge 1 commit intoasyncapi:masterfrom
armorbreak001 wants to merge 1 commit intoasyncapi:masterfrom
Conversation
…syncapi#1137) According to the AsyncAPI 3.0.0 specification, the Server Object should include optional 'title' and 'summary' string fields: https://www.asyncapi.com/docs/reference/specification/v3.0.0#serverObject These were missing from the TypeScript type definition, causing type errors when parsing valid AsyncAPI 3.0 documents that include these fields.
|
|
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.



Problem
Fixes #1137
The
ServerObjecttype inspec-types/v3.tsis missing the optionaltitleandsummaryfields defined in the AsyncAPI 3.0.0 specification.This causes TypeScript type errors when parsing valid AsyncAPI 3.0 documents that include these fields.
Fix
Add two optional string fields to the
ServerObjectinterface:Note: Other v3 objects like
ChannelObject,OperationObject, andInfoObjectalready have these fields — onlyServerObjectwas missing them.Testing
Local tests cannot run due to an environment issue (Node/Jest compatibility) — confirmed that the same test failure occurs on the unmodified
masterbranch.