Skip to content

Serialise list-typed query parameters as repeated key=value pairs #541

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
Smaug123 merged 8 commits into from
Jul 10, 2026
Merged

Serialise list-typed query parameters as repeated key=value pairs #541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5b763f8
Serialise list-typed query parameters as repeated key=value pairs
Smaug123 Jul 9, 2026
354de2d
Merge branch 'main' into fix-list-query-stringification
Smaug123 Jul 10, 2026
1b1bb0d
Merge branch 'main' into fix-list-query-stringification
Smaug123 Jul 10, 2026
75e4421
Don't let the generated queryString binding shadow parameters
Smaug123 Jul 10, 2026
bc6ee38
Property-test the generated-name allocator
Smaug123 Jul 10, 2026
44ea2c4
Merge branch 'main' into fix-list-query-stringification
Smaug123 Jul 10, 2026
e9af9ac
Tidy up tests
Smaug123 Jul 10, 2026
02a6597
Merge branch 'fix-list-query-stringification' of github.com:Smaug123/…
Smaug123 Jul 10, 2026
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,072 changes: 1,343 additions & 729 deletions ConsumePlugin/Generated2SwaggerGitea.fs
View file
Open in desktop

Large diffs are not rendered by default.

295 changes: 281 additions & 14 deletions ConsumePlugin/GeneratedRestClient.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,21 +427,31 @@ module PureGymApi =
async {
let! ct = Async.CancellationToken

let queryString =
[
[
"fromDate=" + ((fromDate.ToString "yyyy-MM-dd") |> System.Uri.EscapeDataString)
]
[ "toDate=" + ((toDate.ToString "yyyy-MM-dd") |> System.Uri.EscapeDataString) ]
]
|> List.concat
|> String.concat "&"

let uri =
System.Uri (
(match client.BaseAddress with
| null -> System.Uri "https://whatnot.com/"
| v -> v),
System.Uri (
("/v2/gymSessions/member"
+ (if "/v2/gymSessions/member".IndexOf (char 63) >= 0 then
"&"
+ (if queryString = "" then
""
else
"?")
+ "fromDate="
+ ((fromDate.ToString "yyyy-MM-dd") |> System.Uri.EscapeDataString)
+ "&toDate="
+ ((toDate.ToString "yyyy-MM-dd") |> System.Uri.EscapeDataString)),
((if "/v2/gymSessions/member".IndexOf (char 63) >= 0 then
"&"
else
"?")
+ queryString))),
System.UriKind.Relative
)
)
Expand Down Expand Up @@ -478,21 +488,31 @@ module PureGymApi =
async {
let! ct = Async.CancellationToken

let queryString =
[
[
"fromDate=" + ((fromDate.ToString "yyyy-MM-dd") |> System.Uri.EscapeDataString)
]
[ "toDate=" + ((toDate.ToString "yyyy-MM-dd") |> System.Uri.EscapeDataString) ]
]
|> List.concat
|> String.concat "&"

let uri =
System.Uri (
(match client.BaseAddress with
| null -> System.Uri "https://whatnot.com/"
| v -> v),
System.Uri (
("/v2/gymSessions/member?foo=1"
+ (if "/v2/gymSessions/member?foo=1".IndexOf (char 63) >= 0 then
"&"
+ (if queryString = "" then
""
else
"?")
+ "fromDate="
+ ((fromDate.ToString "yyyy-MM-dd") |> System.Uri.EscapeDataString)
+ "&toDate="
+ ((toDate.ToString "yyyy-MM-dd") |> System.Uri.EscapeDataString)),
((if "/v2/gymSessions/member?foo=1".IndexOf (char 63) >= 0 then
"&"
else
"?")
+ queryString))),
System.UriKind.Relative
)
)
Expand Down Expand Up @@ -1967,6 +1987,253 @@ open System.Net
open System.Net.Http
open RestEase

