Skip to content

fix(types): add missing title and summary fields to v3 ServerObject (#1137)#1148

Open
armorbreak001 wants to merge 1 commit intoasyncapi:masterfrom
armorbreak001:fix/v3-server-title-summary
Open

fix(types): add missing title and summary fields to v3 ServerObject (#1137)#1148
armorbreak001 wants to merge 1 commit intoasyncapi:masterfrom
armorbreak001:fix/v3-server-title-summary

Conversation

@armorbreak001
Copy link
Copy Markdown

Problem

Fixes #1137

The ServerObject type in spec-types/v3.ts is missing the optional title and summary fields 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 ServerObject interface:

export interface ServerObject extends SpecificationExtensions {
  host: string;
  protocol: string;
+ title?: string;
+ summary?: string;
  pathname?: string;
  ...
}

Note: Other v3 objects like ChannelObject, OperationObject, and InfoObject already have these fields — only ServerObject was 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 master branch.

…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.
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 22, 2026

⚠️ No Changeset found

Latest commit: 541e3da

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

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