Skip to content

fix: add missing title and summary fields to ServerObject type#1172

Closed
q404365631 wants to merge 2 commits into
asyncapi:masterfrom
q404365631:fix/server-object-missing-title-summary
Closed

fix: add missing title and summary fields to ServerObject type#1172
q404365631 wants to merge 2 commits into
asyncapi:masterfrom
q404365631:fix/server-object-missing-title-summary

Conversation

@q404365631

Copy link
Copy Markdown

Description

The AsyncAPI 3.0 specification defines title and summary as optional fields in the ServerObject, but the parser-js TypeScript type definition was missing these fields.

Changes

  • Added title?: string field to ServerObject in packages/parser/src/spec-types/v3.ts
  • Added summary?: string field to ServerObject in packages/parser/src/spec-types/v3.ts

Related Issue

Fixes #1137

Reference

Per the AsyncAPI 3.0.0 Specification - Server Object:

Field Name Type Description
title string A human-friendly title for the server.
summary string A short summary of what the server is.

Testing

  • This is a backward-compatible change (adding optional fields)
  • No existing code is affected
  • The new fields align with the AsyncAPI 3.0 specification

MICROGRANT

This PR resolves issue #1137 which is part of the MICROGRANT Program 2026-06.

…types

Fixes asyncapi#1137

The AsyncAPI 3.0 specification defines `title` and `summary` as optional
fields in the ServerObject, but the parser-js TypeScript type definition
was missing these fields.

Reference: https://www.asyncapi.com/docs/reference/specification/v3.0.0#serverObject
@changeset-bot

changeset-bot Bot commented Jun 1, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 0c448ae

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@asyncapi/parser Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@q404365631

Copy link
Copy Markdown
Author

Hi maintainers! 👋 This PR has been open for a few days. It adds the missing title and summary fields to the ServerObject type definition. Could someone please review? Happy to make any changes needed. Thanks!

@AayushSaini101

Copy link
Copy Markdown
Collaborator

Closing this PR as this is alraady assigned to someone else thanks

@sonarqubecloud

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] Absent fields 'title' and 'summary' for AsyncAPI 3.0

2 participants