Merge branch 'main' into error_handling

Author: gayathrisairam

.github/workflows/pull_request.yml

@@ -7,24 +7,19 @@ on:
 jobs:
     soundness:
         name: Soundness
-        uses: apple/swift-nio/.github/workflows/soundness.yml@main
+        uses: swiftlang/github-workflows/.github/workflows/soundness.yml@main
         with:
-            api_breakage_check_enabled: true
-            broken_symlink_check_enabled: true
-            docs_check_enabled: true
-            format_check_enabled: true
-            license_header_check_enabled: true
+            api_breakage_check_enabled: false
             license_header_check_project_name: "SwiftOpenAPIGenerator"
-            shell_check_enabled: true
-            unacceptable_language_check_enabled: true
+            yamllint_check_enabled: false
 
     unit-tests:
         name: Unit tests
         uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
         with:
-            linux_5_8_enabled: false
             linux_5_9_arguments_override: "--explicit-target-dependency-import-check error"
             linux_5_10_arguments_override: "--explicit-target-dependency-import-check error"
+            linux_6_0_arguments_override: "--explicit-target-dependency-import-check error"
             linux_nightly_6_0_arguments_override: "--explicit-target-dependency-import-check error"
             linux_nightly_main_enabled: false
 
@@ -34,7 +29,6 @@ jobs:
         with:
             name: "Integration test"
             matrix_linux_command: "apt-get update -yq && apt-get install -yq jq && SWIFT_OPENAPI_GENERATOR_REPO_URL=file://${GITHUB_WORKSPACE} ./scripts/run-integration-test.sh"
-            matrix_linux_5_8_enabled: false
             matrix_linux_nightly_main_enabled: false
 
     compatibility-test:
@@ -62,7 +56,6 @@ jobs:
         with:
             name: "Example packages"
             matrix_linux_command: "./scripts/test-examples.sh"
-            matrix_linux_5_8_enabled: false
             matrix_linux_nightly_main_enabled: false
 
     swift-6-language-mode:

.github/workflows/scheduled.yml

@@ -9,9 +9,9 @@ jobs:
         name: Unit tests
         uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
         with:
-            linux_5_8_enabled: false
             linux_5_9_arguments_override: "--explicit-target-dependency-import-check error"
             linux_5_10_arguments_override: "--explicit-target-dependency-import-check error"
+            linux_6_0_arguments_override: "--explicit-target-dependency-import-check error"
             linux_nightly_6_0_arguments_override: "--explicit-target-dependency-import-check error"
             linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error"
 
@@ -21,12 +21,10 @@ jobs:
         with:
             name: "Integration test"
             matrix_linux_command: "apt-get update -yq && apt-get install -yq jq && SWIFT_OPENAPI_GENERATOR_REPO_URL=file://${GITHUB_WORKSPACE} ./scripts/run-integration-test.sh"
-            matrix_linux_5_8_enabled: false
 
     example-packages:
         name: Example packages
         uses: apple/swift-nio/.github/workflows/swift_matrix.yml@main
         with:
             name: "Example packages"
             matrix_linux_command: "./scripts/test-examples.sh"
-            matrix_linux_5_8_enabled: false

Package.swift

