matrix-org / matrix-org/matrix-spec

Identity service specification uses a wide range of casing for endpoints

Open
#359 0 comments 1 reaction 0 assignees View on GitHub
A-Identity-Service wart
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

Namely:
* `/store-invite` (hyphen)
* `/requestToken` (lower camel case, used and documented elsewhere in the Matrix Spec)
* `/isvalid` (lowercase)

Additionally, it is the only API that has `/api` in the route.

Contributor guide

Open the contributing guide

Research direction

Start in the Identity Service portion of the Matrix specification and compare the documented /store-invite, /requestToken, and /isvalid routes with other Matrix Spec endpoints. Check the rationale for the /api prefix and existing casing conventions before proposing a consistent specification update. Done means the routes and their documentation follow an agreed convention.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.