Skip to content

Commit f8f2236

Browse files
committed
Sync open source content 🐝 (from b2bbc9e8115f54d12a29866079f1c85c5039a2ed)
1 parent 28b64f8 commit f8f2236

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

openapi/requests/parameters/query-parameters.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,8 @@ For the examples below, we will use a query parameter named `filter` with a valu
134134
},
135135
{
136136
style: "`deepObject`",
137-
explodeTrue: "/query?filter[type]=cocktail&filter[strength]=5",
138-
explodeFalse: "**NOT VALID**"
137+
explodeTrue: "**Not applicable**",
138+
explodeFalse: "/query?filter[type]=cocktail&filter[strength]=5"
139139
}
140140
]}
141141
columns={[
@@ -154,7 +154,7 @@ For the examples below, we will use a query parameter named `filter` with a valu
154154
]}
155155
/>
156156

157-
There is a special case for simple objects with fields that are an array of primitive types such as `string`, `number`, `integer`, and `boolean` that can be handled by `style: deepObject` and `explode: true`. For example, for a query parameter named `filter` with a value of `{"type": ["cocktail", "mocktail"], "strength": [5, 10]}`, this will be serialized like `/query?filter[type]=cocktail&filter[type]=mocktail&filter[strength]=5&filter[strength]=10`.
157+
The `style: deepObject` serialization uses bracket notation and the `explode` parameter is not applicable (it is ignored regardless of whether it is set to `true`, `false`, or omitted). There is a special case for simple objects with fields that are an array of primitive types such as `string`, `number`, `integer`, and `boolean`. For example, for a query parameter named `filter` with a value of `{"type": ["cocktail", "mocktail"], "strength": [5, 10]}`, this will be serialized like `/query?filter[type]=cocktail&filter[type]=mocktail&filter[strength]=5&filter[strength]=10`.
158158

159159
## Complex Objects and Arrays As Query Parameters in OpenAPI
160160

0 commit comments

Comments
 (0)