From 301cd830e13c0df65965735a666588ec79ef8397 Mon Sep 17 00:00:00 2001 From: Karen Etheridge Date: Fri, 31 Oct 2025 14:02:15 -0700 Subject: [PATCH 01/10] remove unneeded span markup this was added in commit 9739dfe5afa8, but now that the leading "?" has been removed, this is no longer needed --- src/oas.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/oas.md b/src/oas.md index b81e67fe8b..1faf54c0a5 100644 --- a/src/oas.md +++ b/src/oas.md @@ -1277,14 +1277,14 @@ The following table shows serialized examples, as would be shown with the `examp | label | true | _empty_ | .blue | .blue.black.brown | .R=100.G=200.B=150 | | simple | false | _empty_ | blue | blue,black,brown | R,100,G,200,B,150 | | simple | true | _empty_ | blue | blue,black,brown | R=100,G=200,B=150 | -| form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 | -| form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150 | -| spaceDelimited | false | _n/a_ | _n/a_ | color=blue%20black%20brown | color=R%20100%20G%20200%20B%20150 | +| form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 | +| form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150 | +| spaceDelimited | false | _n/a_ | _n/a_ | color=blue%20black%20brown | color=R%20100%20G%20200%20B%20150 | | spaceDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ | -| pipeDelimited | false | _n/a_ | _n/a_ | color=blue%7Cblack%7Cbrown | color=R%7C100%7CG%7C200%7CB%7C150 | +| pipeDelimited | false | _n/a_ | _n/a_ | color=blue%7Cblack%7Cbrown | color=R%7C100%7CG%7C200%7CB%7C150 | | pipeDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ | | deepObject | false | _n/a_ | _n/a_ | _n/a_ | _n/a_ | -| deepObject | true | _n/a_ | _n/a_ | _n/a_ | color%5BR%5D=100&color%5BG%5D=200&color%5BB%5D=150 | +| deepObject | true | _n/a_ | _n/a_ | _n/a_ | color%5BR%5D=100&color%5BG%5D=200&color%5BB%5D=150 | ##### Parameter Object Examples From 19eb9dea0f52f97462fc448afa30db028676f038 Mon Sep 17 00:00:00 2001 From: Karen Etheridge Date: Sat, 15 Nov 2025 14:24:44 -0800 Subject: [PATCH 02/10] "undefined" in URI Templates is not just null, but can be other things ..such as an empty array or object --- src/oas.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/oas.md b/src/oas.md index 1faf54c0a5..3c3a38bc22 100644 --- a/src/oas.md +++ b/src/oas.md @@ -4361,7 +4361,7 @@ parameters: type: string ``` -This example is equivalent to RFC6570's `{?foo*,bar}`, and **NOT** `{?foo*}{&bar}`. The latter is problematic because if `foo` is not defined, the result will be an invalid URI. +This example is equivalent to RFC6570's `{?foo*,bar}`, and **NOT** `{?foo*}{&bar}`. The latter is problematic because if `foo` is not defined (see [RFC6570 ยง2.3](https://www.rfc-editor.org/rfc/rfc6570#section-2.3) for details on what is considered undefined), the result will be an invalid URI. The `&` prefix operator has no equivalent in the Parameter Object. Note that RFC6570 does not specify behavior for compound values beyond the single level addressed by `explode`. The result of using objects or arrays where no behavior is clearly specified for them is implementation-defined. From ce2a3f70512c3c2ef4ada1287a46df0d9eb2a10b Mon Sep 17 00:00:00 2001 From: Karen Etheridge Date: Sat, 15 Nov 2025 14:31:14 -0800 Subject: [PATCH 03/10] the schema isn't just for specifying the expected type --- src/oas.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/oas.md b/src/oas.md index 3c3a38bc22..79dec23388 100644 --- a/src/oas.md +++ b/src/oas.md @@ -1177,7 +1177,7 @@ Serializing with `schema` is NOT RECOMMENDED for `in: "cookie"` parameters; see | style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `"query"` - `"form"`; for `"path"` - `"simple"`; for `"header"` - `"simple"`; for `"cookie"` - `"form"`. | | explode | `boolean` | When this is true, parameter values of type `array` or `object` generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this field has no effect. When [`style`](#parameter-style) is `"form"`, the default value is `true`. For all other styles, the default value is `false`. Note that despite `false` being the default for `deepObject`, the combination of `false` with `deepObject` is undefined. | | allowReserved | `boolean` | When this is true, parameter values are serialized using reserved expansion, as defined by [RFC6570](https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.3), which allows [RFC3986's reserved character set](https://datatracker.ietf.org/doc/html/rfc3986#section-2.2), as well as percent-encoded triples, to pass through unchanged, while still percent-encoding all other disallowed characters (including `%` outside of percent-encoded triples). Applications are still responsible for percent-encoding reserved characters that are [not allowed in the query string](https://datatracker.ietf.org/doc/html/rfc3986#section-3.4) (`[`, `]`, `#`), or have a special meaning in `application/x-www-form-urlencoded` (`-`, `&`, `+`); see [URL Percent-Encoding](#url-percent-encoding) for details. This field only applies to parameters with an `in` value of `query`. The default value is `false`. | -| schema | [Schema Object](#schema-object) | The schema defining the type used for the parameter. | +| schema | [Schema Object](#schema-object) | The schema defining the type and other constraints used for the parameter. | | example | Any | Example of the parameter's potential value; see [Working With Examples](#working-with-examples). | | examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the parameter's potential value; see [Working With Examples](#working-with-examples). | From 14d3b2c00d563a0a21def65a1d63c956c26f17fb Mon Sep 17 00:00:00 2001 From: Karen Etheridge Date: Sat, 15 Nov 2025 14:34:08 -0800 Subject: [PATCH 04/10] as per section 4.8.2, path parameter names cannot contain braces --- src/schemas/validation/schema.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/schemas/validation/schema.yaml b/src/schemas/validation/schema.yaml index f4059cb1d3..6cb88851c0 100644 --- a/src/schemas/validation/schema.yaml +++ b/src/schemas/validation/schema.yaml @@ -369,6 +369,8 @@ $defs: const: path then: properties: + name: + pattern: '^[^{}]+$' style: default: simple enum: From 1e125115dbaae9b4caa55152947c602d29e6b862 Mon Sep 17 00:00:00 2001 From: Karen Etheridge Date: Sun, 23 Nov 2025 13:08:42 -0800 Subject: [PATCH 05/10] allowReserved only permitted in encoding objects, and parameter objects with in:query (this was changed in 3.2.0 to allow it wherever percent-encoding is done) --- src/schemas/validation/schema.yaml | 7 ++++--- .../fail/header-object-allowReserved.yaml | 12 ++++++++++++ ...meter-object-cookie-form-allowReserved.yaml | 18 ++++++++++++++++++ .../parameter-object-header-allowReserved.yaml | 11 +++++++++++ .../parameter-object-path-allowReserved.yaml | 11 +++++++++++ ...ailparameter-object-path-allowReserved.yaml | 12 ++++++++++++ tests/schema/pass/header-object-examples.yaml | 2 +- .../parameter-object-query-allowReserved.yaml | 11 +++++++++++ 8 files changed, 80 insertions(+), 4 deletions(-) create mode 100644 tests/schema/fail/header-object-allowReserved.yaml create mode 100644 tests/schema/fail/parameter-object-cookie-form-allowReserved.yaml create mode 100644 tests/schema/fail/parameter-object-header-allowReserved.yaml create mode 100644 tests/schema/fail/parameter-object-path-allowReserved.yaml create mode 100644 tests/schema/failparameter-object-path-allowReserved.yaml create mode 100644 tests/schema/pass/parameter-object-query-allowReserved.yaml diff --git a/src/schemas/validation/schema.yaml b/src/schemas/validation/schema.yaml index 6cb88851c0..453bcaab0c 100644 --- a/src/schemas/validation/schema.yaml +++ b/src/schemas/validation/schema.yaml @@ -421,6 +421,7 @@ $defs: style: default: form const: form + $ref: '#/$defs/explode-for-form' $ref: '#/$defs/specification-extensions' unevaluatedProperties: false @@ -510,6 +511,7 @@ $defs: properties: allowReserved: default: false + $ref: '#/$defs/styles-for-form' explode: properties: style: @@ -520,9 +522,8 @@ $defs: properties: style: default: form - allOf: - - $ref: '#/$defs/specification-extensions' - - $ref: '#/$defs/styles-for-form' + $ref: '#/$defs/styles-for-form' + $ref: '#/$defs/specification-extensions' unevaluatedProperties: false responses: diff --git a/tests/schema/fail/header-object-allowReserved.yaml b/tests/schema/fail/header-object-allowReserved.yaml new file mode 100644 index 0000000000..0babaf22df --- /dev/null +++ b/tests/schema/fail/header-object-allowReserved.yaml @@ -0,0 +1,12 @@ +openapi: 3.1.0 +info: + title: "allowReserved only permitted with in: query" + version: 1.0.0 +components: + headers: + Style: + schema: + type: array + style: simple + explode: true + allowReserved: true diff --git a/tests/schema/fail/parameter-object-cookie-form-allowReserved.yaml b/tests/schema/fail/parameter-object-cookie-form-allowReserved.yaml new file mode 100644 index 0000000000..ee88d3ac79 --- /dev/null +++ b/tests/schema/fail/parameter-object-cookie-form-allowReserved.yaml @@ -0,0 +1,18 @@ +openapi: 3.1.0 +info: + title: allowReserved only permitted with in and style values that percent-encode + version: 1.0.0 +components: + parameters: + style_form: + name: my_form_cookie + in: cookie + # default style is form, therefore allowReserved is allowed + allowReserved: true + schema: {} + style_cookie: + name: my_cookie_cookie + in: cookie + style: cookie + # no percent decoding for style=cookie, therefore allowReserved is not allowed + schema: {} diff --git a/tests/schema/fail/parameter-object-header-allowReserved.yaml b/tests/schema/fail/parameter-object-header-allowReserved.yaml new file mode 100644 index 0000000000..4b956a080d --- /dev/null +++ b/tests/schema/fail/parameter-object-header-allowReserved.yaml @@ -0,0 +1,11 @@ +openapi: 3.1.0 +info: + title: allowReserved only permitted with in and style values that percent-encode + version: 1.0.0 +components: + parameters: + header: + name: my-header + in: header + allowReserved: false + schema: {} diff --git a/tests/schema/fail/parameter-object-path-allowReserved.yaml b/tests/schema/fail/parameter-object-path-allowReserved.yaml new file mode 100644 index 0000000000..09a5f94a86 --- /dev/null +++ b/tests/schema/fail/parameter-object-path-allowReserved.yaml @@ -0,0 +1,11 @@ +openapi: 3.1.0 +info: + title: "allowReserved only permitted with in: query" + version: 1.0.0 +components: + parameters: + path: + name: my-path + in: path + allowReserved: false + schema: {} diff --git a/tests/schema/failparameter-object-path-allowReserved.yaml b/tests/schema/failparameter-object-path-allowReserved.yaml new file mode 100644 index 0000000000..1d01ac62e0 --- /dev/null +++ b/tests/schema/failparameter-object-path-allowReserved.yaml @@ -0,0 +1,12 @@ +openapi: 3.1.0 +info: + title: api + version: 1.0.0 +components: + parameters: + path: + name: my-path + in: path + required: true + allowReserved: false + schema: {} diff --git a/tests/schema/pass/header-object-examples.yaml b/tests/schema/pass/header-object-examples.yaml index 7b91efbbae..305e598486 100644 --- a/tests/schema/pass/header-object-examples.yaml +++ b/tests/schema/pass/header-object-examples.yaml @@ -22,4 +22,4 @@ components: schema: type: array style: simple - explode: true \ No newline at end of file + explode: true diff --git a/tests/schema/pass/parameter-object-query-allowReserved.yaml b/tests/schema/pass/parameter-object-query-allowReserved.yaml new file mode 100644 index 0000000000..26f89ab781 --- /dev/null +++ b/tests/schema/pass/parameter-object-query-allowReserved.yaml @@ -0,0 +1,11 @@ +openapi: 3.1.0 +info: + title: "allowReserved only permitted with in: query" + version: 1.0.0 +components: + parameters: + my_query: + name: my_query + in: query + allowReserved: true + schema: {} From d74d33ab571709ed0306cfe607c8e69f74c36b0b Mon Sep 17 00:00:00 2001 From: Karen Etheridge Date: Sun, 23 Nov 2025 13:46:24 -0800 Subject: [PATCH 06/10] fix style, explode, allowReserved defaults for parameter and encoding objects - explode defaults were wrong for encoding object - allowReserved defaults were wrong for encoding object in parameter objects: - explode: always false for "in: path", "in: header" - explode: always true for "in: cookie" ("style: form" is the only option, and defaults to "explode: true") - explode: only true for "in: query" when "style: form" (the default style for this location) in encoding objects: - style: default is "form", but only when "explode" or "allowReserved" are present - explode: default is true when "style: form" (the default style) and otherwise false, and not included at all unless "style" or "allowReserved" are present - allowReserved: default is false, but only when "style" or "explode" are present that is: when none of style, explode or allowReserved are present, "contentType" is used (or a default is calculated), so none of style, explode or allowReserved shall have default values --- src/schemas/validation/schema.yaml | 15 +++++++++------ .../schema/pass/parameter-object-examples.yaml | 17 ++++++++++++----- 2 files changed, 21 insertions(+), 11 deletions(-) diff --git a/src/schemas/validation/schema.yaml b/src/schemas/validation/schema.yaml index 453bcaab0c..565fe8545f 100644 --- a/src/schemas/validation/schema.yaml +++ b/src/schemas/validation/schema.yaml @@ -359,7 +359,6 @@ $defs: - $ref: '#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-header' - $ref: '#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-query' - $ref: '#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-cookie' - - $ref: '#/$defs/styles-for-form' $defs: styles-for-path: @@ -379,6 +378,8 @@ $defs: - simple required: const: true + explode: + default: false required: - required @@ -392,6 +393,8 @@ $defs: style: default: simple const: simple + explode: + default: false styles-for-query: if: @@ -410,6 +413,7 @@ $defs: allowReserved: default: false type: boolean + $ref: '#/$defs/explode-for-form' styles-for-cookie: if: @@ -511,7 +515,7 @@ $defs: properties: allowReserved: default: false - $ref: '#/$defs/styles-for-form' + $ref: '#/$defs/explode-for-form' explode: properties: style: @@ -522,7 +526,7 @@ $defs: properties: style: default: form - $ref: '#/$defs/styles-for-form' + $ref: '#/$defs/explode-for-form' $ref: '#/$defs/specification-extensions' unevaluatedProperties: false @@ -959,13 +963,12 @@ $defs: additionalProperties: type: string - styles-for-form: + explode-for-form: + $comment: for encoding objects, and query and cookie parameters, style=form is the default if: properties: style: const: form - required: - - style then: properties: explode: diff --git a/tests/schema/pass/parameter-object-examples.yaml b/tests/schema/pass/parameter-object-examples.yaml index fe6a13ea7c..30c7b29058 100644 --- a/tests/schema/pass/parameter-object-examples.yaml +++ b/tests/schema/pass/parameter-object-examples.yaml @@ -9,21 +9,23 @@ paths: in: header description: token to be passed as a header required: true + explode: false schema: type: array items: type: integer format: int64 style: simple - - name: username + - name: usernames in: path - description: username to fetch + description: usernames to fetch required: true + explode: false schema: - type: string + type: array - name: id in: query - description: ID of the object to fetch + description: IDs of the object to fetch required: false schema: type: array @@ -51,4 +53,9 @@ paths: lat: type: number long: - type: number \ No newline at end of file + type: number + - in: cookie + name: my_cookie1 + style: form + explode: false + schema: {} From 4acc945a1528c399c7ad10cc307128731f954d08 Mon Sep 17 00:00:00 2001 From: Karen Etheridge Date: Tue, 16 Dec 2025 14:59:23 -0800 Subject: [PATCH 07/10] working examples of parameter and encoding object permutations with all defaults omitted tested with: $ openapi-validate --with-defaults tests/schema/pass/style-defaults.yaml { "defaults" : { "/components/parameters/cookie_form/deprecated" : false, "/components/parameters/cookie_form/explode" : true, "/components/parameters/cookie_form/required" : false, "/components/parameters/cookie_form/style" : "form", "/components/parameters/cookie_media_type/deprecated" : false, "/components/parameters/cookie_media_type/required" : false, "/components/parameters/encoding_object_defaults/content/encoding_object_defaults/encoding/allowReserved/explode" : true, "/components/parameters/encoding_object_defaults/content/encoding_object_defaults/encoding/allowReserved/style" : "form", "/components/parameters/encoding_object_defaults/content/encoding_object_defaults/encoding/explode/allowReserved" : false, "/components/parameters/encoding_object_defaults/content/encoding_object_defaults/encoding/explode/style" : "form", "/components/parameters/encoding_object_defaults/content/encoding_object_defaults/encoding/style_form/allowReserved" : false, "/components/parameters/encoding_object_defaults/content/encoding_object_defaults/encoding/style_form/explode" : true, "/components/parameters/encoding_object_defaults/content/encoding_object_defaults/encoding/style_spaceDelimited/allowReserved" : false, "/components/parameters/encoding_object_defaults/content/encoding_object_defaults/encoding/style_spaceDelimited/explode" : false, "/components/parameters/encoding_object_defaults/deprecated" : false, "/components/parameters/encoding_object_defaults/required" : false, "/components/parameters/header/deprecated" : false, "/components/parameters/header/explode" : false, "/components/parameters/header/style" : "simple", "/components/parameters/path_label/deprecated" : false, "/components/parameters/path_label/explode" : false, "/components/parameters/path_matrix/deprecated" : false, "/components/parameters/path_matrix/explode" : false, "/components/parameters/path_media_type/deprecated" : false, "/components/parameters/path_simple/deprecated" : false, "/components/parameters/path_simple/explode" : false, "/components/parameters/path_simple/style" : "simple", "/components/parameters/query_deepObject/allowEmptyValue" : false, "/components/parameters/query_deepObject/allowReserved" : false, "/components/parameters/query_deepObject/deprecated" : false, "/components/parameters/query_deepObject/explode" : false, "/components/parameters/query_deepObject/required" : false, "/components/parameters/query_form/allowEmptyValue" : false, "/components/parameters/query_form/allowReserved" : false, "/components/parameters/query_form/deprecated" : false, "/components/parameters/query_form/explode" : true, "/components/parameters/query_form/required" : false, "/components/parameters/query_form/style" : "form", "/components/parameters/query_media_type/allowEmptyValue" : false, "/components/parameters/query_media_type/deprecated" : false, "/components/parameters/query_media_type/required" : false, "/components/parameters/query_pipeDelimited/allowEmptyValue" : false, "/components/parameters/query_pipeDelimited/allowReserved" : false, "/components/parameters/query_pipeDelimited/deprecated" : false, "/components/parameters/query_pipeDelimited/explode" : false, "/components/parameters/query_pipeDelimited/required" : false, "/components/parameters/query_spaceDelimited/allowEmptyValue" : false, "/components/parameters/query_spaceDelimited/allowReserved" : false, "/components/parameters/query_spaceDelimited/deprecated" : false, "/components/parameters/query_spaceDelimited/explode" : false, "/components/parameters/query_spaceDelimited/required" : false, "/jsonSchemaDialect" : "https://spec.openapis.org/oas/3.1/dialect/WORK-IN-PROGRESS", "/servers" : [ { "url" : "/" } ] }, "valid" : true } (executable is part of https://github.com/karenetheridge/OpenAPI-Modern) --- tests/schema/pass/style-defaults.yaml | 102 ++++++++++++++++++++++++++ 1 file changed, 102 insertions(+) create mode 100644 tests/schema/pass/style-defaults.yaml diff --git a/tests/schema/pass/style-defaults.yaml b/tests/schema/pass/style-defaults.yaml new file mode 100644 index 0000000000..c3942bdc50 --- /dev/null +++ b/tests/schema/pass/style-defaults.yaml @@ -0,0 +1,102 @@ +openapi: 3.1.0 +info: + title: various permutations of parameter objects, with non-required values left to their defaults + version: 1.0.0 +components: + parameters: + encoding_object_defaults: + name: encoding_object_defaults + in: path + content: + encoding_object_defaults: # media type name + encoding: + no_styles: # property name + x-comment: "style, explode and allowReserved are not present, so contentType is used; no defaults expected as default contentType cannot be determined by the schema" + style_form: + x-comment: "expecting defaults: explode=true, allowReserved=false" + style: form + style_spaceDelimited: + x-comment: "expecting defaults: explode=false, allowReserved=false" + style: spaceDelimited + explode: + x-comment: "expecting defaults: style=form, allowReserved=false" + explode: false + allowReserved: + x-comment: "expecting default: style=form, explode=true" + allowReserved: true + path_media_type: + x-comment: "expecting defaults: deprecated=false" + name: path_media-type + in: path + required: true + content: + text/*: + schema: {} + path_simple: + x-comment: "expecting defaults: deprecated=false, style=simple, explode=false, allowReserved=false" + name: path_simple + in: path + required: true + schema: {} + path_matrix: + x-comment: "expecting defaults: deprecated=false, explode=false, allowReserved=false" + name: path_matrix + in: path + required: true + style: matrix + schema: {} + path_label: + x-comment: "expecting defaults: deprecated=false, explode=false, allowReserved=false" + name: path_label + in: path + required: true + style: label + schema: {} + query_media_type: + x-comment: "expecting defaults: required=false, deprecated=false, allowEmptyValue=false" + name: query_media_type + in: query + content: + text/*: + schema: {} + query_form: + x-comment: "expecting defaults: required=false, deprecated=false, allowEmptyValue=false, style=form, explode=true, allowReserved=false" + name: query_form + in: query + schema: {} + query_spaceDelimited: + x-comment: "expecting defaults: required=false, deprecated=false, allowEmptyValue=false, explode=false, allowReserved=false" + name: query_spaceDelimited + in: query + style: spaceDelimited + schema: {} + query_pipeDelimited: + x-comment: "expecting defaults: required=false, deprecated=false, allowEmptyValue=false, explode=false, allowReserved=false" + name: query_pipeDelimited + in: query + style: pipeDelimited + schema: {} + query_deepObject: + x-comment: "expecting defaults: required=false, deprecated=false, allowEmptyValue=false, allowReserved=false" + name: query_deepObject + in: query + style: deepObject + schema: {} + header: + x-comment: "expecting defaults: deprecated=false, style=simple, explode=false, allowReserved=false" + name: header + in: path + required: true + schema: {} + cookie_media_type: + x-comment: "expecting defaults: required=false, deprecated=false" + name: cookie_media_type + in: cookie + content: + text/*: + schema: {} + cookie_form: + x-comment: "expecting defaults: required=false, deprecated=false, style=form, explode=true, allowReserved=false" + name: cookie_form + in: cookie + schema: {} From 9922fe3e5be278ed75c4cd829b47f2aa40c01de7 Mon Sep 17 00:00:00 2001 From: Karen Etheridge Date: Sat, 24 Jan 2026 11:48:43 -0800 Subject: [PATCH 08/10] fix broken example For the Appendix C.4 example, "words" is said to not explode its values. --- src/oas.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/oas.md b/src/oas.md index 79dec23388..5a86990985 100644 --- a/src/oas.md +++ b/src/oas.md @@ -4423,6 +4423,7 @@ parameters: type: array items: type: string + explode: false ``` This translates to the following URI Template: From be8151162b43c5b2d4944f3c59dd1ab6024c7008 Mon Sep 17 00:00:00 2001 From: Karen Etheridge Date: Sat, 15 Nov 2025 14:31:04 -0800 Subject: [PATCH 09/10] mention deserialization too --- src/oas.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/oas.md b/src/oas.md index 5a86990985..e7c490f03a 100644 --- a/src/oas.md +++ b/src/oas.md @@ -1140,7 +1140,7 @@ There are four possible parameter locations specified by the `in` field: ##### Fixed Fields -The rules for serialization of the parameter are specified in one of two ways. +The rules for serialization and deserialization of the parameter are specified in one of two ways. Parameter Objects MUST include either a `content` field or a `schema` field, but not both. See [Appendix B](#appendix-b-data-type-conversion) for a discussion of converting values of various types to string representations. From e8902391601fc5a5e7dee69c63cea96f1d3821e8 Mon Sep 17 00:00:00 2001 From: Karen Etheridge Date: Sat, 15 Nov 2025 14:31:04 -0800 Subject: [PATCH 10/10] specify how query parameters are added to the URL ..and remove example that is specific to a particular style, explode and schema type configuration --- src/oas.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/oas.md b/src/oas.md index e7c490f03a..1b35b81252 100644 --- a/src/oas.md +++ b/src/oas.md @@ -1134,7 +1134,7 @@ See [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a detail There are four possible parameter locations specified by the `in` field: * path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. -* query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. +* query - Parameters that are appended to the URL with the `?` character (or for subsequent query parameters, with the `&` character). * header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#section-3.2) states header names are case insensitive. * cookie - Used to pass a specific cookie value to the API.