Skip to content

Commit 2917bbf

Browse files
specify how query parameters are added to the URL, and include a reference
1 parent 6244540 commit 2917bbf

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/oas.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -769,7 +769,8 @@ See [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a detail
769769
There are five possible parameter locations specified by the `in` field:
770770

771771
* 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`.
772-
* query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`; MUST NOT appear in the same operation (or in the operation's path-item) as an `in: "querystring"` parameter.
772+
* query - Parameters that are appended to the URL with the `?` character (or to existing query parameters with the `&` character), as described by [RFC3986 section 3.4](https://datatracker.ietf.org/doc/html/rfc3986#section-3.4);
773+
MUST NOT appear in the same operation (or in the operation's path-item) as an `in: "querystring"` parameter.
773774
* querystring - A parameter that treats the entire URL query string as a value which MUST be specified using the `content` field, most often with media type `application/x-www-form-urlencoded` using [Encoding Objects](#encoding-object) in the same way as with request bodies of that media type; MUST NOT appear more than once, and MUST NOT appear in the same operation (or in the operation's path-item) as any `in: "query"` parameters.
774775
* header - Custom headers that are expected as part of the request. Note that [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.1) states header names are case-insensitive.
775776
* cookie - Used to pass a specific cookie value to the API.

0 commit comments

Comments
 (0)