2 Commits (4a597ace51e600c164afd3ec82603f7426406f29)

Author	SHA1	Message	Date
Travis Ralston	97a8b0bb13	spelling	3 years ago
Hubert Chathi	16ec511e9c	MSC2675: Serverside aggregations of message relationships (#2675) ... * initial version of serverside aggregations proposal * fix MSC numbers * clarification * add e2ee section from 2674 here, as it is only needed for server-side aggregations * move edge case wrt to calling /context on a relation here from 2674 * fix typo * clarify which APIs should bundle relations * move stale_events over to future extensions section * summarize stale_events and make tone conditional to mark that is not part of the MSC * casing and wording * clarify in summary an API for requesting relations is also proposed * remove proposal for batch get event api as is unused and unimplemented * attempt to clarify relations vs aggregations * clarify pagination and align it with synapse impl already in the wild * conciseness * better headers * clarify that relations are always returned, contrary to aggregations * document the limitation of the event type not being known in e2ee rooms * specify that redacted relations are not aggregated * remove type in (non-binding) example as synapse doesn't do this * mention that these are just examples * clarify that this is a non-normative example * Update proposals/2675-aggregations-server.md Co-authored-by: David Baker <dbkr@users.noreply.github.com> * add http method for endpoint list * line break * remove "unbundled relations" term, it's just confusing instead use relation events, with the bundled form now called aggregation also restructure the headings so we have on section about aggregations and another one about querying relation events * some more restructuring of text after changing doc structure * mention original_event for m.replace relations * remove dir param as it is unused and unimplemented * clarify that relating pending events should happen by transaction_id * remove unimplemented /aggregations/{eventID}//{eventType}/{key} endpoint * Update proposals/2675-aggregations-server.md Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> * mention that the server might not be aware of all the relations * clarify that redacted events should still return their relations and aggregations respectively * remove /context edge case, it should not be special-cased * Update proposals/2675-aggregations-server.md Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> * Update proposals/2675-aggregations-server.md Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> * Update proposals/2675-aggregations-server.md Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> * bad example, replies doesn't use relations * clarify that we dont bundle discrete events * clarify that we dont bundle discrete events, again * improve example * clarify this MSC does not use a prefix * better english * clarify pagination in example * better english * remove contradication: m.reference doesn't support pagination but example mentions it * double punctuation * clarify that only the bundled aggregation limit for truncation can't be set by the client, /aggregations does have a limit param * move e2ee limitation to limitations section * clarify prefixes * mention that state events never bundle aggregations * Update proposals/2675-aggregations-server.md Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> * add that the visibility of relations can derive from that of the target * typsos * be more explicit * moar rewording * keep related parts together * don't make a relation invisible because the target event isn't also clarify what to do with relations for which the target is invisible * Update proposals/2675-aggregations-server.md Co-authored-by: David Baker <dbkr@users.noreply.github.com> * better words * Update proposals/2675-aggregations-server.md Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Update proposals/2675-aggregations-server.md Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Update proposals/2675-aggregations-server.md Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Update proposals/2675-aggregations-server.md Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * be more precise when clients should ensure the key is shared * mention that ignored users can cause different aggregations for users * move visibility rule changes to MSC3570 * don't overspecify visibility limitation, allow for unspecified behaviour as synapse includes the invisible events in the aggregation * Update proposals/2675-aggregations-server.md Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Update proposals/2675-aggregations-server.md Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Update proposals/2675-aggregations-server.md Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Update proposals/2675-aggregations-server.md Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Update proposals/2675-aggregations-server.md Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * move non-normative note to below example * make rel_type mandatory as the response structure doesn't allow for mixing types * fix typo/thinko * make pagination forward only as there is no use case for backwards * Update proposals/2675-aggregations-server.md Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * add non-normative aggregation examples * Update proposals/2675-aggregations-server.md Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * use relation type rather than rel_type the former is already define as the latter in MSC 2674 * change trailing slashes remark to event_type, rel_type is mandatory now * reword and split out client-side aggregation section * rename parent event to target event, the term used elsewhere * apply suggestion * apply suggestion * remove pagination * remove mentions of /aggregations endpoint after removing pagination * add note about not bundling into state events * restructure headers so more of the aggregations stuff is under section * make rel_type mandatory for /relations and better wording * remove confusion that aggregations contain more info than relations * Update proposals/2675-aggregations-server.md Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Update proposals/2675-aggregations-server.md Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * mention that tokens from /sync, /messages can be used on /relations * try not to be overly prescriptive * remove edge case of ignoring events without target event, as ignoring is not always safe * clarify limitation for encrypted rooms * make rel_type optional again for /relations * Update proposals/2675-aggregations-server.md Co-authored-by: Hubert Chathi <hubert@uhoreg.ca> * Update proposals/2675-aggregations-server.md Co-authored-by: Hubert Chathi <hubert@uhoreg.ca> * Update proposals/2675-aggregations-server.md Co-authored-by: Hubert Chathi <hubert@uhoreg.ca> * Update proposals/2675-aggregations-server.md Co-authored-by: Hubert Chathi <hubert@uhoreg.ca> * Update proposals/2675-aggregations-server.md Co-authored-by: Matthew Hodgson <matthew@arasphere.net> * mention requires auth and rate-limited on /relations * replace hypothetical examples for bundled aggregations with non-normative ones * move to MSC 2676 as it's specific to edits * dont repeat how local echo using transaction_id works Co-authored-by: Bruno Windels <bruno@windels.cloud> Co-authored-by: David Baker <dbkr@users.noreply.github.com> Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Co-authored-by: Matthew Hodgson <matthew@arasphere.net>	3 years ago