Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation of how third party invites work #1366

Closed
richvdh opened this issue Jul 4, 2018 · 4 comments
Closed

Improve documentation of how third party invites work #1366

richvdh opened this issue Jul 4, 2018 · 4 comments
Labels
clarification An area where the spec could do with being more explicit
Projects
August 2018 r0

Comments

@richvdh
Copy link
Member

richvdh commented Jul 4, 2018 •
edited
Loading

This is a complicated dance possibly involving multiple HSes and multiple ISes. https://matrix.org/docs/spec/client_server/unstable.html#third-party-invites has some documentation but fails to document the full exchange_third_party_invite dance.
@richvdh
Copy link
Member Author

richvdh commented Jul 4, 2018

Some of the implementation of this seems to have landed in matrix-org/synapse@2cebe535 without any documentation as to how it is supposed to work.

Dave has started some notes at https://docs.google.com/document/d/1WR9fn5ar8WiWrYTFV6SSm0oN1CF3GsjQnT2vU3nkL6Y, which we can try to build from.

Sequence diagrams would be helpful.

@turt2live
Copy link
Member

(doc not public)

@richvdh
Copy link
Member Author

richvdh commented Jul 4, 2018

(doc not public)

fixed I hope

@turt2live turt2live added the clarification An area where the spec could do with being more explicit label Jul 10, 2018
@turt2live
Copy link
Member

turt2live commented Jul 10, 2018 •
edited
Loading

Dendrite PRs:

@turt2live turt2live mentioned this issue Jul 31, 2018
Closed
35 tasks
turt2live added a commit to turt2live/matrix-doc that referenced this issue Aug 13, 2018
@turt2live
Clarify how third party invites work
88b35d1 
This adds several diagrams to the Client-Server API about how invites
are handled, including what the server is expected to do. This helps
implementors know what they are supposed to do in the common cases,
and infer where needed to get the more complex cases correct.

Although lacking in some areas, this is how third party invites work
today.

A link to the now-improved client-server documentation for third party
invites has been added to the server-server specification. The existing
server-server specification needed no further changes on the subject.

Fixes matrix-org#1366
@turt2live turt2live mentioned this issue Aug 13, 2018
Merged
@turt2live turt2live added this to In review in August 2018 r0 Aug 14, 2018
@turt2live turt2live moved this from In review to In review (just the issues) in August 2018 r0 Aug 24, 2018
August 2018 r0 automation moved this from In review (just the issues) to Done (this list will be incomplete) Aug 31, 2018
RiotTranslateBot pushed a commit to RiotTranslateBot/matrix-doc that referenced this issue Aug 22, 2023
@uhoreg
Add spec for getting events by timestamp (matrix-org#1366)
94465fe
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
clarification An area where the spec could do with being more explicit
Projects
No open projects
August 2018 r0
  
Done (this list will be incomplete)
Milestone
No milestone
Development

No branches or pull requests
2 participants
@turt2live @richvdh