Skip to content

Commit 33b79aa

Browse files
committed
Added commaDelimited example
1 parent 9adb4aa commit 33b79aa

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

versions/3.0.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -763,7 +763,7 @@ Field Name | Type | Description
763763
<a name="parameterFormat"></a>format | `string` | The extending format for the previously mentioned [`type`](#parameterType). See [Data Type Formats](#dataTypeFormat) for further details.
764764
<a name="parameterStyle"></a>style | `string` | Describes how the parameter value will be serialized depending on the specified [`type`](#parameterType).
765765
<a name="parameterAllowReserved"></a>allowReserved | `boolean` | Determines whether the parameter value should allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`.
766-
<a name="parameterExplode"></a>explode | `boolean` | When this is true, parameter values of type `array` or `object` generate seperate parameters for each value of the array, or key-value-pair of the map. For other types of parameters this property has no effect.
766+
<a name="parameterExplode"></a>explode | `boolean` | When this is true, parameter values of type `array` or `object` generate seperate parameters for each value of the array, or key-value-pair of the map. For other types of parameters this property has no effect. The default value is false.
767767
<a name="parameterAllowEmptyValue"/>allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows you to send a parameter with a name only or an empty value. Default value is `false`.
768768
<a name="parameterItems"></a>items | [Items Object](#itemsObject) | **Required if [`type`](#parameterType) is "array".** Describes the type of items in the array.
769769
<a name="parameterDefault"></a>default | * | Declares the value of the parameter that the server will use if none is provided, for example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request. (Note: "default" has no meaning for required parameters.) See http://json-schema.org/latest/json-schema-validation.html#anchor101. Unlike JSON Schema this value MUST conform to the defined [`type`](#parameterType) for this parameter.
@@ -788,8 +788,8 @@ matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defin
788788
label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5)
789789
form | `primitive`, `array`, `object` | `query`| Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8)
790790
commaDelimited | `array` | `query`, `path` | Comma seperated array values. This option replaces `collectionFormat` equal to `csv`.
791-
spaceDelimited | `array` | `query`, `path` | Space seperated array values. This option replaces `collectionFormat` equal to `ssv`.
792-
pipeDelimited | `array` | `query`, `path` | Pipe seperated array values. This option replaces `collectionFormat` equal to `pipes`.
791+
spaceDelimited | `array` | `query` | Space seperated array values. This option replaces `collectionFormat` equal to `ssv`.
792+
pipeDelimited | `array` | `query` | Pipe seperated array values. This option replaces `collectionFormat` equal to `pipes`.
793793
deepObject | `object` | `query` | Provides a simple way of rendering nested objects using form parameters.
794794

795795

@@ -812,6 +812,7 @@ label | false | . | .blue | .blue.black.brown | .R.100.G.200.B.150
812812
label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150
813813
form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150
814814
form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150
815+
commaDelimited | false | n/a | n/a | blue,black,brown | R,100,G,200,B,150
815816
spaceDelimited | false | n/a | n/a | blue%20black%20brown | R%20100%20G%20200%20B%20150
816817
pipeDelimited | false | n/a | n/a | blue\|black\|brown | R\|100\|G\|200|G\|150
817818
deepObject | true | n/a | n/a | n/a | color[R]=100&color[G]=200&color[B]=150

0 commit comments

Comments
 (0)