feat: extend node types with description #2488

DmitryAnansky · 2026-01-06T15:35:31Z

What/Why/How?

Extended NodeTypes with description and documentationLink properties for:

oas2
oas3
oas3_1
oas3_2
overlay
openrpc
asyncapi2
asyncapi3
arazzo

This update is used in diagnostic onHover feature..

Reference

Closes Redocly/redocly-vs-code#74
Closes https://github.com/Redocly/redocly/issues/8437
Closes https://github.com/Redocly/redocly/issues/14116

Testing

Screenshots (optional)

Check yourself

Code changed? - Tested with Redoc/Realm/Reunite (internal)
All new/updated code is covered by tests
New package installed? - Tested in different environments (browser/node)
Documentation update considered

Security

The security impact of the change has been considered
Code follows company security practices and guidelines

changeset-bot · 2026-01-06T15:35:35Z

🦋 Changeset detected

Latest commit: 723ae87

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

This PR includes changesets to release 3 packages

Name	Type
@redocly/openapi-core	Patch
@redocly/cli	Patch
@redocly/respect-core	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 · 2026-01-06T15:37:39Z

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	78.67% (🎯 78%)	6128 / 7789
🔵	Statements	78.1% (🎯 78%)	6332 / 8107
🔵	Functions	82.18% (🎯 82%)	1246 / 1516
🔵	Branches	70.5% (🎯 70%)	4221 / 5987

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
packages/core/src/types/arazzo.ts	100%	100%	100%	100%
packages/core/src/types/asyncapi2.ts	95.78%	50%	85.71%	95.78%	60-80, 679-681, 687, 695-697, 703
packages/core/src/types/asyncapi3.ts	52.63%	14.28%	25%	52.63%	184-190, 257-265, 488-516
packages/core/src/types/index.ts	97.29%	92.85%	100%	97.29%	136
packages/core/src/types/oas3.ts	75.36%	31.81%	66.66%	75.36%	616, 623, 758-761, 821-845
packages/core/src/types/oas3_1.ts	51.16%	25%	75%	51.16%	160, 167, 176, 209, 228-280
packages/core/src/types/oas3_2.ts	55.55%	0%	0%	55.55%	67-154
packages/core/src/types/openrpc.ts	100%	100%	100%	100%
packages/core/src/types/overlay.ts	100%	100%	100%	100%
packages/core/src/types/redocly-yaml.ts	92.3%	82.85%	100%	91.93%	364-371, 373, 518-523, 526-531, 534-539

Generated in workflow #8455 for commit 723ae87 by the Vitest Coverage Report Action

github-actions · 2026-01-06T15:37:49Z

CLI Version	Mean Time ± Std Dev (s)	Relative Performance (Lower is Faster)
cli-latest	3.654s ± 0.026s	▓ 1.01x
cli-next	3.629s ± 0.043s	▓ 1.00x (Fastest)

github-actions · 2026-01-06T15:38:59Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1767713938 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1767713938
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1767713938
# or
npm install @redocly/respect-core@0.0.0-snapshot.1767713938

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-01-06T19:18:21Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1767727100 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1767727100
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1767727100
# or
npm install @redocly/respect-core@0.0.0-snapshot.1767727100

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-01-07T10:16:29Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1767780988 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1767780988
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1767780988
# or
npm install @redocly/respect-core@0.0.0-snapshot.1767780988

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-01-07T16:05:36Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1767801935 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1767801935
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1767801935
# or
npm install @redocly/respect-core@0.0.0-snapshot.1767801935

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-01-14T16:50:27Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1768409426 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1768409426
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1768409426
# or
npm install @redocly/respect-core@0.0.0-snapshot.1768409426

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-01-20T08:08:00Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1768896479 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1768896479
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1768896479
# or
npm install @redocly/respect-core@0.0.0-snapshot.1768896479

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-01-20T18:27:32Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1768933651 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1768933651
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1768933651
# or
npm install @redocly/respect-core@0.0.0-snapshot.1768933651

⚠️ Note: This is a development build and may contain unstable features.

packages/core/src/types/redocly-yaml.ts

.changeset/lovely-mice-slide.md

packages/core/src/types/redocly-yaml.ts

github-actions · 2026-01-23T13:02:50Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1769173370 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1769173370
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1769173370
# or
npm install @redocly/respect-core@0.0.0-snapshot.1769173370

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-01-26T08:19:37Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1769415576 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1769415576
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1769415576
# or
npm install @redocly/respect-core@0.0.0-snapshot.1769415576

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-01-27T11:01:20Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1769511679 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1769511679
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1769511679
# or
npm install @redocly/respect-core@0.0.0-snapshot.1769511679

⚠️ Note: This is a development build and may contain unstable features.

