Update tutorials and tests to reference new type-safe variables API

theoriginalbit · theoriginalbit · commit c62d6bdbd750 · 2024-10-09T22:53:36.000+11:00
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/ClientSwiftPM.tutorial b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/ClientSwiftPM.tutorial
@@ -122,7 +122,7 @@
             @Step {
                 Next we'll create an instance of our client.
 
-                Note: `Servers.server2()` is the localhost service, defined in the OpenAPI document.
+                Note: `Servers.Server2.url()` is the localhost service, defined in the OpenAPI document.
                 @Code(name: "main.swift", file: client.main.2.swift)
             }
             @Step {
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/ClientXcode.tutorial b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/ClientXcode.tutorial
@@ -119,7 +119,7 @@
             @Step {
                 Next we'll create an instance of the generated client.
 
-                Note: `Servers.server2()` is the localhost service, defined in the OpenAPI document.
+                Note: `Servers.Server2.url()` is the localhost service, defined in the OpenAPI document.
                 
                 @Code(name: "GreetingClient.swift", file: client.xcode.2.swift)
             }
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.main.2.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.main.2.swift
@@ -2,6 +2,6 @@ import OpenAPIRuntime
 import OpenAPIURLSession
 
 let client = Client(
-    serverURL: try Servers.server2(),
+    serverURL: try Servers.Server2.url(),
     transport: URLSessionTransport()
 )
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.main.3.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.main.3.swift
@@ -2,7 +2,7 @@ import OpenAPIRuntime
 import OpenAPIURLSession
 
 let client = Client(
-    serverURL: try Servers.server2(),
+    serverURL: try Servers.Server2.url(),
     transport: URLSessionTransport()
 )
 
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.main.4.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.main.4.swift
@@ -2,7 +2,7 @@ import OpenAPIRuntime
 import OpenAPIURLSession
 
 let client = Client(
-    serverURL: try Servers.server2(),
+    serverURL: try Servers.Server2.url(),
     transport: URLSessionTransport()
 )
 
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.main.5.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.main.5.swift
@@ -2,7 +2,7 @@ import OpenAPIRuntime
 import OpenAPIURLSession
 
 let client = Client(
-    serverURL: try Servers.server2(),
+    serverURL: try Servers.Server2.url(),
     transport: URLSessionTransport()
 )
 
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.main.6.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.main.6.swift
@@ -2,7 +2,7 @@ import OpenAPIRuntime
 import OpenAPIURLSession
 
 let client = Client(
-    serverURL: try Servers.server2(),
+    serverURL: try Servers.Server2.url(),
     transport: URLSessionTransport()
 )
 
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.main.7.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.main.7.swift
@@ -2,7 +2,7 @@ import OpenAPIRuntime
 import OpenAPIURLSession
 
 let client = Client(
-    serverURL: try Servers.server2(),
+    serverURL: try Servers.Server2.url(),
     transport: URLSessionTransport()
 )
 
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.xcode.2.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.xcode.2.swift
@@ -6,7 +6,7 @@ public struct GreetingClient {
 
     public func getGreeting(name: String?) async throws -> String {
         let client = Client(
-            serverURL: try Servers.server2(),
+            serverURL: try Servers.Server2.url(),
             transport: URLSessionTransport()
         )
     }
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.xcode.3.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.xcode.3.swift
@@ -6,7 +6,7 @@ public struct GreetingClient {
 
     public func getGreeting(name: String?) async throws -> String {
         let client = Client(
-            serverURL: try Servers.server2(),
+            serverURL: try Servers.Server2.url(),
             transport: URLSessionTransport()
         )
         let response = try await client.getGreeting(query: .init(name: name))
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.xcode.4.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.xcode.4.swift
@@ -6,7 +6,7 @@ public struct GreetingClient {
 
     public func getGreeting(name: String?) async throws -> String {
         let client = Client(
-            serverURL: try Servers.server2(),
+            serverURL: try Servers.Server2.url(),
             transport: URLSessionTransport()
         )
         let response = try await client.getGreeting(query: .init(name: name))
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.xcode.5.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.xcode.5.swift
@@ -6,7 +6,7 @@ public struct GreetingClient {
 
     public func getGreeting(name: String?) async throws -> String {
         let client = Client(
-            serverURL: try Servers.server2(),
+            serverURL: try Servers.Server2.url(),
             transport: URLSessionTransport()
         )
         let response = try await client.getGreeting(query: .init(name: name))
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.xcode.6.2.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.xcode.6.2.swift
@@ -6,7 +6,7 @@ public struct GreetingClient {
 
     public func getGreeting(name: String?) async throws -> String {
         let client = Client(
-            serverURL: try Servers.server2(),
+            serverURL: try Servers.Server2.url(),
             transport: URLSessionTransport()
         )
         let response = try await client.getGreeting(query: .init(name: name))
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.xcode.6.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.xcode.6.swift
@@ -6,7 +6,7 @@ public struct GreetingClient {
 
     public func getGreeting(name: String?) async throws -> String {
         let client = Client(
-            serverURL: try Servers.server2(),
+            serverURL: try Servers.Server2.url(),
             transport: URLSessionTransport()
         )
         let response = try await client.getGreeting(query: .init(name: name))
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/server-openapi-endpoints.main.0.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/server-openapi-endpoints.main.0.swift
@@ -26,7 +26,7 @@ let handler = GreetingServiceAPIImpl()
 
 // Call the generated function on your implementation to add its request
 // handlers to the app.
-try handler.registerHandlers(on: transport, serverURL: Servers.server1())
+try handler.registerHandlers(on: transport, serverURL: Servers.Server1.url())
 
 // Start the app as you would normally.
 try await app.execute()
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/server-openapi-endpoints.main.1.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/server-openapi-endpoints.main.1.swift
@@ -26,7 +26,7 @@ let handler = GreetingServiceAPIImpl()
 
 // Call the generated function on your implementation to add its request
 // handlers to the app.
-try handler.registerHandlers(on: transport, serverURL: Servers.server1())
+try handler.registerHandlers(on: transport, serverURL: Servers.Server1.url())
 
 // Add Vapor middleware to serve the contents of the Public/ directory.
 app.middleware.use(FileMiddleware(publicDirectory: app.directory.publicDirectory))
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/server-openapi-endpoints.main.2.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/server-openapi-endpoints.main.2.swift
@@ -26,7 +26,7 @@ let handler = GreetingServiceAPIImpl()
 
 // Call the generated function on your implementation to add its request
 // handlers to the app.
-try handler.registerHandlers(on: transport, serverURL: Servers.server1())
+try handler.registerHandlers(on: transport, serverURL: Servers.Server1.url())
 
 // Add Vapor middleware to serve the contents of the Public/ directory.
 app.middleware.use(FileMiddleware(publicDirectory: app.directory.publicDirectory))
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/server.main.1.2.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/server.main.1.2.swift
@@ -26,7 +26,7 @@ let handler = GreetingServiceAPIImpl()
 
 // Call the generated function on your implementation to add its request
 // handlers to the app.
-try handler.registerHandlers(on: transport, serverURL: Servers.server1())
+try handler.registerHandlers(on: transport, serverURL: Servers.Server1.url())
 
 // Start the app as you would normally.
 try await app.execute()
diff --git a/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/server.main.2.swift b/Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/server.main.2.swift
@@ -34,7 +34,7 @@ let handler = GreetingServiceAPIImpl()
 
 // Call the generated function on your implementation to add its request
 // handlers to the app.
-try handler.registerHandlers(on: transport, serverURL: Servers.server1())
+try handler.registerHandlers(on: transport, serverURL: Servers.Server1.url())
 
 // Start the app as you would normally.
 try await app.execute()
diff --git a/Tests/PetstoreConsumerTests/Test_Types.swift b/Tests/PetstoreConsumerTests/Test_Types.swift
@@ -222,14 +222,17 @@ final class Test_Types: XCTestCase {
             verifyingJSON: #"{"name":"C","parent":{"nested":{"name":"B","parent":{"nested":{"name":"A"}}}}}"#
         )
     }
-    func testServers_1() throws { XCTAssertEqual(try Servers.server1(), URL(string: "https://example.com/api")) }
-    func testServers_2() throws { XCTAssertEqual(try Servers.server2(), URL(string: "/api")) }
+    func testServers_1() throws { XCTAssertEqual(try Servers.Server1.url(), URL(string: "https://example.com/api")) }
+    func testServers_2() throws { XCTAssertEqual(try Servers.Server2.url(), URL(string: "/api")) }
     func testServers_3() throws {
-        XCTAssertEqual(try Servers.server3(), URL(string: "https://test.example.com:443/v1"))
+        XCTAssertEqual(try Servers.Server3.url(), URL(string: "https://test.example.com:443/v1"))
         XCTAssertEqual(
-            try Servers.server3(subdomain: "bar", port: "8443", basePath: "v2/staging"),
+            try Servers.Server3.url(subdomain: "bar", port: ._8443, basePath: "v2/staging"),
             URL(string: "https://bar.example.com:8443/v2/staging")
         )
+        // Intentionally using the deprecated static function to check for regressions.
+        // Once the deprecated functions are no longer being generated this assertion is
+        // unnecessary and can be removed.
         XCTAssertThrowsError(try Servers.server3(port: "foo")) { error in
             guard
                 case let .invalidServerVariableValue(name: name, value: value, allowedValues: allowedValues) = error

Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@`
`122`	`122`	`@Step {`
`123`	`123`	`Next we'll create an instance of our client.`
`124`	`124`
`125`		- Note: `Servers.server2()` is the localhost service, defined in the OpenAPI document.
	`125`	+ Note: `Servers.Server2.url()` is the localhost service, defined in the OpenAPI document.
`126`	`126`	`@Code(name: "main.swift", file: client.main.2.swift)`
`127`	`127`	`}`
`128`	`128`	`@Step {`
Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,7 @@`
`119`	`119`	`@Step {`
`120`	`120`	`Next we'll create an instance of the generated client.`
`121`	`121`
`122`		- Note: `Servers.server2()` is the localhost service, defined in the OpenAPI document.
	`122`	+ Note: `Servers.Server2.url()` is the localhost service, defined in the OpenAPI document.
`123`	`123`
`124`	`124`	`@Code(name: "GreetingClient.swift", file: client.xcode.2.swift)`
`125`	`125`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,6 @@ import OpenAPIRuntime`
`2`	`2`	`import OpenAPIURLSession`
`3`	`3`
`4`	`4`	`let client = Client(`
`5`		`- serverURL: try Servers.server2(),`
	`5`	`+ serverURL: try Servers.Server2.url(),`
`6`	`6`	`transport: URLSessionTransport()`
`7`	`7`	`)`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ import OpenAPIRuntime`
`2`	`2`	`import OpenAPIURLSession`
`3`	`3`
`4`	`4`	`let client = Client(`
`5`		`- serverURL: try Servers.server2(),`
	`5`	`+ serverURL: try Servers.Server2.url(),`
`6`	`6`	`transport: URLSessionTransport()`
`7`	`7`	`)`
`8`	`8`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ public struct GreetingClient {`
`6`	`6`
`7`	`7`	`public func getGreeting(name: String?) async throws -> String {`
`8`	`8`	`let client = Client(`
`9`		`- serverURL: try Servers.server2(),`
	`9`	`+ serverURL: try Servers.Server2.url(),`
`10`	`10`	`transport: URLSessionTransport()`
`11`	`11`	`)`
`12`	`12`	`}`