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

test: meta schema rules should not check description on ref #3980

Merged
merged 3 commits into from
Jun 14, 2023

Conversation

kwasniew
Copy link
Contributor

About the changes

Our meta rules checker will only verify description is present when the field is not a ref based field which has its own description.

This change automatically fixes a few schemas.

Important files

Discussion points

@vercel
Copy link

vercel bot commented Jun 14, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Ignored Deployments
Name Status Preview Comments Updated (UTC)
unleash-docs ⬜️ Ignored (Inspect) Jun 14, 2023 9:27am
unleash-monorepo-frontend ⬜️ Ignored (Inspect) Jun 14, 2023 9:27am

Copy link
Contributor

@gastonfournier gastonfournier left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

@thomasheartman
Copy link
Contributor

I'm not sure I'm on board with changing these schemas. Have you confirmed that $ref descriptions get propagated correctly (in swagger UI etc)? Second, even if they do, you will sometimes want a separate description where they are referenced, so I'm not sure I agree with just removing the descriptions where you have. Have you checked what the descriptions say up against what the $ref.descriptions say?

@kwasniew
Copy link
Contributor Author

The ones I removed are the ones I added a few hours ago myself so I know they are duplicates. I did some experimentation and $ref from the included schema are the ones being shown while the description on the including side was ignored. So we're removing stuff that was already ignored.

@kwasniew kwasniew merged commit 6ae4fe2 into main Jun 14, 2023
9 checks passed
@kwasniew kwasniew deleted the fix-meta-schema-rules branch June 14, 2023 10:29
@thomasheartman
Copy link
Contributor

Got it. In that case it sounds like a definite win! Good work! 🙌🏼

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

Successfully merging this pull request may close these issues.

None yet

3 participants