Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix (walker): show description for $ref in fragments of type array #23

Merged
merged 1 commit into from
Aug 9, 2023

Conversation

paulatulis
Copy link
Contributor

@paulatulis paulatulis commented Aug 8, 2023

Motivation and Context

#12516

Description

Checks fragment type to see if it's an array without a description. If there's a $ref within the fragment's items, attempts to resolve the $ref to grab the $ref description and assigns it to the fragment so that it will be included in the annotations for that node.

Before
Screenshot 2023-08-08 at 1 34 52 PM

After
Screenshot 2023-08-08 at 1 32 19 PM

How Has This Been Tested?

Added tests; yalced into JSON Schema Viewer

Screenshot(s)/recordings(s)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

@paulatulis paulatulis self-assigned this Aug 8, 2023
@paulatulis paulatulis marked this pull request as ready for review August 8, 2023 20:47
@paulatulis paulatulis requested review from a team, rainum and kaylachun and removed request for a team and rainum August 8, 2023 20:47
Copy link
Contributor

@kaylachun kaylachun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Awesome job finding the bug!

@paulatulis paulatulis merged commit 12b5623 into master Aug 9, 2023
3 checks passed
@paulatulis paulatulis deleted the fix/ref-description branch August 9, 2023 14:26
@github-actions
Copy link

github-actions bot commented Aug 9, 2023

🎉 This PR is included in version 2.2.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants