wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
docs-matrix-spec/api/client-server
History
Travis Ralston 2ac80d38d7 Document the /publicRooms endpoint for federation 
This intentionally doesn't document the third party network aspect of the endpoint. This is scheduled for a later area for dealing with third party network/IDs and is reported as https://github.com/matrix-org/matrix-doc/issues/1476

The client-server response has been broken out to a shared file: both the client-server and server-server /publicRoom endpoints return the same thing, with slightly different inputs.

The inputs (and behaviour) are based upon the docstring here: 43ecfe0b10/synapse/federation/transport/server.py (L583-L612)
2018-08-03 11:23:44 -06:00
..
definitions Document the /publicRooms endpoint for federation 2018-08-03 11:23:44 -06:00
account-data.yaml Add operationId to all endpoints of all APIs 2017-10-11 01:58:31 +09:00
admin.yaml Add operationId to all endpoints of all APIs 2017-10-11 01:58:31 +09:00
administrative_contact.yaml Give all errors a schema reference 2018-07-04 13:54:52 -06:00
banning.yaml Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 2018-07-06 08:46:50 -06:00
cas_login_redirect.yaml Add operationId to all endpoints of all APIs 2017-10-11 01:58:31 +09:00
cas_login_ticket.yaml operationid -> operationId 2017-11-13 07:46:03 +09:00
content-repo.yaml Fix error reference in media repo 2018-07-06 08:53:04 -06:00
create_room.yaml Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 2018-07-18 08:28:16 -06:00
device_management.yaml add delete_devices endpoint 2018-05-16 11:50:21 +02:00
directory.yaml Give all errors a schema reference 2018-07-04 13:54:52 -06:00
event_context.yaml Add operationId to all endpoints of all APIs 2017-10-11 01:58:31 +09:00
filter.yaml Merge remote-tracking branch 'remotes/origin/master' 2017-11-13 07:46:29 +09:00
inviting.yaml Give all errors a schema reference 2018-07-04 13:54:52 -06:00
joining.yaml Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 2018-07-06 08:46:50 -06:00
keys.yaml Update keys.yaml 2018-06-26 17:46:58 +08:00
kicking.yaml Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 2018-07-06 08:46:50 -06:00
leaving.yaml Fix reference to error.yaml in forget room API 2018-07-05 16:55:11 -06:00
list_joined_rooms.yaml Added/updated operationIds according to today's updates in the spec 2017-10-11 02:22:19 +09:00
list_public_rooms.yaml Document the /publicRooms endpoint for federation 2018-08-03 11:23:44 -06:00
login.yaml Give all errors a schema reference 2018-07-04 13:54:52 -06:00
logout.yaml Document /logout/all 2018-05-27 11:45:36 -06:00
message_pagination.yaml Add a missing $ref 2018-07-04 14:14:52 -06:00
notifications.yaml Add operationId to all endpoints of all APIs 2017-10-11 01:58:31 +09:00
old_sync.yaml link to both context and event in depr notice as per review 2018-02-07 08:27:39 +00:00
peeking_events.yaml Add operationId to all endpoints of all APIs 2017-10-11 01:58:31 +09:00
presence.yaml Convert errors in presence.yaml 2018-07-12 09:31:50 -06:00
profile.yaml Describe the rate limit error everywhere 2018-07-04 13:45:34 -06:00
pusher.yaml Give all errors a schema reference 2018-07-04 13:54:52 -06:00
pushrules.yaml Give all errors a schema reference 2018-07-04 13:54:52 -06:00
receipts.yaml Describe the rate limit error everywhere 2018-07-04 13:45:34 -06:00
redaction.yaml Use the correct event_id format on examples 2018-04-03 13:18:29 +03:00
registration.yaml Give all errors a schema reference 2018-07-04 13:54:52 -06:00
report_content.yaml Document how to report content 2018-05-27 12:19:30 -06:00
room_initial_sync.yaml Add operationId to all endpoints of all APIs 2017-10-11 01:58:31 +09:00
room_send.yaml Use the correct event_id format on examples 2018-04-03 13:18:29 +03:00
room_state.yaml Use the correct event_id format on examples 2018-04-03 13:18:29 +03:00
rooms.yaml /rooms/{roomId}/members: specify access_token requirement 2018-05-17 18:51:08 +02:00
search.yaml Merge remote-tracking branch 'matrix-org/master' into travis/better-errors 2018-07-12 12:13:07 -06:00
sync.yaml move /rooms/{roomId}/event/{eventId} and update depr notice 2018-02-07 08:22:37 +00:00
tags.yaml Missing comma 2018-07-27 12:24:29 +01:00
third_party_lookup.yaml Move TODO. field1, field2... -> fields... 2018-07-30 19:21:54 +01:00
third_party_membership.yaml Give all errors a schema reference 2018-07-04 13:54:52 -06:00
to_device.yaml Add operationId to all endpoints of all APIs 2017-10-11 01:58:31 +09:00
typing.yaml Describe the rate limit error everywhere 2018-07-04 13:45:34 -06:00
users.yaml Describe the rate limit error everywhere 2018-07-04 13:45:34 -06:00
versions.yaml Add operationId to all endpoints of all APIs 2017-10-11 01:58:31 +09:00
voip.yaml Describe the rate limit error everywhere 2018-07-04 13:45:34 -06:00
whoami.yaml Give all errors a schema reference 2018-07-04 13:54:52 -06:00