Skip to content

Commit 5b763f8

Browse files
Smaug123claude
Smaug123
and
claude
committed
Serialise list-typed query parameters as repeated key=value pairs
List- and array-typed [<Query>] parameters were stringified with .ToString(), producing F# list syntax in the URL (e.g. "status-types=%5Bx%3B%20y%5D" for Gitea's NotifyGetList); int[] didn't even compile under net9.0 nullness checking. Each element now contributes its own key=value pair (the "multi" collection format, which is what every array parameter in the Gitea spec declares, and RestEase's convention), individually escaped. The query string is now computed at runtime as a list of per-parameter string-list components, concatenated and appended to the URL (with separator) only when nonempty, so an empty list contributes nothing and an all-empty query leaves the URL bare. Required scalar parameters produce byte-identical URLs to before. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 039eb3b commit 5b763f8

6 files changed

Lines changed: 1667 additions & 770 deletions

File tree

‎ConsumePlugin/Generated2SwaggerGitea.fs‎

Lines changed: 1343 additions & 729 deletions
Large diffs are not rendered by default.

‎ConsumePlugin/GeneratedRestClient.fs‎

Lines changed: 181 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -427,21 +427,31 @@ module PureGymApi =
427427
async {
428428
let! ct = Async.CancellationToken
429429

430+
let queryString =
431+
[
432+
[
433+
"fromDate=" + ((fromDate.ToString "yyyy-MM-dd") |> System.Uri.EscapeDataString)
434+
]
435+
[ "toDate=" + ((toDate.ToString "yyyy-MM-dd") |> System.Uri.EscapeDataString) ]
436+
]
437+
|> List.concat
438+
|> String.concat "&"
439+
430440
let uri =
431441
System.Uri (
432442
(match client.BaseAddress with
433443
| null -> System.Uri "https://whatnot.com/"
434444
| v -> v),
435445
System.Uri (
436446
("/v2/gymSessions/member"
437-
+ (if "/v2/gymSessions/member".IndexOf (char 63) >= 0 then
438-
"&"
447+
+ (if queryString = "" then
448+
""
439449
else
440-
"?")
441-
+ "fromDate="
442-
+ ((fromDate.ToString "yyyy-MM-dd") |> System.Uri.EscapeDataString)
443-
+ "&toDate="
444-
+ ((toDate.ToString "yyyy-MM-dd") |> System.Uri.EscapeDataString)),
450+
((if "/v2/gymSessions/member".IndexOf (char 63) >= 0 then
451+
"&"
452+
else
453+
"?")
454+
+ queryString))),
445455
System.UriKind.Relative
446456
)
447457
)
@@ -478,21 +488,31 @@ module PureGymApi =
478488
async {
479489
let! ct = Async.CancellationToken
480490

491+
let queryString =
492+
[
493+
[
494+
"fromDate=" + ((fromDate.ToString "yyyy-MM-dd") |> System.Uri.EscapeDataString)
495+
]
496+
[ "toDate=" + ((toDate.ToString "yyyy-MM-dd") |> System.Uri.EscapeDataString) ]
497+
]
498+
|> List.concat
499+
|> String.concat "&"
500+
481501
let uri =
482502
System.Uri (
483503
(match client.BaseAddress with
484504
| null -> System.Uri "https://whatnot.com/"
485505
| v -> v),
486506
System.Uri (
487507
("/v2/gymSessions/member?foo=1"
488-
+ (if "/v2/gymSessions/member?foo=1".IndexOf (char 63) >= 0 then
489-
"&"
508+
+ (if queryString = "" then
509+
""
490510
else
491-
"?")
492-
+ "fromDate="
493-
+ ((fromDate.ToString "yyyy-MM-dd") |> System.Uri.EscapeDataString)
494-
+ "&toDate="
495-
+ ((toDate.ToString "yyyy-MM-dd") |> System.Uri.EscapeDataString)),
511+
((if "/v2/gymSessions/member?foo=1".IndexOf (char 63) >= 0 then
512+
"&"
513+
else
514+
"?")
515+
+ queryString))),
496516
System.UriKind.Relative
497517
)
498518
)
@@ -1967,6 +1987,153 @@ open System.Net
19671987
open System.Net.Http
19681988
open RestEase
19691989

