Spec text incorrectly renders query parameters of type object
#1993
Labels
clarification
An area where the expected behaviour is understood, but the spec could do with being more explicit
Link to problem area:
https://spec.matrix.org/v1.12/client-server-api/#get_matrixclientv3thirdpartyuserprotocol, https://spec.matrix.org/v1.12/application-service-api/#get_matrixappv1thirdpartyuserprotocol, and others.
Issue
Certain APIs are specified by the OpenAPI definitions as taking query parameters of type
object
. You might wonder how an object can be passed as a query parameter. The relevant part of the OpenAPI spec is the definition of the Parameter Object; in particular the rules for serialization of the parameter. The relevant OpenAPI fields arestyle
(which is specified to default toform
for query parameters) andexplode
(which defaults totrue
whenstyle
isform
). The style examples table then gives an example serialization ofR=100&G=200&B=150
for an object containing keysR
,G
andB
.The spec text doesn't make that at all clear. The parameter table is just plain misleading.
The text was updated successfully, but these errors were encountered: