matrix-org / matrix-org/matrix-spec
No explanation for why notary key endpoints return arrays
Nobody has claimed this yet.
- 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.7/server-server-api/#get_matrixkeyv2queryservername
https://spec.matrix.org/v1.7/server-server-api/#post_matrixkeyv2query
**Issue**
Both endpoints just say they return the server's keys. Why is it an array? Should the notary be returning all cached keys? Why would it cache more than one key?
Further, what is the requesting server meant to do with multiple results?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the GET /_matrix/key/v2/query/{serverName} and POST /_matrix/key/v2/query sections linked in the issue. Read the surrounding notary-key specification, then document why responses are arrays, whether cached keys may be returned, and how requesting servers should handle multiple results.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100