Skip to content

[Generator] Add support of deepObject style in query params #538

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
Jul 16, 2025
+228 −11
Merged

[Generator] Add support of deepObject style in query params #538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4299f1e
[Generator] Add support of deepObject style in query params
kstefanou52 Mar 7, 2024
31b06f2
Update petstore.yaml with deepObject parameter
kstefanou52 Apr 17, 2024
1de7fed
Add Unite tests for DeepObject.
kstefanou52 Oct 26, 2024
7191b18
Update Tests/OpenAPIGeneratorReferenceTests/SnippetBasedReferenceTest…
kstefanou52 Oct 28, 2024
b04e6a8
Add more Tests for requred & optionals params.
kstefanou52 Feb 11, 2025
07f5d95
Soundness check fixes.
kstefanou52 Feb 11, 2025
e025bb6
Update Comsumer Test for mandatory field `filter`
kstefanou52 Jul 14, 2025
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
2 changes: 2 additions & 0 deletions Sources/_OpenAPIGeneratorCore/Translator/CommonTypes/Constants.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,8 @@ enum Constants {

/// The form style.
static let form = "form"
/// The deepObject style.
static let deepObject = "deepObject"
}
}

Expand Down
6 changes: 5 additions & 1 deletion Sources/_OpenAPIGeneratorCore/Translator/Parameters/TypedParameter.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,10 @@ extension FileTranslator {
let location = parameter.location
switch location {
case .query:
guard case .form = style else {
switch style {
case .form: break
case .deepObject where explode: break
default:
try diagnostics.emitUnsupported(
"Query params of style \(style.rawValue), explode: \(explode)",
foundIn: foundIn
Expand Down Expand Up @@ -243,6 +246,7 @@ extension OpenAPI.Parameter.SchemaContext.Style {
var runtimeName: String {
switch self {
case .form: return Constants.Components.Parameters.Style.form
case .deepObject: return Constants.Components.Parameters.Style.deepObject
default: preconditionFailure("Unsupported style")
}
}
Expand Down
28 changes: 28 additions & 0 deletions Tests/OpenAPIGeneratorReferenceTests/Resources/Docs/petstore.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,34 @@ paths:
schema:
format: uuid
type: string
- name: sort
in: query
required: false
style: deepObject
explode: true
schema:
type: object
required:
- id
properties:
id:
type: string
name:
type: string
- name: filter
in: query
required: true
style: deepObject
explode: true
schema:
type: object
required:
- name
properties:
name:
type: string
state:
type: string
- $ref: '#/components/parameters/query.born-since'
responses:
'200':
Expand Down
14 changes: 14 additions & 0 deletions Tests/OpenAPIGeneratorReferenceTests/Resources/ReferenceSources/Petstore/Client.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,20 @@ public struct Client: APIProtocol {
name: "My-Request-UUID",
value: input.headers.myRequestUUID
)
try converter.setQueryItemAsURI(
in: &request,
style: .deepObject,
explode: true,
name: "sort",
value: input.query.sort
)
try converter.setQueryItemAsURI(
in: &request,
style: .deepObject,
explode: true,
name: "filter",
value: input.query.filter
)
try converter.setQueryItemAsURI(
in: &request,
style: .form,
Expand Down
14 changes: 14 additions & 0 deletions Tests/OpenAPIGeneratorReferenceTests/Resources/ReferenceSources/Petstore/Server.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,20 @@ fileprivate extension UniversalServer where APIHandler: APIProtocol {
name: "feeds",
as: Operations.ListPets.Input.Query.FeedsPayload.self
),
sort: try converter.getOptionalQueryItemAsURI(
in: request.soar_query,
style: .deepObject,
explode: true,
name: "sort",
as: Operations.ListPets.Input.Query.SortPayload.self
),
filter: try converter.getRequiredQueryItemAsURI(
in: request.soar_query,
style: .deepObject,
explode: true,
name: "filter",
as: Operations.ListPets.Input.Query.FilterPayload.self
),
since: try converter.getOptionalQueryItemAsURI(
in: request.soar_query,
style: .form,
Expand Down
60 changes: 58 additions & 2 deletions Tests/OpenAPIGeneratorReferenceTests/Resources/ReferenceSources/Petstore/Types.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ extension APIProtocol {
/// - Remark: HTTP `GET /pets`.
/// - Remark: Generated from `#/paths//pets/get(listPets)`.
public func listPets(
query: Operations.ListPets.Input.Query = .init(),
query: Operations.ListPets.Input.Query,
headers: Operations.ListPets.Input.Headers = .init()
) async throws -> Operations.ListPets.Output {
try await listPets(Operations.ListPets.Input(
Expand Down Expand Up @@ -1895,6 +1895,56 @@ public enum Operations {
public typealias FeedsPayload = [Operations.ListPets.Input.Query.FeedsPayloadPayload]
/// - Remark: Generated from `#/paths/pets/GET/query/feeds`.
public var feeds: Operations.ListPets.Input.Query.FeedsPayload?
/// - Remark: Generated from `#/paths/pets/GET/query/sort`.
public struct SortPayload: Codable, Hashable, Sendable {
/// - Remark: Generated from `#/paths/pets/GET/query/sort/id`.
public var id: Swift.String
/// - Remark: Generated from `#/paths/pets/GET/query/sort/name`.
public var name: Swift.String?
/// Creates a new `SortPayload`.
///
/// - Parameters:
/// - id:
/// - name:
public init(
id: Swift.String,
name: Swift.String? = nil
) {
self.id = id
self.name = name
}
public enum CodingKeys: String, CodingKey {
case id
case name
}
}
/// - Remark: Generated from `#/paths/pets/GET/query/sort`.
public var sort: Operations.ListPets.Input.Query.SortPayload?
/// - Remark: Generated from `#/paths/pets/GET/query/filter`.
public struct FilterPayload: Codable, Hashable, Sendable {
/// - Remark: Generated from `#/paths/pets/GET/query/filter/name`.
public var name: Swift.String
/// - Remark: Generated from `#/paths/pets/GET/query/filter/state`.
public var state: Swift.String?
/// Creates a new `FilterPayload`.
///
/// - Parameters:
/// - name:
/// - state:
public init(
name: Swift.String,
state: Swift.String? = nil
) {
self.name = name
self.state = state
}
public enum CodingKeys: String, CodingKey {
case name
case state
}
}
/// - Remark: Generated from `#/paths/pets/GET/query/filter`.
public var filter: Operations.ListPets.Input.Query.FilterPayload
/// Supply this parameter to filter pets born since the provided date.
///
/// - Remark: Generated from `#/paths/pets/GET/query/since`.
Expand All @@ -1905,16 +1955,22 @@ public enum Operations {
/// - limit: How many items to return at one time (max 100)
/// - habitat:
/// - feeds:
/// - sort:
/// - filter:
/// - since: Supply this parameter to filter pets born since the provided date.
public init(
limit: Swift.Int32? = nil,
habitat: Operations.ListPets.Input.Query.HabitatPayload? = nil,
feeds: Operations.ListPets.Input.Query.FeedsPayload? = nil,
sort: Operations.ListPets.Input.Query.SortPayload? = nil,
filter: Operations.ListPets.Input.Query.FilterPayload,
since: Components.Parameters.Query_bornSince? = nil
) {
self.limit = limit
self.habitat = habitat
self.feeds = feeds
self.sort = sort
self.filter = filter
self.since = since
}
}
Expand Down Expand Up @@ -1946,7 +2002,7 @@ public enum Operations {
/// - query:
/// - headers:
public init(
query: Operations.ListPets.Input.Query = .init(),
query: Operations.ListPets.Input.Query,
headers: Operations.ListPets.Input.Headers = .init()
) {
self.query = query
Expand Down
94 changes: 92 additions & 2 deletions Tests/OpenAPIGeneratorReferenceTests/SnippetBasedReferenceTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2600,6 +2600,32 @@ final class SnippetBasedReferenceTests: XCTestCase {
type: array
items:
type: string
- name: sort
in: query
required: false
style: deepObject
explode: true
schema:
type: object
properties:
option1:
type: string
option2:
type: string
- name: filter
in: query
required: true
style: deepObject
explode: true
schema:
type: object
required:
- option3
properties:
option3:
type: string
option4:
type: string
responses:
default:
description: Response
Expand All @@ -2610,18 +2636,54 @@ final class SnippetBasedReferenceTests: XCTestCase {
public var single: Swift.String?
public var manyExploded: [Swift.String]?
public var manyUnexploded: [Swift.String]?
public struct sortPayload: Codable, Hashable, Sendable {
public var option1: Swift.String?
public var option2: Swift.String?
public init(
option1: Swift.String? = nil,
option2: Swift.String? = nil
) {
self.option1 = option1
self.option2 = option2
}
public enum CodingKeys: String, CodingKey {
case option1
case option2
}
}
public var sort: Operations.get_sol_foo.Input.Query.sortPayload?
public struct filterPayload: Codable, Hashable, Sendable {
public var option3: Swift.String
public var option4: Swift.String?
public init(
option3: Swift.String,
option4: Swift.String? = nil
) {
self.option3 = option3
self.option4 = option4
}
public enum CodingKeys: String, CodingKey {
case option3
case option4
}
}
public var filter: Operations.get_sol_foo.Input.Query.filterPayload
public init(
single: Swift.String? = nil,
manyExploded: [Swift.String]? = nil,
manyUnexploded: [Swift.String]? = nil
manyUnexploded: [Swift.String]? = nil,
sort: Operations.get_sol_foo.Input.Query.sortPayload? = nil,
filter: Operations.get_sol_foo.Input.Query.filterPayload
) {
self.single = single
self.manyExploded = manyExploded
self.manyUnexploded = manyUnexploded
self.sort = sort
self.filter = filter
}
}
public var query: Operations.get_sol_foo.Input.Query
public init(query: Operations.get_sol_foo.Input.Query = .init()) {
public init(query: Operations.get_sol_foo.Input.Query) {
self.query = query
}
}
Expand Down Expand Up @@ -2658,6 +2720,20 @@ final class SnippetBasedReferenceTests: XCTestCase {
name: "manyUnexploded",
value: input.query.manyUnexploded
)
try converter.setQueryItemAsURI(
in: &request,
style: .deepObject,
explode: true,
name: "sort",
value: input.query.sort
)
try converter.setQueryItemAsURI(
in: &request,
style: .deepObject,
explode: true,
name: "filter",
value: input.query.filter
)
return (request, nil)
}
""",
Expand All @@ -2684,6 +2760,20 @@ final class SnippetBasedReferenceTests: XCTestCase {
explode: false,
name: "manyUnexploded",
as: [Swift.String].self
),
sort: try converter.getOptionalQueryItemAsURI(
in: request.soar_query,
style: .deepObject,
explode: true,
name: "sort",
as: Operations.get_sol_foo.Input.Query.sortPayload.self
),
filter: try converter.getRequiredQueryItemAsURI(
in: request.soar_query,
style: .deepObject,
explode: true,
name: "filter",
as: Operations.get_sol_foo.Input.Query.filterPayload.self
)
)
return Operations.get_sol_foo.Input(query: query)
Expand Down
15 changes: 11 additions & 4 deletions Tests/PetstoreConsumerTests/Test_Client.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ final class Test_Client: XCTestCase {
XCTAssertEqual(operationID, "listPets")
XCTAssertEqual(
request.path,
"/pets?limit=24&habitat=water&feeds=herbivore&feeds=carnivore&since=2023-01-18T10%3A04%3A11Z"
"/pets?limit=24&habitat=water&feeds=herbivore&feeds=carnivore&sort%5Bid%5D=ascending&sort%5Bname%5D=descending&filter%5Bname%5D=whale&since=2023-01-18T10%3A04%3A11Z"
)
XCTAssertEqual(baseURL.absoluteString, "/api")
XCTAssertEqual(request.method, .get)
Expand All @@ -66,7 +66,14 @@ final class Test_Client: XCTestCase {
}
let response = try await client.listPets(
.init(
query: .init(limit: 24, habitat: .water, feeds: [.herbivore, .carnivore], since: .test),
query: .init(
limit: 24,
habitat: .water,
feeds: [.herbivore, .carnivore],
sort: .init(id: "ascending", name: "descending"),
filter: .init(name: "whale"),
since: .test
),
headers: .init(myRequestUUID: "abcd-1234")
)
)
Expand All @@ -84,7 +91,7 @@ final class Test_Client: XCTestCase {
func testListPets_default() async throws {
transport = .init { request, body, baseURL, operationID in
XCTAssertEqual(operationID, "listPets")
XCTAssertEqual(request.path, "/pets?limit=24")
XCTAssertEqual(request.path, "/pets?limit=24&filter%5Bname%5D=whale")
XCTAssertEqual(baseURL.absoluteString, "/api")
XCTAssertEqual(request.method, .get)
XCTAssertEqual(request.headerFields, [.accept: "application/json"])
Expand All @@ -100,7 +107,7 @@ final class Test_Client: XCTestCase {
"""#
)
}
let response = try await client.listPets(.init(query: .init(limit: 24)))
let response = try await client.listPets(.init(query: .init(limit: 24, filter: .init(name: "whale"))))
guard case let .default(statusCode, value) = response else {
XCTFail("Unexpected response: \(response)")
return
Expand Down
Loading