/// Module for constructing a REST client.
[<CompilationRepresentation(CompilationRepresentationFlags.ModuleSuffix) ; RequireQualifiedAccess>]
module ApiWithListQuery =
/// Create a REST client.
let make (client : System.Net.Http.HttpClient) : IApiWithListQuery =
{ new IApiWithListQuery with
member _.GetWithListQuery (tags : string list, limit : int, ct : CancellationToken option) =
async {
let! ct = Async.CancellationToken

let queryString =
[
tags
|> List.map (fun queryParam ->
"tag=" + ((queryParam.ToString ()) |> System.Uri.EscapeDataString)
)
[ "limit=" + ((limit.ToString ()) |> System.Uri.EscapeDataString) ]
]
|> List.concat
|> String.concat "&"

let uri =
System.Uri (
(match client.BaseAddress with
| null -> System.Uri "https://whatnot.com/"
| v -> v),
System.Uri (
("endpoint"
+ (if queryString = "" then
""
else
((if "endpoint".IndexOf (char 63) >= 0 then "&" else "?") + queryString))),
System.UriKind.Relative
)
)

use httpMessage =
new System.Net.Http.HttpRequestMessage (
Method = System.Net.Http.HttpMethod.Get,
RequestUri = uri
)

let! response = client.SendAsync (httpMessage, ct) |> Async.AwaitTask
let response = response.EnsureSuccessStatusCode ()
use response = response
let! responseString = response.Content.ReadAsStringAsync ct |> Async.AwaitTask
return responseString
}
|> (fun a -> Async.StartAsTask (a, ?cancellationToken = ct))

member _.GetWithSoleListQuery (tags : string list, ct : CancellationToken option) =
async {
let! ct = Async.CancellationToken

let queryString =
[
tags
|> List.map (fun queryParam ->
"tag=" + ((queryParam.ToString ()) |> System.Uri.EscapeDataString)
)
]
|> List.concat
|> String.concat "&"

let uri =
System.Uri (
(match client.BaseAddress with
| null -> System.Uri "https://whatnot.com/"
| v -> v),
System.Uri (
("endpoint"
+ (if queryString = "" then
""
else
((if "endpoint".IndexOf (char 63) >= 0 then "&" else "?") + queryString))),
System.UriKind.Relative
)
)

use httpMessage =
new System.Net.Http.HttpRequestMessage (
Method = System.Net.Http.HttpMethod.Get,
RequestUri = uri
)

let! response = client.SendAsync (httpMessage, ct) |> Async.AwaitTask
let response = response.EnsureSuccessStatusCode ()
use response = response
let! responseString = response.Content.ReadAsStringAsync ct |> Async.AwaitTask
return responseString
}
|> (fun a -> Async.StartAsTask (a, ?cancellationToken = ct))

member _.GetWithArrayQuery (ids : int[], ct : CancellationToken option) =
async {
let! ct = Async.CancellationToken

let queryString =
[
ids
|> Seq.map (fun queryParam ->
"id=" + ((queryParam.ToString ()) |> System.Uri.EscapeDataString)
)
|> List.ofSeq
]
|> List.concat
|> String.concat "&"

let uri =
System.Uri (
(match client.BaseAddress with
| null -> System.Uri "https://whatnot.com/"
| v -> v),
System.Uri (
("endpoint"
+ (if queryString = "" then
""
else
((if "endpoint".IndexOf (char 63) >= 0 then "&" else "?") + queryString))),
System.UriKind.Relative
)
)

use httpMessage =
new System.Net.Http.HttpRequestMessage (
Method = System.Net.Http.HttpMethod.Get,
RequestUri = uri
)

let! response = client.SendAsync (httpMessage, ct) |> Async.AwaitTask
let response = response.EnsureSuccessStatusCode ()
use response = response
let! responseString = response.Content.ReadAsStringAsync ct |> Async.AwaitTask
return responseString
}
|> (fun a -> Async.StartAsTask (a, ?cancellationToken = ct))
}
namespace PureGym

open System
open System.Threading
open System.Threading.Tasks
open System.IO
open System.Net
open System.Net.Http
open RestEase

