Skip to content

fix(parser): add missing title and summary fields to v3 ServerObject#1147

Closed
armorbreak001 wants to merge 1 commit into
asyncapi:masterfrom
armorbreak001:fix/v3-server-title-summary-fields
Closed

fix(parser): add missing title and summary fields to v3 ServerObject#1147
armorbreak001 wants to merge 1 commit into
asyncapi:masterfrom
armorbreak001:fix/v3-server-title-summary-fields

Conversation

@armorbreak001

Copy link
Copy Markdown

Problem

The AsyncAPI 3.0.0 specification defines optional title and summary fields on the Server Object, but these fields were missing from the TypeScript type definition in packages/parser/src/spec-types/v3.ts.

This means users cannot properly type server objects that include these standard fields.

Solution

Add title?: string and summary?: string to the ServerObject interface in v3.ts, matching the official specification.

Changes

  • packages/parser/src/spec-types/v3.ts: Added 2 optional string fields to ServerObject
    • title?: string;
    • summary?: string;

Fixes #1138

Fixes asyncapi#1137

The AsyncAPI 3.0.0 spec defines optional  and  fields
on the Server Object (https://www.asyncapi.com/docs/reference/specification/v3.0.0#serverObject),
but these were missing from the TypeScript types.
@changeset-bot

changeset-bot Bot commented Apr 18, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: cb0752a

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

@sonarqubecloud

Copy link
Copy Markdown

@armorbreak001

Copy link
Copy Markdown
Author

Closing to free up PR queue — will resubmit if still relevant.

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.

1 participant