Skip to content

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

Open
kas-storksoft wants to merge 1 commit intoasyncapi:masterfrom
kas-storksoft:fix-server-object-types
Open

fix: add missing title and summary fields to ServerObject v3 type#1141
kas-storksoft wants to merge 1 commit intoasyncapi:masterfrom
kas-storksoft:fix-server-object-types

Conversation

@kas-storksoft
Copy link
Copy Markdown

Description

Adds the missing optional title and summary fields to the ServerObject interface in the v3 spec types.

Per the AsyncAPI 3.0 specification, the Server Object supports both title ("A human-friendly title for the server") and summary ("A brief summary of the server") fields. These were already defined in the 3.0.0 JSON Schema and present in other similar objects (ChannelObject, OperationObject) but were inadvertently omitted from ServerObject.

Changes

  • Added title?: string to ServerObject interface
  • Added summary?: string to ServerObject interface

Fixes #1137

Related issue(s)

#1137

Add optional 'title' and 'summary' fields to the ServerObject interface
in v3 spec types, aligning with the AsyncAPI 3.0 specification which
defines these fields for the Server Object.

The fields were already present in ChannelObject and OperationObject
but were inadvertently omitted from ServerObject.

Fixes asyncapi#1137

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 4, 2026

⚠️ No Changeset found

Latest commit: 675ab55

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

sonarqubecloud bot commented Apr 4, 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