Skip to content

Commit 9dbfbe1

Browse files
authored
Merge pull request #3754 from handrews/space-delim-311
Clarify spaceDelimited with spaces in values (3.1.1 port of #3723)
2 parents 524a7f4 + d929309 commit 9dbfbe1

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

versions/3.1.1.md

+1
Original file line numberDiff line numberDiff line change
@@ -1106,6 +1106,7 @@ spaceDelimited | `array`, `object` | `query` | Space separated array values or o
11061106
pipeDelimited | `array`, `object` | `query` | Pipe separated array values or object properties and values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0.
11071107
deepObject | `object` | `query` | Allows objects with scalar properties to be represented using form parameters. The representation of array or object properties is not defined.
11081108

1109+
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.
11091110

11101111
##### Style Examples
11111112

0 commit comments

Comments
 (0)