matrix-org / matrix-org/matrix-spec

`OneTimeKeys` is not defined by the CS API spec

Open
#1,287 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-Client-Server 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/unstable/client-server-api/#post_matrixclientv3keysupload

Issue
fallback_keys and one_time_keys are defined as OneTimeKeys. This type is not defined in the client-server spec.

There are no mandatory keys for OneTimeKeys. I expect this confuses our go template langauge machinery.

https://github.com/matrix-org/matrix-spec/blob/dcc1f4adee2be41069045ddbf3ef913e9c19d116/data/api/client-server/definitions/one_time_keys.yaml#L1-L24

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 data/api/client-server/definitions/one_time_keys.yaml and compare it with the POST /_matrix/client/v3/keys/upload section linked in the issue. Check how the Go template machinery consumes this definition; done means OneTimeKeys is defined consistently and the spec no longer references an undefined type.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, yaml
Domain
api, documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.