Skip to content

Commit c700c03

Browse files
committed
Clarify spaceDelimited with spaces in values (3.2.0)
The OAS does not define how to avoid collisions between parameter values and style delimiters. Mostly, this is straightforward, but the need to URL encode space characters introduces extra confusion. Make it clear that managing this occurs outside of the use of style, and is the responsibility of users.
1 parent 66f90d6 commit c700c03

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

versions/3.2.0.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1060,6 +1060,7 @@ spaceDelimited | `array`, `object` | `query` | Space separated array values or o
10601060
pipeDelimited | `array`, `object` | `query` | Pipe separated array values or object properties and values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0.
10611061
deepObject | `object` | `query` | Provides a simple way of rendering nested objects using form parameters.
10621062

1063+
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.
10631064

10641065
##### Style Examples
10651066

0 commit comments

Comments
 (0)