Skip to content

Conversation

@sezaru
Copy link

@sezaru sezaru commented Dec 30, 2025

What/Why/How?

Bsaically this allows users to set description in object schemas that are insode oneOf schemas and show it to the user.

I consider this a WIP for now since I'm not sure the way I'm doing it is the best approach.

What I tried to do first was to use directly activeSchema.description, but I noticed that when the schema doesn't have a description defined, it will have the description of the oneOf schema instead. I'm not sure if that is by design, a bug, or something that needs some other change to work.

The solution was to use activeSchema.rawSchema.description since that one will contain the correct description.

Tests

I didn't add any new test, the existing ones are passing just fine.

Screenshots (optional)

image

Check yourself

  • Code is linted
  • Tested
  • All new/updated code is covered with tests

@sezaru sezaru requested a review from a team as a code owner December 30, 2025 02:07
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.

1 participant