Skip to content

Commit 828583a

Browse files
committed
Introduced prefix and separator
1 parent 9952f5a commit 828583a

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

versions/3.0.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -647,16 +647,25 @@ Field Name | Type | Description
647647
<a name="parameterRequired"></a>required | `boolean` | Determines whether this parameter is mandatory. If the parameter is [`in`](#parameterIn) "path", this property is **required** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`.
648648
<a name="parameterDeprecated"></a> deprecated | `boolean` | Specifies that a parameter is deprecated and should be transitioned out of usage.
649649
<a name="parameterSchema"></a>schema | [Schema Object](#schemaObject) | The schema defining the type used for the parameter.
650-
<a name="parameterEscape"></a>escape | `boolean` | Determines whether the parameter value should have unallowed characters percent-encoded based the parameter ___location. The default value is `true`.
651-
<a name="parameterStyle"></a>style | `string` | Determines rendering rules based on [RFC 6570](https://tools.ietf.org/html/rfc6570). Valid values include "matrix", "label", "segment", "simple". The style is only used when `in` has the value `path`. "matrix" refers to what RFC6570 calls "path-style". Default value is "simple".
650+
<a name="parameterEscape"></a>escape | `boolean` | Determines whether the parameter value should have unallowed characters percent-encoded based the parameter ___location. This property only applies to parameters with an `in` value of `query`. The default value is `true`.
651+
<a name="parameterPrefix"></a>style | `string` | Defines a character to prefix each parameter value. Valid values include [;.]. Where no separator is specified and a parameter value is an array, then a comma will be used as the default separator.
652+
<a name="parameterSeparator"></a>style | `string` | Defines a character used to separate the values of parameters that are lists and maps. Value values include [;.]. Where no separator is specified and a parameter value is an array, then a comma will be used as the default separator.
652653
<a name="parameterExplode"></a>explode | `boolean` | Indicates if the parameter values should rendered using the rules of the explode operator as defined in [RFC 6570](https://tools.ietf.org/html/rfc6570#section-2.2). Default value is `false`.
653654

654-
655655
##### Patterned Fields
656656
Field Pattern | Type | Description
657657
---|:---:|---
658658
<a name="parameterExtensions"></a>^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Specification Extensions](#specificationExtensions) for further details.
659659

660+
##### Parameter Value Rendering Examples
661+
662+
path | escape | prefix | separator | explode | Value | Output
663+
---|:---:|---:|---:|---:|---:|---:|
664+
/share/myfile{ext} | true | . | | false | jpg | /share/myfile.jpg
665+
/registerwebhook?url={callback} | false | | | false | http://example.org/myreceiver | /registerwebhook?url=http://example.org/myreceiver
666+
/letters?value={value} | true | | , | false | [a,b,c] | /letters?value=a,b,c
667+
/letters?value={value} | true | | , | true | [a,b,c] | /letters?value=a&value=b,c
668+
660669

661670
##### Parameter Object Examples
662671

0 commit comments

Comments
 (0)