github-actions · 2026-01-30T12:36:41Z

📦 A new experimental 🧪 version v0.0.0-snapshot.1769776601 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1769776601
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1769776601
# or
npm install @redocly/respect-core@0.0.0-snapshot.1769776601

⚠️ Note: This is a development build and may contain unstable features.

packages/core/src/types/asyncapi3.ts

DmitryAnansky added the snapshot Create experimental release PR label Jan 6, 2026

DmitryAnansky added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 6, 2026

DmitryAnansky added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 7, 2026

DmitryAnansky force-pushed the feat/extend-node-types-with-description branch from 12d161b to afaf83a Compare January 14, 2026 12:42

DmitryAnansky added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 14, 2026

DmitryAnansky force-pushed the feat/extend-node-types-with-description branch from ffb01ee to 64873a5 Compare January 19, 2026 13:47

DmitryAnansky removed the snapshot Create experimental release PR label Jan 19, 2026

DmitryAnansky marked this pull request as ready for review January 19, 2026 16:54

DmitryAnansky requested review from a team as code owners January 19, 2026 16:54

DmitryAnansky added the snapshot Create experimental release PR label Jan 20, 2026

DmitryAnansky added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 20, 2026

DmitryAnansky added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 21, 2026

tatomyr reviewed Jan 23, 2026

View reviewed changes

packages/core/src/types/redocly-yaml.ts Outdated Show resolved Hide resolved

.changeset/lovely-mice-slide.md Outdated Show resolved Hide resolved

packages/core/src/types/redocly-yaml.ts Show resolved Hide resolved

DmitryAnansky force-pushed the feat/extend-node-types-with-description branch 2 times, most recently from bd519f4 to cc62403 Compare January 23, 2026 12:55

DmitryAnansky added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 23, 2026

DmitryAnansky force-pushed the feat/extend-node-types-with-description branch from cc62403 to e652627 Compare January 26, 2026 08:10

DmitryAnansky added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 26, 2026

DmitryAnansky force-pushed the feat/extend-node-types-with-description branch from e652627 to 0b776e1 Compare January 27, 2026 11:00

DmitryAnansky added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 27, 2026

DmitryAnansky force-pushed the feat/extend-node-types-with-description branch from 0b776e1 to 1fe1af9 Compare January 30, 2026 12:35

DmitryAnansky added snapshot Create experimental release PR and removed snapshot Create experimental release PR labels Jan 30, 2026

JLekawa approved these changes Jan 30, 2026

View reviewed changes

JLekawa self-requested a review January 30, 2026 13:42

DmitryAnansky requested a review from tatomyr February 2, 2026 09:04

DmitryAnansky commented Feb 2, 2026

View reviewed changes

packages/core/src/types/asyncapi3.ts Outdated Show resolved Hide resolved

JLekawa reviewed Feb 2, 2026

View reviewed changes

packages/core/src/types/asyncapi3.ts Outdated Show resolved Hide resolved

tatomyr approved these changes Feb 2, 2026

View reviewed changes

DmitryAnansky and others added 3 commits February 2, 2026 12:06

feat: extend node types with description

815719c

docs(other): delete links to 3rd-party websites

5fe8089

Update packages/core/src/types/asyncapi3.ts

723ae87

DmitryAnansky force-pushed the feat/extend-node-types-with-description branch from 4218c61 to 723ae87 Compare February 2, 2026 10:06

DmitryAnansky merged commit 0f1997e into main Feb 2, 2026
42 checks passed

DmitryAnansky deleted the feat/extend-node-types-with-description branch February 2, 2026 10:14

feat: extend node types with description #2488

feat: extend node types with description #2488

Uh oh!

Conversation

DmitryAnansky commented Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What/Why/How?

Reference

Testing

Screenshots (optional)

Check yourself

Security

Uh oh!

changeset-bot bot commented Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

github-actions bot commented Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jan 6, 2026

Uh oh!

github-actions bot commented Jan 6, 2026

Uh oh!

github-actions bot commented Jan 7, 2026

Uh oh!

github-actions bot commented Jan 7, 2026

Uh oh!

github-actions bot commented Jan 14, 2026

Uh oh!

github-actions bot commented Jan 20, 2026

Uh oh!

github-actions bot commented Jan 20, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jan 23, 2026

Uh oh!

github-actions bot commented Jan 26, 2026

Uh oh!

github-actions bot commented Jan 27, 2026

Uh oh!

github-actions bot commented Jan 30, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

DmitryAnansky commented Jan 6, 2026 •

edited

Loading

changeset-bot bot commented Jan 6, 2026 •

edited

Loading

github-actions bot commented Jan 6, 2026 •

edited

Loading

github-actions bot commented Jan 6, 2026 •

edited

Loading