matrix-org / matrix-org/mjolnir

Essential improvements to the HTTP API used by https://github.com/matrix-org/mjolnir-widget

Open
#416 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-Appservice T-Task X-Release-Blocker
Dominant language
TypeScript
Stars
445
Forks
75
Avg merge
2d 44m
Merged PRs (30d)
3

Description

These are improvements that have to be coordinated with the widget, but are also needed to be implemented before any other changes are made.

- [ ] Put the openID token into the authorization header as a Bearer token and validate the request with middleware so we're not bodging it in each api endpoint.
- [ ] Declaratively specify the format of request bodies for validation using some middleware for express.
- [ ] Namespace the endpoints, we are almost certainly going to have a web api for controlling a specific mjolnir in future too and these shouldn't clash.
- [ ] Update the test client used for the appservice integration tests accordingly
- [ ] Can resolve openID tokens from different homeservers than just the one the appservice is deployed on https://github.com/matrix-org/mjolnir/pull/364/files#r1023075345

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 checklist and the linked discussion about resolving OpenID tokens, then locate the Express API middleware and the appservice integration test client. Coordinate the API changes with mjolnir-widget; done means bearer-token validation, declarative request-body validation, namespaced endpoints, updated integration tests, and cross-homeserver token resolution.

Written by the indexing model from the issue text.

Assessment

Tech stack
express, typescript
Domain
api, authentication, backend, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.