Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correctly handle path params with a hyphen in the name #602

Merged
merged 2 commits into from
Jul 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ extension OperationDescription {
/// The regular expression for parsing subcomponents of path components.
///
/// Either a parameter `{foo}` or a constant value `foo`.
private static let pathParameterRegex = try! NSRegularExpression(pattern: #"(\{[a-zA-Z0-9_]+\})|([^{}]+)"#)
private static let pathParameterRegex = try! NSRegularExpression(pattern: #"(\{[a-zA-Z0-9_\-\.]+\})|([^{}]+)"#)

/// Returns a string that contains the template to be generated for
/// the client that fills in path parameters, and an array expression
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2605,6 +2605,7 @@ final class SnippetBasedReferenceTests: XCTestCase {
"""
)
}

func testRequestWithPathParams() throws {
try self.assertRequestInTypesClientServerTranslation(
"""
Expand Down Expand Up @@ -2696,6 +2697,65 @@ final class SnippetBasedReferenceTests: XCTestCase {
)
}

func testRequestWithPathParamWithHyphenAndPeriod() throws {
try self.assertRequestInTypesClientServerTranslation(
"""
/foo/{p.a-b}:
get:
parameters:
- name: p.a-b
in: path
required: true
schema:
type: string
operationId: getFoo
responses:
default:
description: Response
""",
types: """
public struct Input: Sendable, Hashable {
public struct Path: Sendable, Hashable {
public var p_period_a_hyphen_b: Swift.String
public init(p_period_a_hyphen_b: Swift.String) {
self.p_period_a_hyphen_b = p_period_a_hyphen_b
}
}
public var path: Operations.getFoo.Input.Path
public init(path: Operations.getFoo.Input.Path) {
self.path = path
}
}
""",
client: """
{ input in
let path = try converter.renderedPath(
template: "/foo/{}",
parameters: [
input.path.p_period_a_hyphen_b
]
)
var request: HTTPTypes.HTTPRequest = .init(
soar_path: path,
method: .get
)
suppressMutabilityWarning(&request)
return (request, nil)
}
""",
server: """
{ request, requestBody, metadata in
let path: Operations.getFoo.Input.Path = .init(p_period_a_hyphen_b: try converter.getPathParameterAsURI(
in: metadata.pathParameters,
name: "p.a-b",
as: Swift.String.self
))
return Operations.getFoo.Input(path: path)
}
"""
)
}

func testRequestRequiredBodyPrimitiveSchema() throws {
try self.assertRequestInTypesClientServerTranslation(
"""
Expand Down