/// Module for constructing a REST client.
[<CompilationRepresentation(CompilationRepresentationFlags.ModuleSuffix) ; RequireQualifiedAccess>]
module ApiShadowingGeneratedNames =
/// Create a REST client.
let make (client : System.Net.Http.HttpClient) : IApiShadowingGeneratedNames =
{ new IApiShadowingGeneratedNames with
member _.GetWithPathNamedQueryString (queryString : string, limit : int, ct : CancellationToken option) =
async {
let! ct = Async.CancellationToken

let queryString1 =
[ [ "limit=" + ((limit.ToString ()) |> System.Uri.EscapeDataString) ] ]
|> List.concat
|> String.concat "&"

let uri =
System.Uri (
(match client.BaseAddress with
| null -> System.Uri "https://whatnot.com/"
| v -> v),
System.Uri (
("endpoint/{queryString}"
.Replace ("{queryString}", queryString.ToString () |> System.Uri.EscapeDataString)
+ (if queryString1 = "" then
""
else
((if "endpoint/{queryString}".IndexOf (char 63) >= 0 then
"&"
else
"?")
+ queryString1))),
System.UriKind.Relative
)
)

use httpMessage =
new System.Net.Http.HttpRequestMessage (
Method = System.Net.Http.HttpMethod.Get,
RequestUri = uri
)

let! response = client.SendAsync (httpMessage, ct) |> Async.AwaitTask
let response = response.EnsureSuccessStatusCode ()
use response = response
let! responseString = response.Content.ReadAsStringAsync ct |> Async.AwaitTask
return responseString
}
|> (fun a -> Async.StartAsTask (a, ?cancellationToken = ct))

member _.GetWithQueryNamedQueryString (queryString : string, limit : int, ct : CancellationToken option) =
async {
let! ct = Async.CancellationToken

let queryString1 =
[
[ "queryString=" + ((queryString.ToString ()) |> System.Uri.EscapeDataString) ]
[ "limit=" + ((limit.ToString ()) |> System.Uri.EscapeDataString) ]
]
|> List.concat
|> String.concat "&"

let uri =
System.Uri (
(match client.BaseAddress with
| null -> System.Uri "https://whatnot.com/"
| v -> v),
System.Uri (
("endpoint"
+ (if queryString1 = "" then
""
else
((if "endpoint".IndexOf (char 63) >= 0 then "&" else "?") + queryString1))),
System.UriKind.Relative
)
)

use httpMessage =
new System.Net.Http.HttpRequestMessage (
Method = System.Net.Http.HttpMethod.Get,
RequestUri = uri
)

let! response = client.SendAsync (httpMessage, ct) |> Async.AwaitTask
let response = response.EnsureSuccessStatusCode ()
use response = response
let! responseString = response.Content.ReadAsStringAsync ct |> Async.AwaitTask
return responseString
}
|> (fun a -> Async.StartAsTask (a, ?cancellationToken = ct))
}
namespace PureGym

open System
open System.Threading
open System.Threading.Tasks
open System.IO
open System.Net
open System.Net.Http
open RestEase

/// Module for constructing a REST client.
[<CompilationRepresentation(CompilationRepresentationFlags.ModuleSuffix) ; RequireQualifiedAccess>]
module ClientWithStringBody =
Expand Down
30 changes: 30 additions & 0 deletions ConsumePlugin/RestApiExample.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,36 @@ type IClientWithJsonBodyOverridden =
?ct : CancellationToken ->
Task<string>

[<WoofWare.Myriad.Plugins.HttpClient>]
[<BaseAddress "https://whatnot.com">]
type IApiWithListQuery =
// A list-typed query parameter contributes one key=value pair per element.
[<Get "endpoint">]
abstract GetWithListQuery :
[<Query "tag">] tags : string list * [<Query "limit">] limit : int * ?ct : CancellationToken -> Task<string>

[<Get "endpoint">]
abstract GetWithSoleListQuery : [<Query "tag">] tags : string list * ?ct : CancellationToken -> Task<string>

[<Get "endpoint">]
abstract GetWithArrayQuery : [<Query "id">] ids : int[] * ?ct : CancellationToken -> Task<string>

[<WoofWare.Myriad.Plugins.HttpClient>]
[<BaseAddress "https://whatnot.com">]
type IApiShadowingGeneratedNames =
// The generator emits a local binding holding the serialised query string. That binding
// must not shadow a user parameter which happens to share its name.
[<Get "endpoint/{queryString}">]
abstract GetWithPathNamedQueryString :
[<Path "queryString">] queryString : string * [<Query "limit">] limit : int * ?ct : CancellationToken ->
Task<string>

// Same, but the colliding parameter is itself a query parameter.
[<Get "endpoint">]
abstract GetWithQueryNamedQueryString :
[<Query "queryString">] queryString : string * [<Query "limit">] limit : int * ?ct : CancellationToken ->
Task<string>

[<WoofWare.Myriad.Plugins.HttpClient>]
type IClientWithStringBody =
// As a POST request of a bare string body, we don't override the Content-Type.
Expand Down
Loading
Loading