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.

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

MSC2946: Spaces Summary #2946

Merged
merged 77 commits into from
Oct 31, 2021
Merged
Changes from 1 commit
Commits
Show all changes
77 commits
Select commit Hold shift + click to select a range
059f324
Spaces Summary
kegsay Jan 7, 2021
14eb56c
MSC2946
kegsay Jan 7, 2021
aea5336
Clarity
kegsay Jan 7, 2021
7618ed6
More clarity
kegsay Jan 7, 2021
6e051d5
Clarify what no room data means for clients
kegsay Jan 7, 2021
619c100
Federation API
kegsay Jan 13, 2021
104cf78
Update 2946-spaces-summary.md
kegsay Jan 13, 2021
8f6fb9d
auto_join filter
kegsay Jan 13, 2021
200147c
Blurb on auth for fed api
kegsay Jan 13, 2021
f2457cf
Update to reflect MSC1772 changes
kegsay Jan 15, 2021
1430661
Mention auth chain on federation api
kegsay Jan 15, 2021
09b0848
Add 'version' field
kegsay Jan 18, 2021
7b2f3dc
Stripped state; remove room versions
kegsay Jan 19, 2021
6224859
Update 2946-spaces-summary.md
kegsay Feb 25, 2021
211e5e6
Update proposals/2946-spaces-summary.md
kegsay Mar 15, 2021
725277e
Replace with link to draft doc.
richvdh Mar 23, 2021
0fd8d8d
Add a preamble and copy the current draft API.
clokep Apr 13, 2021
dee9040
Switch to using stable identifiers (and add an unstable identifiers s…
clokep Apr 13, 2021
a3b62a8
Updates / clarifications.
clokep Apr 13, 2021
f28ad9b
Fix typo.
clokep Apr 14, 2021
d911c82
Clean-ups.
clokep Apr 14, 2021
74f12d5
Update proposals/2946-spaces-summary.md
ara4n Apr 30, 2021
8b1fe00
Drop unstable identifiers from MSC1772.
clokep May 3, 2021
8fdbfb1
Various updates and clarifications.
clokep May 4, 2021
f145fa3
Include the origin_server_ts in the response, as needed by MSC1772.
clokep May 5, 2021
f9c00a5
Rename a parameter for clarity.
clokep May 5, 2021
9c2e85a
Fix typo.
clokep May 5, 2021
760cda8
Various clarifications based on feedback.
clokep May 5, 2021
a5ad9a4
Add auth / rate-limiting info.
clokep May 6, 2021
4c10e02
Combine some double spaces.
clokep May 6, 2021
ad5af4d
Use only GET endpoints.
clokep May 6, 2021
dba41f9
Add notes about DoS potential.
clokep May 6, 2021
8a968eb
Tweaks from review.
clokep May 6, 2021
b379c42
Add context about why stripped events are returned.
clokep May 6, 2021
27f526c
Remove some implementation details.
clokep May 6, 2021
c142433
Add notes on ordering.
clokep May 10, 2021
af8c7b0
Remove unnecessary data.
clokep May 10, 2021
bcde9e0
Clarify the server-server API.
clokep May 10, 2021
328ae81
More clarifications.
clokep May 10, 2021
518db51
Remove obsolete note.
clokep May 11, 2021
3b0051f
Some clarifications to what accessible means.
clokep May 19, 2021
5cd8270
Update notes about sorting to include the origin_server_ts of the m.s…
clokep May 19, 2021
797dda4
Only consider `m.space` rooms and do not return links to nowhere.
clokep Jun 11, 2021
105fd93
Updates based on MSC3173 merging and updates to MSC3083.
clokep Jun 25, 2021
a7a08eb
Updates per MSC2403.
clokep Jul 2, 2021
094de30
Remove field which is not part of the C-S API.
clokep Jul 27, 2021
c0a63ab
Rewrite the proposal.
clokep Jul 28, 2021
3d7769f
Handle todo comments.
clokep Jul 28, 2021
5627721
Update URLs.
clokep Jul 29, 2021
7d0c8f6
Rename field.
clokep Jul 29, 2021
420d698
Updates based on implementation.
clokep Aug 9, 2021
5cd0db4
Clarify the state which is persisted.
clokep Aug 10, 2021
14bdc42
Expand notes about errors.
clokep Aug 10, 2021
00d3d67
Update MSC with pagination parameter.
clokep Aug 11, 2021
e39eac3
Fix wrong endpoint.
clokep Aug 13, 2021
6823998
Clarifications based on implementation.
clokep Aug 27, 2021
5a5a404
Remove empty section.
clokep Sep 7, 2021
0174348
Fix typo.
clokep Sep 10, 2021
545ff90
Rename field in example.
clokep Sep 21, 2021
42ba46e
Clarify error code.
clokep Sep 21, 2021
dee3b2d
Clarify ordering changes.
clokep Sep 21, 2021
a9803c3
Clarify wording.
clokep Sep 28, 2021
e9592ff
Fix typos.
clokep Sep 29, 2021
8978562
Clarify that rooms do not belong to servers.
clokep Sep 29, 2021
622f8ed
Fix example to use correct URL.
clokep Sep 29, 2021
6ad9ead
Clarify using local vs. remote data.
clokep Sep 29, 2021
482597e
Clarify bits aboud stripped state.
clokep Sep 29, 2021
41bfaa5
Clarify access control of federation responses.
clokep Sep 29, 2021
f6f41b1
Clarify error code.
clokep Sep 29, 2021
828c076
Be less prescriptive about expiring data.
clokep Oct 5, 2021
7fd45e5
Limit must be non-zero.
clokep Oct 6, 2021
902a124
Rate limiting.
clokep Oct 6, 2021
bf5f84d
Add a note about room upgrades.
clokep Oct 6, 2021
b43333a
Update stable URLs per MSC2844.
clokep Oct 12, 2021
c74adf7
Clarify federation return values.
clokep Oct 12, 2021
fe5a9a7
Clarify `origin_server_ts`.
clokep Oct 26, 2021
a9f6cf6
Tweak wording around `inaccessible_children`.
clokep Oct 26, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Only consider m.space rooms and do not return links to nowhere.
  • Loading branch information
clokep committed Jun 11, 2021
commit 797dda44c4158e83dcff017f1ef2f36d7c2c4f3c
10 changes: 5 additions & 5 deletions proposals/2946-spaces-summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ An endpoint is provided to walk the space tree, starting at the provided room ID
("the root room"), and visiting other rooms/spaces found via `m.space.child`
events. It recurses into the children and into their children, etc.

Note that there is no requirement for any of the rooms to be of have a `type` of
`m.space`, any room with `m.space.child` events is considered.
Note that only rooms that have a `type` of `m.space` are considered when searching
for `m.space.child` events.

This endpoint requires authentication and is not subject to rate-limiting.
clokep marked this conversation as resolved.
Show resolved Hide resolved

clokep marked this conversation as resolved.
Show resolved Hide resolved
Expand Down Expand Up @@ -140,10 +140,10 @@ A rough algorithm follows:

Other notes:

* Any inaccessible children are omitted from the result, but the `m.space.child`
events that point to them are still returned.
* Any inaccessible children are omitted from the result, as well as the
`m.space.child` events that point to them.
* There could be loops in the returned child events - clients (and servers)
should handle this gracefully.
should handle this gracefully.
* Similarly, note that a child room might appear multiple times (e.g. also be a
grandchild). Clients and servers should handle this appropriately.
* `suggested_only` applies transitively.
Expand Down