matrix-org / matrix-org/matrix-spec
AS API ping path (SPEC-437)
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
Submitted by @kegan:matrix.org
the API should define a NOP /heartbeat path which HSes can hit on startup to check liveness of ASes. There have been many occasions where people accidently set the wrong url and having this means we can fail faster
(Imported from https://matrix.org/jira/browse/SPEC-437)
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
Read the Application Service API portion of the Matrix specification and the linked SPEC-437 context first. Determine the required NOP or heartbeat path, including its liveness-check behavior and response expectations; done means the specification defines the path clearly enough for homeservers and application services to implement consistently.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100