1990+
/// Module for constructing a REST client.
1991+
[<CompilationRepresentation(CompilationRepresentationFlags.ModuleSuffix) ; RequireQualifiedAccess>]
1992+
module ApiWithListQuery =
1993+
/// Create a REST client.
1994+
let make (client : System.Net.Http.HttpClient) : IApiWithListQuery =
1995+
{ new IApiWithListQuery with
1996+
member _.GetWithListQuery (tags : string list, limit : int, ct : CancellationToken option) =
1997+
async {
1998+
let! ct = Async.CancellationToken
1999+
2000+
let queryString =
2001+
[
2002+
tags
2003+
|> List.map (fun queryParam ->
2004+
"tag=" + ((queryParam.ToString ()) |> System.Uri.EscapeDataString)
2005+
)
2006+
[ "limit=" + ((limit.ToString ()) |> System.Uri.EscapeDataString) ]
2007+
]
2008+
|> List.concat
2009+
|> String.concat "&"
2010+
2011+
let uri =
2012+
System.Uri (
2013+
(match client.BaseAddress with
2014+
| null -> System.Uri "https://whatnot.com/"
2015+
| v -> v),
2016+
System.Uri (
2017+
("endpoint"
2018+
+ (if queryString = "" then
2019+
""
2020+
else
2021+
((if "endpoint".IndexOf (char 63) >= 0 then "&" else "?") + queryString))),
2022+
System.UriKind.Relative
2023+
)
2024+
)
2025+
2026+
use httpMessage =
2027+
new System.Net.Http.HttpRequestMessage (
2028+
Method = System.Net.Http.HttpMethod.Get,
2029+
RequestUri = uri
2030+
)
2031+
2032+
let! response = client.SendAsync (httpMessage, ct) |> Async.AwaitTask
2033+
let response = response.EnsureSuccessStatusCode ()
2034+
use response = response
2035+
let! responseString = response.Content.ReadAsStringAsync ct |> Async.AwaitTask
2036+
return responseString
2037+
}
2038+
|> (fun a -> Async.StartAsTask (a, ?cancellationToken = ct))
2039+
2040+
member _.GetWithSoleListQuery (tags : string list, ct : CancellationToken option) =
2041+
async {
2042+
let! ct = Async.CancellationToken
2043+
2044+
let queryString =
2045+
[
2046+
tags
2047+
|> List.map (fun queryParam ->
2048+
"tag=" + ((queryParam.ToString ()) |> System.Uri.EscapeDataString)
2049+
)
2050+
]
2051+
|> List.concat
2052+
|> String.concat "&"
2053+
2054+
let uri =
2055+
System.Uri (
2056+
(match client.BaseAddress with
2057+
| null -> System.Uri "https://whatnot.com/"
2058+
| v -> v),
2059+
System.Uri (
2060+
("endpoint"
2061+
+ (if queryString = "" then
2062+
""
2063+
else
2064+
((if "endpoint".IndexOf (char 63) >= 0 then "&" else "?") + queryString))),
2065+
System.UriKind.Relative
2066+
)
2067+
)
2068+
2069+
use httpMessage =
2070+
new System.Net.Http.HttpRequestMessage (
2071+
Method = System.Net.Http.HttpMethod.Get,
2072+
RequestUri = uri
2073+
)
2074+
2075+
let! response = client.SendAsync (httpMessage, ct) |> Async.AwaitTask
2076+
let response = response.EnsureSuccessStatusCode ()
2077+
use response = response
2078+
let! responseString = response.Content.ReadAsStringAsync ct |> Async.AwaitTask
2079+
return responseString
2080+
}
2081+
|> (fun a -> Async.StartAsTask (a, ?cancellationToken = ct))
2082+
2083+
member _.GetWithArrayQuery (ids : int[], ct : CancellationToken option) =
2084+
async {
2085+
let! ct = Async.CancellationToken
2086+
2087+
let queryString =
2088+
[
2089+
ids
2090+
|> Seq.map (fun queryParam ->
2091+
"id=" + ((queryParam.ToString ()) |> System.Uri.EscapeDataString)
2092+
)
2093+
|> List.ofSeq
2094+
]
2095+
|> List.concat
2096+
|> String.concat "&"
2097+
2098+
let uri =
2099+
System.Uri (
2100+
(match client.BaseAddress with
2101+
| null -> System.Uri "https://whatnot.com/"
2102+
| v -> v),
2103+
System.Uri (
2104+
("endpoint"
2105+
+ (if queryString = "" then
2106+
""
2107+
else
2108+
((if "endpoint".IndexOf (char 63) >= 0 then "&" else "?") + queryString))),
2109+
System.UriKind.Relative
2110+
)
2111+
)
2112+
2113+
use httpMessage =
2114+
new System.Net.Http.HttpRequestMessage (
2115+
Method = System.Net.Http.HttpMethod.Get,
2116+
RequestUri = uri
2117+
)
2118+
2119+
let! response = client.SendAsync (httpMessage, ct) |> Async.AwaitTask
2120+
let response = response.EnsureSuccessStatusCode ()
2121+
use response = response
2122+
let! responseString = response.Content.ReadAsStringAsync ct |> Async.AwaitTask
2123+
return responseString
2124+
}
2125+
|> (fun a -> Async.StartAsTask (a, ?cancellationToken = ct))
2126+
}
2127+
namespace PureGym
2128+
2129+
open System
2130+
open System.Threading
2131+
open System.Threading.Tasks
2132+
open System.IO
2133+
open System.Net
2134+
open System.Net.Http
2135+
open RestEase
2136+
19702137
/// Module for constructing a REST client.
19712138
[<CompilationRepresentation(CompilationRepresentationFlags.ModuleSuffix) ; RequireQualifiedAccess>]
19722139
module ClientWithStringBody =

