Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[BUG] Missing server.summary() function #1076

Open
2 tasks done
fmvilas opened this issue Jan 24, 2025 · 3 comments · May be fixed by #1077 or #1080
Open
2 tasks done

[BUG] Missing server.summary() function #1076

fmvilas opened this issue Jan 24, 2025 · 3 comments · May be fixed by #1077 or #1080
Labels
bug Something isn't working good first issue Good for newcomers

Comments

@fmvilas
Copy link
Member

fmvilas commented Jan 24, 2025

Describe the bug.

The Server Object doesn't have a way to access the summary attribute of a server.

Expected behavior

We should have a function called .summary() in the Server Object.

Screenshots

Not relevant

How to Reproduce

Not relevant

🥦 Browser

None

👀 Have you checked for similar open issues?

  • I checked and didn't find similar issue

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue ?

No, someone else can work on it
@fmvilas fmvilas added bug Something isn't working good first issue Good for newcomers labels Jan 24, 2025
@fmvilas fmvilas mentioned this issue Jan 24, 2025
Open
2 tasks
@shwetd19 shwetd19 linked a pull request Jan 24, 2025 that will close this issue
Open
@shwetd19
Copy link

@fmvilas can you please review my PR nd lmk if any changes are required
#1077

@smoya
Copy link
Member

smoya commented Jan 31, 2025

A small note here confirming the Parser-API is actually supporting that, so indeed this is a bug on this implementation 👍

https://github.com/asyncapi/parser-api/blob/master/docs/api.md#server

AlexiusTatius added a commit to AlexiusTatius/parser-js that referenced this issue Jan 31, 2025
@AlexiusTatius
Fix asyncapi#1076: Added server.summary() hasSummary() functions
711e6e0 
- summary(): Returns the server summary string or undefined
- hasSummary(): Returns boolean indicating if summary exists
- Added unit tests for the respective functions
- Tested the code by building, ensuring changes in esm, cjs
@AlexiusTatius AlexiusTatius linked a pull request Jan 31, 2025 that will close this issue
Open
@AlexiusTatius
Copy link

Hey, @smoya @fmvilas could you review my PR? I've made some extra changes and added the unit tests along with it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
4 participants
@fmvilas @smoya @AlexiusTatius @shwetd19