Mark Haines
ed0f6d3ff3
Typo
9 years ago
Mark Haines
97cdd8106c
s|client/api/v2_alpha|/client/v2_alpha|
9 years ago
Mark Haines
047419f2ad
Remove the room_id since it is redundent. Remove text about invite event handling till we've thought about it some more.
9 years ago
Mark Haines
bde003fe86
Split the rooms out into a separate top level key.
...
Divide the rooms into separate groups in preparation for adding tag
support.
Further subdivide the rooms into "joined/invited/archived" based the
membership of the user in the room because that membership affects what
events the user can view from the room. E.g only users that are joined
to a room may see the ephemeral events for the room.
9 years ago
Mark Haines
a73cc50aa9
s|client/api/v2_alpha|client/v2_alpha|
9 years ago
Mark Haines
931057accf
Add a top level presence key for the presence events and remove the public_user_data/private_user_data for now
9 years ago
Mark Haines
4cb3f78d2b
Wrap the "rooms" list inside an object so that we can add keys for pagination later
9 years ago
Mark Haines
218cf94ead
Replace the events array with events_map inside the room objects.
...
Only use indirection for the state and timeline events.
Use event_ids to reference the state and timeline events.
9 years ago
Mark Haines
6ad6c40147
List the allowed values for the 'event_format' as an enum
9 years ago
Mark Haines
9dd3b07394
Allow '.' characters in event field names to be escaped with '\' so that
...
fields including a '.' can be included in a filter.
I considered replacing '.' with '/'. Since '/' was less likely to appear
in event field names. However if we used '\' to escape a literal '/' we
risk confusing it with the JSON escape '\/'.
9 years ago
Mark Haines
14b42a41d6
Document wildcard's in filters
9 years ago
Mark Haines
c115b4c2f4
Document the valid values for the "set_presence" parameter
9 years ago
Mark Haines
940e22940d
Document how the "not_foo" keys interact with the "foo" keys
9 years ago
Mark Haines
41bc09ea22
Split the event_filter into a event_filter and a room_event_filter that
...
extends it.
So that we don't include "rooms" and "not_rooms" keys for the public_user_data
and private_user_data filters.
9 years ago
Mark Haines
00fd4aac26
s/publically/publicly/
9 years ago
Mark Haines
3204c2f2b6
Fix spelling
9 years ago
Mark Haines
f50e6d4c0a
Add x-example fields for v2 /sync
9 years ago
Mark Haines
1aa916d690
s/indicies/indices/
9 years ago
Mark Haines
393d283139
Add a "limit" to the timeline key in the example filter
9 years ago
Mark Haines
c3b3b2df63
Add "set_presence" in the sync parameters
9 years ago
Mark Haines
de07586ab7
Rename 'events' to 'timeline' in the sync filter
9 years ago
Mark Haines
a0068e1ada
Draft documention for the v2 sync api
9 years ago
Mark Haines
e1f73f5233
Add a limit to filters
9 years ago
Mark Haines
a31a446661
Fix the POST example for the v2 filter API
9 years ago
Mark Haines
69298b9612
Check "v2_alpha" in jenkins
9 years ago
Mark Haines
883105eae6
Document the v2 filter GET API
9 years ago
Mark Haines
2f039a1142
Add swagger docs for the v2 filter POST API
9 years ago
Mark Haines
98d91d0c2b
Make the example room id more "random" so that people are less likely to think that it is supposed to be human readable
9 years ago
Mark Haines
f60190086a
Describe the behaviour of /rooms/{roomId}/member when the user has left the room
9 years ago
Mark Haines
ba6c7d267c
SPEC-216: Document the behaviour of the room getters when the user has left the room
9 years ago
Mark Haines
615a9575cb
SPEC-216: Clarify when the room getters will return 403
9 years ago
Mark Haines
cb41adee70
Fix the swagger host to be "localhost:8008" so that it can be used in a "Try it now" setup against localhost
9 years ago
Mark Haines
6a2c4d27fc
Update the docs for room v1 api
9 years ago
Mark Haines
f33c0846c3
Merge remote-tracking branch 'origin/master' into markjh/document_v1_rooms_api
9 years ago
Mark Haines
63f08bace6
Fix the examples in the swagger API documentation to be valid JSON
9 years ago
Mark Haines
7f81501762
Allow relative references to schema to work in python and node.
...
Rename "schema/v1/core" to "schema/v1/core-event-schema".
Add self-referential symlinks to schema/v1/core-event-schema
The python json schema libraries expect that relative references are
relative to the file they are in. The node json schema libraries
expect that relateive references are relative to the first file loaded.
To support both kinds we reference the core event schema using
"core-event-schema/event.json". We then symlink the core-event-schema
directory to both the location of the file refering to "event.json" so
that it will work in python and to the location of the top level file
so that it will work in node.
9 years ago
Mark Haines
46d29e9eea
fix the room api swagger to be valid swagger
9 years ago
Mark Haines
315f97e36b
Merge branch 'master' into markjh/document_v1_rooms_api
9 years ago
Mark Haines
c49338006a
replace definitions/*event.yaml with symlinks to /event-schemas/
9 years ago
Mark Haines
7eb8b4fde2
Add new-style docs for the APIs for getting events for a room
9 years ago
Daniel Wagner-Hall
59a4e84361
s/registration/login/
9 years ago
Daniel Wagner-Hall
b8e2ac5c1b
Swaggerify /login
9 years ago
Kegsay
da7c2e7fa8
Merge pull request #40 from matrix-org/markjh/history_for_rooms_that_have_been_left
...
SPEC-216: Add rooms that have been left to initial sync
9 years ago
Daniel Wagner-Hall
5b722160dd
Merge branch 'master' into daniel/threepidinvites
9 years ago
Daniel Wagner-Hall
6a56c8a965
Add trailing newline
9 years ago
Daniel Wagner-Hall
a548148563
Invite doesn't accept room aliases
9 years ago
Daniel Wagner-Hall
2797fac3aa
Swagger /room/{roomId}/invite
...
This is a transcription of the current spec, with nothing new or
controversial in it.
9 years ago
Daniel Wagner-Hall
1b591a023e
Monospace room_id
9 years ago
Daniel Wagner-Hall
04b2b2588f
Fix up formatting and typos
9 years ago
Daniel Wagner-Hall
1feb9565e4
Use other-way-around alias format
9 years ago