Matrix-doc: Federation API r0 megathread

Created on 31 Jul 2018  路  5Comments  路  Source: matrix-org/matrix-doc

This is a list of all the endpoints that are currently listed as "federation" (server-to-server), but have not been specced. Follow this issue for updates to the plan and progress.

"Ambitious goal"

This all the stuff that qualifies for the running-name of "Travis' ambitious goal". Targeting very early August for spec.

Sections (review&fix):

Endpoints:

Media/Content Repository

Targeting August for spec.

Issues:

Third party identifiers

Targeting early August for spec.

Issues:

Endpoints:

End-to-end encryption

Targeting early August for spec (synchronized with client/server documentation).

Issues:

Endpoints:

The device list stuff (https://github.com/matrix-org/matrix-doc/issues/1212) is fairly subtle and would need to be specced alongside this, i suspect (but should be a matter of porting the necessary stuff out of the prop and into the spec) --matthew

OpenID

Targeting August for spec (synchronized with client/server documentation).

Issues:

Endpoints:

Groups

Targeting August for spec (synchronized with client/server documentation).

Note: Groups have been cut from the r0 release, and will be worked out post-r0

Issues:

Endpoints:

  • GET /groups/$groupId/profile
  • POST /groups/$groupId/profile
  • GET /groups/$groupId/summary
  • GET /groups/$groupId/rooms
  • POST /groups/$groupId/room/$roomId
  • DELETE /groups/$groupId/room/$roomId
  • POST /groups/$groupId/room/$roomId/config/$configKey
  • GET /groups/$groupId/users
  • GET /groups/$groupId/invited_users
  • POST /groups/$groupId/users/$userId/invite
  • POST /groups/$groupId/users/$userId/accept_invite
  • POST /groups/$groupId/users/$userId/join
  • POST /groups/$groupId/users/$userId/remove
  • POST /groups/local/$groupId/users/$userId/invite
  • POST /groups/local/$groupId/users/$userId/remove
  • POST /groups/$groupId/renew_attestation/$userId
  • POST /groups/$groupId/summary/rooms/$roomId
  • POST /groups/$groupId/summary/categories/$category/rooms/$roomId
  • DELETE /groups/$groupId/summary/rooms/$roomId
  • DELETE /groups/$groupId/summary/categories/$category/rooms/$roomId
  • GET /groups/$groupdId/categories
  • GET /groups/$groupId/categories/$category
  • POST /groups/$groupId/categories/$category
  • DELETE /groups/$groupId/categories/$category
  • GET /groups/$groupId/roles
  • GET /groups/$groupId/roles/$roleId
  • POST /groups/$groupId/roles/$roleId
  • DELETE /groups/$groupId/roles/$roleId
  • POST /groups/$groupId/summary/users/$userId
  • POST /groups/$groupId/summary/roles/$roleId/users/$userId
  • DELETE /groups/$groupId/summary/users/$userId
  • DELETE /groups/$groupId/summary/roles/$roleId/users/$userId
  • POST /get_groups_publicised
  • PUT /groups/$groupId/settings/m.join_policy
epic s2s spec-omission
Source
picture turt2live
❤4 🎉1 👍1

Most helpful comment

I've updated the OP: Everything is done except for groups. Groups are being considered post-r0 pending some potential changes. This issue is now a placeholder for "we need to actually cut a release".

picture turt2live on 5 Sep 2018
🎉2

All 5 comments

Most of E2E should be covered by https://github.com/matrix-org/matrix-doc/pull/1284 and https://github.com/matrix-org/matrix-doc/pull/1420

uhoreg picture uhoreg on 31 Jul 2018

As far as I can tell, both of those only cover the client/server side of things. It'd be awesome if they also covered the s2s side too :)

turt2live picture turt2live on 31 Jul 2018

Ah, right. Yes, they're only CS.

uhoreg picture uhoreg on 31 Jul 2018

I've updated the OP: Everything is done except for groups. Groups are being considered post-r0 pending some potential changes. This issue is now a placeholder for "we need to actually cut a release".

turt2live picture turt2live on 5 Sep 2018
🎉2

The reminder for actually cutting an r0 is now at https://github.com/matrix-org/matrix-doc/issues/1805

turt2live picture turt2live on 17 Jan 2019
🎉1
Was this page helpful?
0 / 5 - 0 ratings

Related issues

Mikaela picture Mikaela  路  3Comments
Lapin0t picture Lapin0t  路  4Comments
matrixbot picture matrixbot  路  6Comments
turt2live picture turt2live  路  4Comments
ara4n picture ara4n  路  5Comments