Map all true schemas to empty object schemas in OpenAPI #57067
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
ghost
added
the
old-area-web-frameworks-do-not-use
amcasey
approved these changes
Jul 29, 2024
| // expected in OpenAPI documents. | ||
| if (type == typeof(object)) | ||
| // anything (like the `object` type) or types with user-defined converters. We override | ||
| // this default behavior here to match the style traditionally expected in OpenAPI documents. |
Member
There was a problem hiding this comment.
What does "traditionally" mean here? Is there a newer style of OpenAPI documents?
Member
Author
There was a problem hiding this comment.
Yes, OpenAPI v3.1 is an upcoming version that has full parity with JSON schema and would permit true schemas being used as catch-all schemas. I'll update this comment to be more explicit.
| if (type == typeof(object)) | ||
| // anything (like the `object` type) or types with user-defined converters. We override | ||
| // this default behavior here to match the style traditionally expected in OpenAPI documents. | ||
| if (schema.GetValueKind() == JsonValueKind.True) |
Member
There was a problem hiding this comment.
Idle thought: what happens for dynamic?
Member
Author
There was a problem hiding this comment.
Good question! Looks like it gets handled similarily to object foo. I added test coverage for this in fa39cfc.
3 tasks
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.
Closes #57041.
This PR is an extension of the changes that was introduced in 4c8b5fe to replace the use of
trueschemas with empty object schemas in the OpenAPI implementation.JsonSchemaExporteruses thetrueschemas as catch-all schema for types. OpenAPI schema diverges from JSON schema and expects that empty schemas{ }be used to represent catch-all values. The previous logic special cased fixing up these mappings forobjecttypes. This PR updates the implementation to do the mapping if the underlying schema is atrueschema, regardless of the type. This makes the implementation resilient to other cases where atrueschema is returned by STJ, like when a user defined converter is associated with a type.With these changes, we'd expect the following diff in the generated schema.
{ "type": "object", "properties": { "name": { "type": "string" }, - "childType": true, + "childType": { }, } }