@@ -51,7 +51,7 @@ let package = Package(
         .package(url: "https://github.com/apple/swift-algorithms", from: "1.2.0"),
 
         // Read OpenAPI documents
-        .package(url: "https://github.com/mattpolzin/OpenAPIKit", from: "3.1.2"),
+        .package(url: "https://github.com/mattpolzin/OpenAPIKit", from: "3.3.0"),
         .package(url: "https://github.com/jpsim/Yams", "4.0.0"..<"6.0.0"),
 
         // CLI Tool

Sources/_OpenAPIGeneratorCore/Diagnostics.swift

@@ -322,7 +322,7 @@ public struct StdErrPrintingDiagnosticCollector: DiagnosticCollector, Sendable {
     /// Emits a diagnostic message to standard error.
     ///
     /// - Parameter diagnostic: The diagnostic message to emit.
-    public func emit(_ diagnostic: Diagnostic) { stdErrHandle.write(diagnostic.description) }
+    public func emit(_ diagnostic: Diagnostic) { stdErrHandle.write(diagnostic.description + "\n") }
 }
 
 /// A no-op collector, silently ignores all diagnostics.

Sources/_OpenAPIGeneratorCore/Hooks/FilteredDocument.swift

@@ -313,6 +313,7 @@ private extension FilteredDocumentBuilder {
                 guard predicate(endpoint) else { continue }
                 if requiredEndpoints[path] == nil { requiredEndpoints[path] = Set() }
                 if requiredEndpoints[path]!.insert(endpoint.method).inserted {
+                    for parameter in originalPathItem.parameters { try includeParameter(parameter) }
                     try includeComponentsReferencedBy(endpoint.operation)
                 }
             }

Sources/_OpenAPIGeneratorCore/Layers/StructuredSwiftRepresentation.swift

@@ -1628,9 +1628,15 @@ extension KeywordKind {
 }
 
 extension Declaration {
+    /// Returns a new deprecated variant of the declaration if the provided `description` is not `nil`.
+    func deprecate(if description: DeprecationDescription?) -> Self {
+        if let description { return .deprecated(description, self) }
+        return self
+    }
+
     /// Returns a new deprecated variant of the declaration if `shouldDeprecate` is true.
-    func deprecate(if shouldDeprecate: Bool) -> Self {
-        if shouldDeprecate { return .deprecated(.init(), self) }
+    func deprecate(if shouldDeprecate: Bool, description: @autoclosure () -> DeprecationDescription = .init()) -> Self {
+        if shouldDeprecate { return .deprecated(description(), self) }
         return self
     }
 

Sources/_OpenAPIGeneratorCore/Parser/YamsParser.swift

@@ -70,10 +70,10 @@ public struct YamsParser: ParserProtocol {
         do {
             let document: OpenAPIKit.OpenAPI.Document
             switch openAPIVersion {
-            case "3.0.0", "3.0.1", "3.0.2", "3.0.3":
+            case "3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.0.4":
                 let openAPI30Document = try decoder.decode(OpenAPIKit30.OpenAPI.Document.self, from: input.contents)
                 document = openAPI30Document.convert(to: .v3_1_0)
-            case "3.1.0": document = try decoder.decode(OpenAPIKit.OpenAPI.Document.self, from: input.contents)
+            case "3.1.0", "3.1.1": document = try decoder.decode(OpenAPIKit.OpenAPI.Document.self, from: input.contents)
             default:
                 throw Diagnostic.openAPIVersionError(
                     versionString: "openapi: \(openAPIVersion)",

Sources/_OpenAPIGeneratorCore/Translator/CommonTypes/Constants.swift

@@ -56,6 +56,18 @@ enum Constants {
 
         /// The prefix of each generated method name.
         static let propertyPrefix: String = "server"
+        /// The name of each generated static function.
+        static let urlStaticFunc: String = "url"
+
+        /// The prefix of the namespace that contains server specific variables.
+        static let serverNamespacePrefix: String = "Server"
+
+        /// Constants related to the OpenAPI server variable object.
+        enum Variable {
+
+            /// The types that the protocol conforms to.
+            static let conformances: [String] = [TypeName.string.fullyQualifiedSwiftName, "Sendable"]
+        }
     }
 
     /// Constants related to the configuration type, which is used by both

Sources/_OpenAPIGeneratorCore/Translator/Responses/translateResponseOutcome.swift

@@ -23,17 +23,18 @@ extension TypesFileTranslator {
     ///   - operation: The OpenAPI operation.
     ///   - operationJSONPath: The JSON path to the operation in the OpenAPI
     ///   document.
-    /// - Returns: A declaration of the enum case and a declaration of the
+    /// - Returns: A tuple containing a declaration of the enum case, a declaration of the
     /// structure unique to the response that contains the response headers
-    /// and a body payload.
+    /// and a body payload, a declaration of a throwing getter and, an optional convenience static property.
     /// - Throws: An error if there's an issue generating the declarations, such
     ///           as unsupported response types or invalid definitions.
     func translateResponseOutcomeInTypes(
         _ outcome: OpenAPI.Operation.ResponseOutcome,
         operation: OperationDescription,
         operationJSONPath: String
-    ) throws -> (payloadStruct: Declaration?, enumCase: Declaration, throwingGetter: Declaration) {
-
+    ) throws -> (
+        payloadStruct: Declaration?, enumCase: Declaration, staticMember: Declaration?, throwingGetter: Declaration
+    ) {
         let typedResponse = try typedResponse(from: outcome, operation: operation)
         let responseStructTypeName = typedResponse.typeUsage.typeName
         let responseKind = outcome.status.value.asKind
@@ -55,14 +56,36 @@ extension TypesFileTranslator {
         }
         associatedValues.append(.init(type: .init(responseStructTypeName)))
 
-        let enumCaseDesc = EnumCaseDescription(name: enumCaseName, kind: .nameWithAssociatedValues(associatedValues))
-        let enumCaseDecl: Declaration = .commentable(
-            responseKind.docComment(
-                userDescription: typedResponse.response.description,
-                jsonPath: operationJSONPath + "/responses/" + responseKind.jsonPathComponent
-            ),
-            .enumCase(enumCaseDesc)
+        let enumCaseDocComment = responseKind.docComment(
+            userDescription: typedResponse.response.description,
+            jsonPath: operationJSONPath + "/responses/" + responseKind.jsonPathComponent
         )
+        let enumCaseDesc = EnumCaseDescription(name: enumCaseName, kind: .nameWithAssociatedValues(associatedValues))
+        let enumCaseDecl: Declaration = .commentable(enumCaseDocComment, .enumCase(enumCaseDesc))
+
+        let staticMemberDecl: Declaration?
+        let responseHasNoHeaders = typedResponse.response.headers?.isEmpty ?? true
+        let responseHasNoContent = typedResponse.response.content.isEmpty
+        if responseHasNoContent && responseHasNoHeaders && !responseKind.wantsStatusCode {
+            let staticMemberDesc = VariableDescription(
+                accessModifier: config.access,
+                isStatic: true,
+                kind: .var,
+                left: .identifier(.pattern(enumCaseName)),
+                type: .member(["Self"]),
+                getter: [
+                    .expression(
+                        .functionCall(
+                            calledExpression: .dot(enumCaseName),
+                            arguments: [.functionCall(calledExpression: .dot("init"))]
+                        )
+                    )
+                ]
+            )
+            staticMemberDecl = .commentable(enumCaseDocComment, .variable(staticMemberDesc))
+        } else {
+            staticMemberDecl = nil
+        }
 
         let throwingGetterDesc = VariableDescription(
             accessModifier: config.access,
@@ -113,7 +136,7 @@ extension TypesFileTranslator {
         )
         let throwingGetterDecl = Declaration.commentable(throwingGetterComment, .variable(throwingGetterDesc))
 
-        return (responseStructDecl, enumCaseDecl, throwingGetterDecl)
+        return (responseStructDecl, enumCaseDecl, staticMemberDecl, throwingGetterDecl)
     }
 }
 

Sources/_OpenAPIGeneratorCore/Translator/TypesTranslator/translateOperations.swift

@@ -143,7 +143,8 @@ extension TypesFileTranslator {
         let documentedMembers: [Declaration] = documentedOutcomes.flatMap {
             inlineResponseDecl,
             caseDecl,
-            throwingGetter in [inlineResponseDecl, caseDecl, throwingGetter].compactMap { $0 }
+            staticDecl,
+            throwingGetter in [inlineResponseDecl, caseDecl, staticDecl, throwingGetter].compactMap { $0 }
         }
 
         let allMembers: [Declaration]