Support type: 'null' as OpenAPIValueContainer
#557
Conversation
brandonbloom
changed the title
type: 'null' as OpenAPIValueContainertype: 'null' as OpenAPIValueContainer
| @@ -289,6 +289,7 @@ struct TypeMatcher { | |||
| private static func _tryMatchBuiltinNonRecursive(for schema: JSONSchema.Schema) -> TypeUsage? { | |||
| let typeName: TypeName | |||
| switch schema { | |||
| case .null(_): typeName = TypeName.valueContainer | |||
There was a problem hiding this comment.
Hmm I'm still unsure whether we want to promote null to a JSON value here. Let's discuss in the other PR first, then we can come back to this.
There was a problem hiding this comment.
I also considered the singleton instance of NSNull, or some new enum type with one case, or () or something. It wasn't obvious if there was a more appropriate type for this in Swift.
There was a problem hiding this comment.
Hmm maybe we should introduce an typealias OpenAPINull = Void in the runtime library, and use that? What do you think? cc @simonjbeaumont
OpenAPIValueContainer isn't appropriate, I think, as it erases our knowledge of it being null, forcing the adopter to check again later. We should be able to avoid that.
|
Based on the discussion in the other thread, I think we should not merge this PR, and instead we should simply filter out |
|
We had a report that this is blocking generation for the Figma API: https://github.com/figma/rest-api-spec/blob/main/openapi/openapi.yaml, which I can confirm doesn't compile as-is. |
|
It would be great to get this merged as it unblocks using the Figma API as Simon mentions. |
|
I think we can't merge it as-is, as it'd be an API break. Plus, see my earlier message, I think we should fix this slightly differently. |
Motivation
OpenAPIKit's handling of
type: 'null'was problematic with older Yams versions. See https://github.com/mattpolzin/OpenAPIKit/pull/366/files for a test demonstrating that & dependency version bump.Similarly, swift-openapi-generator explicitly does not "support"
type: 'null'. As part of searching for something to address #513 I have added such support for explicit nulls. This gives one more sort of input schema where swift-openapi-generator produces some useful output instead of skipping a schema.Modifications
truefromisSchemaSupportedfortype: 'null'schemas..nullto have a builtint ype ofOpenAPIValueContainerResult
Nothing should change for existing users because
type: nullschemas were previously unsupported. Going forward, usages of these schemas is supported.Test Plan
New test included.