-
Notifications
You must be signed in to change notification settings - Fork 14
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
Interception occurs before PrepareJSONSchema #103
Comments
Thank you for raising this, I think this should be considered a bug.
However, there is another issue with your example. The problem is that you prepare parent schema, but interceptor is called for schemas as they are built from deeper nodes to outer.
Let me think how such a (racy?) case can be solved conveniently. |
Maybe, what could be a solution here is a way to mimic field tags without field tags, so that lengthy or dynamic values can be used. |
Describe the bug
I would like my schema to include
markdownDescription
attributes so that VS Code (via the JSON and YAML language servers) will render help text properly in hover overlays. Since I don't want to have to maintain duplicate versions of each description, I was hoping to useInterceptSchema
to populate themarkdownDescription
value automatically.Unfortunately, many of my descriptions are set via
PrepareJSONSchema()
(they're long and not conducive to being managed in struct tags). It appears that both the property and schema interceptors are called beforePrepareJSONSchema
.To Reproduce
Expected behavior
I expected
schema
to contain themarkdownDescription
prop set to the content of thedescription
... sadly, it did not. I had to post-processschema
with the following. Which honestly, wasn't that big of a deal. It was just confusing because it seemed like the interceptor approach was the right way to go about it.Additional context
I don't know if this is technically a bug, or if the behavior is by design. If it's the latter, I think it would be good to document in both interceptor functions to prevent further confusion.
The text was updated successfully, but these errors were encountered: