matrix-org / matrix-org/matrix-spec

Spec text incorrectly renders query parameters of type `object`

Open
#1,993 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

clarification
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Matrix client-server and application-service API sections, then compare their object query-parameter rendering with OpenAPI's Parameter Object and style examples. Identify the source text covering the affected parameters; done means the specification clearly explains the form/explode serialization and the rendered sections no longer mislead readers.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.