‎ConsumePlugin/RestApiExample.fs‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,20 @@ type IClientWithJsonBodyOverridden =
226226
?ct : CancellationToken ->
227227
Task<string>
228228

229+
[<WoofWare.Myriad.Plugins.HttpClient>]
230+
[<BaseAddress "https://whatnot.com">]
231+
type IApiWithListQuery =
232+
// A list-typed query parameter contributes one key=value pair per element.
233+
[<Get "endpoint">]
234+
abstract GetWithListQuery :
235+
[<Query "tag">] tags : string list * [<Query "limit">] limit : int * ?ct : CancellationToken -> Task<string>
236+
237+
[<Get "endpoint">]
238+
abstract GetWithSoleListQuery : [<Query "tag">] tags : string list * ?ct : CancellationToken -> Task<string>
239+
240+
[<Get "endpoint">]
241+
abstract GetWithArrayQuery : [<Query "id">] ids : int[] * ?ct : CancellationToken -> Task<string>
242+
229243
[<WoofWare.Myriad.Plugins.HttpClient>]
230244
type IClientWithStringBody =
231245
// As a POST request of a bare string body, we don't override the Content-Type.

‎WoofWare.Myriad.Plugins.Test/TestHttpClient/TestListQueryParam.fs‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
namespace WoofWare.Myriad.Plugins.Test
2+
3+
open System
4+
open System.Net
5+
open System.Net.Http
6+
open NUnit.Framework
7+
open PureGym
8+
open FsUnitTyped
9+
10+
[<TestFixture>]
11+
module TestListQueryParam =
12+
13+
let private makeClient (expectedUri : string) : HttpClientMock =
14+
let proc (message : HttpRequestMessage) : HttpResponseMessage Async =
15+
async {
16+
message.Method |> shouldEqual HttpMethod.Get
17+
message.RequestUri.AbsoluteUri |> shouldEqual expectedUri
18+
19+
let resp = new HttpResponseMessage (HttpStatusCode.OK)
20+
resp.Content <- new StringContent ("response")
21+
return resp
22+
}
23+
24+
HttpClientMock.make (Uri "https://example.com") proc
25+
26+
[<Test>]
27+
let ``Each list element becomes its own key=value pair`` () =
28+
use client = makeClient "https://example.com/endpoint?tag=a&tag=b&limit=10"
29+
let api = ApiWithListQuery.make client
30+
31+
api.GetWithListQuery([ "a" ; "b" ], 10).Result |> shouldEqual "response"
32+
33+
[<Test>]
34+
let ``An empty list contributes nothing`` () =
35+
use client = makeClient "https://example.com/endpoint?limit=10"
36+
let api = ApiWithListQuery.make client
37+
38+
api.GetWithListQuery([], 10).Result |> shouldEqual "response"
39+
40+
[<Test>]
41+
let ``A sole empty list leaves the URL bare`` () =
42+
use client = makeClient "https://example.com/endpoint"
43+
let api = ApiWithListQuery.make client
44+
45+
api.GetWithSoleListQuery([]).Result |> shouldEqual "response"
46+
47+
[<Test>]
48+
let ``List elements are escaped individually`` () =
49+
use client = makeClient "https://example.com/endpoint?tag=a%20b&tag=c%26d&limit=10"
50+
let api = ApiWithListQuery.make client
51+
52+
api.GetWithListQuery([ "a b" ; "c&d" ], 10).Result |> shouldEqual "response"
53+
54+
[<Test>]
55+
let ``Array-typed query parameters behave like lists`` () =
56+
use client = makeClient "https://example.com/endpoint?id=1&id=2&id=3"
57+
let api = ApiWithListQuery.make client
58+
59+
api.GetWithArrayQuery([| 1 ; 2 ; 3 |]).Result |> shouldEqual "response"

‎WoofWare.Myriad.Plugins.Test/WoofWare.Myriad.Plugins.Test.fsproj‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
<Compile Include="TestHttpClient\TestBodyParam.fs" />
2727
<Compile Include="TestHttpClient\TestVaultClient.fs" />
2828
<Compile Include="TestHttpClient\TestVariableHeader.fs" />
29+
<Compile Include="TestHttpClient\TestListQueryParam.fs" />
2930
<Compile Include="TestMockGenerator\TestMockGenerator.fs" />
3031
<Compile Include="TestMockGenerator\TestMockGeneratorNoAttr.fs" />
3132
<Compile Include="TestCapturingMockGenerator\TestCapturingMockGenerator.fs" />

0 commit comments

Comments
 (0)