matrix-org / matrix-org/matrix-spec
Spec incorrectly states that `lang` field in response to `/pushers` is required
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
**Link to problem area**: https://github.com/matrix-org/matrix-spec/blob/99e2ff4927b56db927d52e82ff802b38f6fa8407/data/api/client-server/pusher.yaml#L103
**Issue**
Synapse seems to not set that field, which seems to cause problems in SDKs generated from the openapi spec:
https://github.com/matrix-org/synapse/blob/3de82bb2af28f56696a79bf41ccffc81385b6e2c/synapse/rest/admin/users.py#L470
https://github.com/matrix-org/synapse/blob/3de82bb2af28f56696a79bf41ccffc81385b6e2c/synapse/handlers/register.py#L1022
https://github.com/famedly/dart_matrix_api_lite/pull/136
Contributor guide
Research direction
Inspect data/api/client-server/pusher.yaml around line 103 and compare the response behavior shown in the linked Synapse files. Update the schema so it matches responses where lang is omitted, then confirm that generated SDKs no longer treat lang as required.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100