matrix-org / matrix-org/matrix-spec

POST account/3pid example suggests it could return submit_url

Open
#544 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-Client-Server spec-bug
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

In POST /_matrix/client/r0/account/3pid, there is an example response:

{
  "submit_url": "https://example.org/path/to/submitToken"
}

that suggests the API could return a submit_url, but this seems like a spec bug, as it doesn't make sense to have a submit URL here.

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 linked POST /_matrix/client/r0/account/3pid specification section and inspect the example response in context. Confirm whether the submit_url field is inconsistent with this endpoint, then update the example and check the surrounding specification text for related references.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.