fix(schema-model): preserve descriptions on referenced properties and arrays [TDX-5454] - #997
Open
arashsheyda wants to merge 1 commit into
Open
arashsheyda wants to merge 1 commit into
arashsheyda wants to merge 1 commit into
Conversation
… arrays [TDX-5454]
Collaborator
Install the preview package from this PR@kong/spec-renderer@pr-997 |
Collaborator
🔴 PR audit failed. 🔴🔥 PNPM Audit issues detected.PR with those issues cannot be merged. How to resolve:
|
vaibhavrajsingh2001
requested changes
Sep 16, 2026
| ...resolveAllOf(candidate.items), | ||
| ...(Object.hasOwn(candidate, 'description') ? { description: candidate.description } : {}), | ||
| type: candidate.type, | ||
| itemType: candidate.items.type, |
Contributor
There was a problem hiding this comment.
looks like we have multiple cases of fields being defined at the top level for array schemas, instead of being defined inside items.
So we should probably build a list of keys that need to be picked up from candidate itself instead of candidate.items
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Summary
ticket: https://konghq.atlassian.net/browse/TDX-5454
In the spec display when we have a property that is a user defined class or an array of classes, the definition in the main class is not displayed. In the example attached, I want to add more detail to the collection of stops but I can only update the single stop description.