various improvements to JSON schema processing #1356
Merged
Conversation
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
sunshowers
approved these changes
Jun 21, 2025
Comment on lines
337
to
+339
| openapiv3::ReferenceOr::Item(openapiv3::Schema { | ||
| schema_data: openapiv3::SchemaData::default(), | ||
| schema_kind: openapiv3::SchemaKind::Any( | ||
| openapiv3::AnySchema::default(), | ||
| ), | ||
| schema_data: Default::default(), | ||
| schema_kind: openapiv3::SchemaKind::Any(Default::default()), |
Contributor
There was a problem hiding this comment.
tiny nit: worth extracting the maximally permissive schema into a function? we use it three times
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.
@sunshowers noticed that we aren't including schemas in OpenAPI output that are only referenced by our custom
x-rust-typeextension. We can address this by massively simplifying how we process schemas. This is some very very old code in dropshot, and I'm not quite sure why it felt like the right approach, but we had been generating them schema, and then scraping out references using a visitor.... but the references were already present in the structures used to generate the schema. It's a bit perplexing why we took this extra step--perhaps there's some other shoe that will drop, but we've certainly developed many more tests since then, and none of them point to any reason why this excursion might have been necessary.We also noticed that
schemarsallows for modeling a emptyenumvalue e.g.{ "enum": [] }andopenapiv3does not;schemarswill also emit such a schema when theJsonSchemaderive macro is applied to a never-type enum (e.g.enum Foo {}). To handle this while preserving extensions we emit the following schema which is representable byopenapiv3structures:{ "not": {} }.And for funsies, we also handle the
falseschema using the same construction.