Skip to content

Commit

Permalink
Bump OpenAPIKit to 3.0.0-rc.3 and recognize more base64/binary encodi…
Browse files Browse the repository at this point in the history
…ng locations (#357)

Bump OpenAPIKit to 3.0.0-rc.3 and recognize more base64/binary encoding locations

### Motivation

In OpenAPI 3.1.0, the `format: ...` part of schemas is deprecated, and instead `contentEncoding: ...` should be used. Before this PR, we'd recognize the encodings defined in `format` but not `contentEncoding`, this PR fixes that and finds them in both locations. This required a bump of OpenAPIKit, which added support for `contentEncoding` in `3.0.0-rc.3`.

### Modifications

Change the type matching logic to first look at `contentEncoding`, if no special value is specified there, look at `format`.

### Result

`contentEncoding: base64` and `contentEncoding: binary` will now be correctly represented as their runtime types instead of a plain string.

### Test Plan

Adapted the unit tests.


Reviewed by: simonjbeaumont

Builds:
     ✔︎ pull request validation (5.10) - Build finished. 
     ✔︎ pull request validation (5.8) - Build finished. 
     ✔︎ pull request validation (5.9) - Build finished. 
     ✔︎ pull request validation (compatibility test) - Build finished. 
     ✔︎ pull request validation (docc test) - Build finished. 
     ✔︎ pull request validation (integration test) - Build finished. 
     ✔︎ pull request validation (nightly) - Build finished. 
     ✔︎ pull request validation (soundness) - Build finished. 

#357
  • Loading branch information
czechboy0 committed Nov 1, 2023
1 parent 16668dc commit 2081703
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ let package = Package(
.package(url: "https://github.com/apple/swift-algorithms", from: "1.0.0"),

// Read OpenAPI documents
.package(url: "https://github.com/mattpolzin/OpenAPIKit.git", exact: "3.0.0-rc.2"),
.package(url: "https://github.com/mattpolzin/OpenAPIKit.git", exact: "3.0.0-rc.3"),
.package(url: "https://github.com/jpsim/Yams.git", "4.0.0"..<"6.0.0"),

// CLI Tool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ extension TypeName {
/// - Returns: A TypeName representing the type with the given name in the HTTPTypes module.
static func httpTypes(_ name: String) -> TypeName { TypeName(swiftKeyPath: ["HTTPTypes", name]) }

/// Returns the type name for the Date type.
static var date: Self { .foundation("Date") }

/// Returns the type name for the URL type.
static var url: Self { .foundation("URL") }

Expand Down Expand Up @@ -78,4 +81,7 @@ extension TypeName {

/// Returns the type name for the copy-on-write box type.
static var box: TypeName { .runtime("CopyOnWriteBox") }

/// Returns the type name for the base64 wrapper.
static var base64: TypeName { .runtime("Base64EncodedData") }
}
Original file line number Diff line number Diff line change
Expand Up @@ -293,16 +293,22 @@ struct TypeMatcher {
case .int64: typeName = .swift("Int64")
default: typeName = .swift("Int")
}
case .string(let core, _):
case .string(let core, let stringContext):
if core.allowedValues != nil {
// custom enum isn't a builtin
return nil
}
switch core.format {
switch stringContext.contentEncoding {
case .binary: typeName = .body
case .byte: typeName = .runtime("Base64EncodedData")
case .dateTime: typeName = .foundation("Date")
default: typeName = .swift("String")
case .base64: typeName = .base64
default:
// Check the format as well, for docs converted from OpenAPI 3.0.
switch core.format {
case .binary: typeName = .body
case .byte: typeName = .base64
case .dateTime: typeName = .date
default: typeName = .string
}
}
case .fragment: typeName = .valueContainer
case let .object(_, objectContext):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ final class Test_TypeMatcher: Test_Core {

static let builtinTypes: [(JSONSchema, String)] = [
(.string, "Swift.String"), (.string(.init(format: .binary), .init()), "OpenAPIRuntime.HTTPBody"),
(.string(.init(), .init(contentEncoding: .binary)), "OpenAPIRuntime.HTTPBody"),
(.string(.init(format: .byte), .init()), "OpenAPIRuntime.Base64EncodedData"),
(.string(.init(), .init(contentEncoding: .base64)), "OpenAPIRuntime.Base64EncodedData"),
(.string(.init(format: .date), .init()), "Swift.String"),
(.string(.init(format: .dateTime), .init()), "Foundation.Date"),

Expand Down

0 comments on commit 2081703

Please sign in to comment.