Skip to content

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

Open
q404365631 wants to merge 1 commit into
asyncapi:masterfrom
q404365631:fix/server-object-missing-title-summary
Open

fix: add missing title and summary fields to ServerObject type#1172
q404365631 wants to merge 1 commit 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
Copy link
Copy Markdown

changeset-bot Bot commented Jun 1, 2026

⚠️ No Changeset found

Latest commit: 4cc588d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

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.

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Jun 1, 2026

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

1 participant