Skip to content

Spec text incorrectly renders query parameters of type object #1993

Open
@richvdh

Description

@richvdh

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 are style (which is specified to default to form for query parameters) and explode (which defaults to true when style is form). The style examples table then gives an example serialization of R=100&G=200&B=150 for an object containing keys R, G and B.

The spec text doesn't make that at all clear. The parameter table is just plain misleading.

Metadata

Metadata

Assignees

No one assigned

    Labels

    clarificationAn area where the expected behaviour is understood, but the spec could do with being more explicit

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions