Update to OpenAPIKit 3.0.0-alpha.9

Signed-off-by: Si Beaumont <beaumont@apple.com>

Author: simonjbeaumont

Package.swift

@@ -64,7 +64,7 @@ let package = Package(
         // Read OpenAPI documents
         .package(
             url: "https://github.com/mattpolzin/OpenAPIKit.git",
-            exact: "3.0.0-alpha.7"
+            exact: "3.0.0-alpha.9"
         ),
         .package(
             url: "https://github.com/jpsim/Yams.git",

Sources/_OpenAPIGeneratorCore/Translator/Operations/OperationDescription.swift

@@ -59,13 +59,20 @@ extension OperationDescription {
     ///   - components: The components from the OpenAPI document.
     ///   - asSwiftSafeName: A converted function from user-provided strings
     ///   to strings safe to be used as a Swift identifier.
+    /// - Throws: if `map` contains any references; see discussion for details.
+    ///
+    /// This function will throw an error if `map` contains any references, because:
+    /// 1. OpenAPI 3.0.3 only supports external path references (cf. 3.1, which supports internal references too)
+    /// 2. Swift OpenAPI Generator currently only supports OpenAPI 3.0.x.
+    /// 3. Swift OpenAPI Generator currently doesn't support external references.
     static func all(
         from map: OpenAPI.PathItem.Map,
         in components: OpenAPI.Components,
         asSwiftSafeName: @escaping (String) -> String
-    ) -> [OperationDescription] {
-        map.flatMap { path, value in
-            value.endpoints.map { endpoint in
+    ) throws -> [OperationDescription] {
+        try map.flatMap { path, value in
+            let value = try value.resolve(in: components)
+            return value.endpoints.map { endpoint in
                 OperationDescription(
                     path: path,
                     endpoint: endpoint,

Sources/_OpenAPIGeneratorCore/Translator/TypesTranslator/TypesFileTranslator.swift

@@ -41,19 +41,17 @@ struct TypesFileTranslator: FileTranslator {
             + config.additionalImports
             .map { ImportDescription(moduleName: $0) }
 
-        let apiProtocol = translateAPIProtocol(doc.paths)
+        let apiProtocol = try translateAPIProtocol(doc.paths)
 
         let serversDecl = translateServers(doc.servers)
 
         let components = try translateComponents(doc.components)
 
-        let operationDescriptions =
-            OperationDescription
-            .all(
-                from: parsedOpenAPI.paths,
-                in: doc.components,
-                asSwiftSafeName: swiftSafeName
-            )
+        let operationDescriptions = try OperationDescription.all(
+            from: parsedOpenAPI.paths,
+            in: doc.components,
+            asSwiftSafeName: swiftSafeName
+        )
         let operations = try translateOperations(operationDescriptions)
 
         let typesFile = FileDescription(

Sources/_OpenAPIGeneratorCore/Translator/TypesTranslator/translateAPIProtocol.swift

@@ -19,9 +19,10 @@ extension TypesFileTranslator {
     /// per HTTP operation defined in the OpenAPI document.
     /// - Parameter paths: The paths object from the OpenAPI document.
     /// - Returns: A protocol declaration.
-    func translateAPIProtocol(_ paths: OpenAPI.PathItem.Map) -> Declaration {
+    /// - Throws: If `paths` contains any references.
+    func translateAPIProtocol(_ paths: OpenAPI.PathItem.Map) throws -> Declaration {
 
-        let operations = OperationDescription.all(
+        let operations = try OperationDescription.all(
             from: paths,
             in: components,
             asSwiftSafeName: swiftSafeName

Tests/OpenAPIGeneratorCoreTests/Parser/Test_YamsParser.swift

@@ -118,8 +118,12 @@ final class Test_YamsParser: Test_Core {
                       description: Success
             """
 
-        let expected =
-            "/foo.yaml: error: Expected to find `responses` key for the **GET** endpoint under `/system` but it is missing."
+        let expected = """
+        /foo.yaml: error: Found neither a $ref nor a PathItem in Document.paths['/system']. 
+
+        PathItem could not be decoded because:
+        Expected to find `responses` key for the **GET** endpoint under `/system` but it is missing..
+        """
         assertThrownError(try _test(yaml), expectedDiagnostic: expected)
     }
 

Tests/OpenAPIGeneratorReferenceTests/SnippetBasedReferenceTests.swift

@@ -726,6 +726,52 @@ final class SnippetBasedReferenceTests: XCTestCase {
             """
         )
     }
+
+    func testPathsSimplestCase() throws {
+        try self.assertPathsTranslation(
+            """
+            /health:
+              get:
+                operationId: getHealth
+                responses:
+                  '200':
+                    description: A success response with a greeting.
+                    content:
+                      text/plain:
+                        schema:
+                          type: string
+            """,
+            """
+            public protocol APIProtocol: Sendable {
+                func getHealth(_ input: Operations.getHealth.Input) async throws -> Operations.getHealth.Output
+            }
+            """
+        )
+    }
+
+    func testPathWithPathItemReference() throws {
+        XCTAssertThrowsError(
+            try self.assertPathsTranslation(
+                """
+                /health:
+                  get:
+                    operationId: getHealth
+                    responses:
+                      '200':
+                        description: A success response with a greeting.
+                        content:
+                          text/plain:
+                            schema:
+                              type: string
+                /health2:
+                  $ref: "#/paths/~1health"
+                """,
+                """
+                unused: This test throws an error.
+                """
+            )
+        )
+    }
 }
 
 extension SnippetBasedReferenceTests {
@@ -817,6 +863,19 @@ extension SnippetBasedReferenceTests {
         let translation = try translator.translateComponentRequestBodies(translator.components.requestBodies)
         try XCTAssertSwiftEquivalent(translation, expectedSwift, file: file, line: line)
     }
+
+    func assertPathsTranslation(
+        _ pathsYAML: String,
+        componentsYAML: String = "{}",
+        _ expectedSwift: String,
+        file: StaticString = #filePath,
+        line: UInt = #line
+    ) throws {
+        let translator = try makeTypesTranslator(componentsYAML: componentsYAML)
+        let paths = try YAMLDecoder().decode(OpenAPI.PathItem.Map.self, from: pathsYAML)
+        let translation = try translator.translateAPIProtocol(paths)
+        try XCTAssertSwiftEquivalent(translation, expectedSwift, file: file, line: line)
+    }
 }
 
 private func XCTAssertEqualWithDiff(