Skip to content

Commit d200324

Browse files
authored
Due diligence: parameter syntax. See #25. (#124)
* Due diligence: parameter syntax. See #25. * Feedback from code review * Remove patch version to avoid misguiding implementers.
1 parent 4e28424 commit d200324

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

draft-ietf-httpapi-rest-api-mediatypes.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,9 @@ Required parameters:
138138
: None
139139

140140
Optional parameters:
141-
: version; unrecognized parameters should be ignored
141+
: version: its value is a string representing
142+
the OpenAPI Specification version.
143+
; unrecognized parameters should be ignored
142144

143145
Encoding considerations:
144146
: Same as "application/json"
@@ -198,7 +200,9 @@ Required parameters:
198200
: N/A
199201

200202
Optional parameters:
201-
: version; unrecognized parameters should be ignored
203+
: version: its value is a string representing
204+
the OpenAPI Specification version.
205+
; unrecognized parameters should be ignored
202206

203207
Encoding considerations:
204208
: Same as "+yaml" Structured Syntax Suffix
@@ -251,6 +255,17 @@ Interoperability requirements for media type
251255
registrations are discussed in Section 4.6 of {{!MEDIATYPE=RFC6838}}
252256
and in the Interoperability Considerations of the "+yaml" Structured Syntax Suffix.
253257

258+
## Using the version parameter
259+
260+
The `version` parameter ought to be processed
261+
according with the associated OpenAPI Specification.
262+
263+
For example, when an OpenAPI 3.1 resource
264+
uses the patch version `version=3.1.1`,
265+
its value is expected to be ignored
266+
by tooling
267+
(see https://spec.openapis.org/oas/v3.1.0.html#versions).
268+
254269
# Security Considerations {#sec}
255270

256271
Security requirements for media type

0 commit comments

Comments
 (0)