Skip to content

Commit e184fb5

Browse files
authored
fix(docs): URL query arrays should be formatted with form rather than comma-separated (#1807)
* fix(docs): arrays in URL queries should be formatted with `form` rather than comma-separated * docs: update /multiple tx example * chore: schema lint fix
1 parent 0831393 commit e184fb5

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docs/openapi.yaml

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,8 @@ paths:
207207
in: query
208208
description: Filter by transaction type
209209
required: false
210+
style: form
211+
explode: true
210212
schema:
211213
type: array
212214
example: coinbase
@@ -377,9 +379,15 @@ paths:
377379
in: query
378380
description: Array of transaction ids
379381
required: true
382+
style: form
383+
explode: true
380384
schema:
381385
type: array
382-
example: "0x0a411719e3bfde95f9e227a2d7f8fac3d6c646b1e6cc186db0e2838a2c6cd9c0"
386+
example: [
387+
"0x0a411719e3bfde95f9e227a2d7f8fac3d6c646b1e6cc186db0e2838a2c6cd9c0",
388+
"0xfbe6412b46e9db87df991a0d043ff47eb58019f770208cf48e2380337cc31785",
389+
"0x178b77678a758d9f29a147d6399315c83d0f1baf114431fbe4d3587aa5fbba6f"
390+
]
383391
items:
384392
type: string
385393
- name: event_offset
@@ -3113,6 +3121,8 @@ paths:
31133121
in: query
31143122
description: identifiers of the token asset classes to filter for
31153123
required: false
3124+
style: form
3125+
explode: true
31163126
schema:
31173127
type: array
31183128
example: "SPQZF23W7SEYBFG5JQ496NMY0G7379SRYEDREMSV.Candy::candy"
@@ -3446,6 +3456,8 @@ paths:
34463456
in: query
34473457
description: Filter the events on event type
34483458
required: false
3459+
style: form
3460+
explode: true
34493461
schema:
34503462
type: array
34513463
example: stx_lock

0 commit comments

Comments
 (0)