Skip to content

Commit dad5a79

Browse files
authored
Merge pull request #3723 from handrews/space-delim
Clarify `spaceDelimited` with spaces (3.0.4)
2 parents 214897c + 28faf0f commit dad5a79

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

versions/3.0.4.md

+1
Original file line numberDiff line numberDiff line change
@@ -1058,6 +1058,7 @@ spaceDelimited | `array`, `object` | `query` | Space separated array values or o
10581058
pipeDelimited | `array`, `object` | `query` | Pipe separated array values or object properties and values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0.
10591059
deepObject | `object` | `query` | Provides a simple way of rendering nested objects using form parameters.
10601060

1061+
The behavior of applying a style that uses a delimiter to data containing that delimiter is not defined, and is therefore NOT RECOMMENDED. To ensure interoperability, any such delimiter characters need to be escaped prior to serializing with the style, and unescaped after parsing. In the case of `spaceDelimited`, care must be taken to avoid confusing interactions with URL parameter encoding of spaces.
10611062

10621063
##### Style Examples
10631064

0 commit comments

Comments
 (0)