Mark Haines
a33e49fd1e
Merge pull request #224 from matrix-org/markjh/filter_inline
...
Allow the filter JSON to be passed inline in the /sync request
9 years ago
Mark Haines
c3a1318886
Make it explicit that the JSON filter object is passed as a string
9 years ago
Erik Johnston
c96848d1bc
Merge pull request #169 from matrix-org/erikj/search_yet_agian
...
Search: Document event context, groups and orders.
9 years ago
Erik Johnston
95255bcdf5
Use rst not html
9 years ago
Erik Johnston
e1fda6b6b6
Remove double the
9 years ago
Erik Johnston
9c98c80bde
Fix up filter description
9 years ago
Mark Haines
ed70bcb180
Add a rationale for allowing both inline filters and passing filters by id.
9 years ago
Mark Haines
878ce2f206
Allow the filter JSON to be passed inline in the /sync request
9 years ago
Erik Johnston
6025569a73
Remove unused 403 stub
9 years ago
Erik Johnston
0fb88e26f0
Add tags
9 years ago
Erik Johnston
4290882034
Remove superfluous quote
9 years ago
Erik Johnston
8e7f6d44f6
Remove v1 references
9 years ago
Erik Johnston
4967b092aa
Add description of state response key
9 years ago
Daniel Wagner-Hall
a2283f5499
Remove /notify from client-server API
9 years ago
Erik Johnston
f4b9433c7b
Better wording
9 years ago
Erik Johnston
584104c432
Make example valid event id
9 years ago
Erik Johnston
fda07e0d41
Merge remote-tracking branch 'origin/master' into erikj/event_context_api
9 years ago
Erik Johnston
856dd9100e
Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian
9 years ago
Erik Johnston
118a6aa040
Reword groupings descriptions
9 years ago
Erik Johnston
1ef9cc37e3
Typo
9 years ago
Erik Johnston
fca8e5abe7
Add top level next_batch key to example
9 years ago
Daniel Wagner-Hall
f81b967e2d
Make all the schema files yaml
9 years ago
Daniel Wagner-Hall
1f5b6271f2
Generate swagger-ui output for client-server API
...
Depends on:
https://github.com/matrix-org/matrix-doc/pull/212
https://github.com/matrix-org/matrix-doc/pull/208
https://github.com/matrix-org/matrix-doc/pull/207
for the actual rendered output to not throw javascript errors at runtime.
9 years ago
Daniel Wagner-Hall
c9fee294df
Merge pull request #211 from matrix-org/daniel/extractas
...
Move application service swagger out of c-s dir
9 years ago
Daniel Wagner-Hall
97579f15cb
Merge pull request #212 from matrix-org/daniel/pushdictification
...
Take object, not bool, as param
9 years ago
Daniel Wagner-Hall
705556634a
Add filters
9 years ago
Daniel Wagner-Hall
9c733a45e8
Take object, not bool, as param
...
Throughout our API we take objects. And swagger is unhappy with not
doing so.
9 years ago
Daniel Wagner-Hall
614ee9ea1b
Move application service swagger out of c-s dir
9 years ago
Mark Haines
140206ca69
s/archived/leave/
9 years ago
Mark Haines
79d109f7cc
Add an flag to control whether rooms the user has left are included in the sync
9 years ago
Daniel Wagner-Hall
e0ebabf8cc
Explicitly document /rooms/{roomId}/state/{eventType} without state key
9 years ago
Daniel Wagner-Hall
873b0dcecf
Replace version numbers with release numbers
9 years ago
Daniel Wagner-Hall
f308b7543c
Specify /admin/whois/{userId}
9 years ago
Daniel Wagner-Hall
19ce17cfed
Merge pull request #200 from matrix-org/daniel/redact
...
Merge pull request #200 from matrix-org/daniel/redact
9 years ago
Daniel Wagner-Hall
2f3a00fe34
Consistently spell homeserver as homeserver
9 years ago
Daniel Wagner-Hall
e072d215cf
Specify redaction
9 years ago
Daniel Wagner-Hall
7f07da4b50
Remove obsolete documentation
9 years ago
Daniel Wagner-Hall
aa4ed10821
Unify v1 and v2 event schemas
9 years ago
Daniel Wagner-Hall
681c258206
Fix turnServer endpoint
9 years ago
Erik Johnston
ca7ef1b536
Update Results description
9 years ago
Erik Johnston
5e8bb34f36
Change the results dict to a list
9 years ago
Erik Johnston
46fd0b252c
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian
9 years ago
Daniel Wagner-Hall
c6e0322a9e
Swaggerify /account
9 years ago
Daniel Wagner-Hall
6c66bfc755
Flatten out v1 and v2_alpha directories
...
As a side effect, I got rid of all of the horrible symlinks and just put
in all of the proper relative paths. Because the horrible symlinks were
horrible.
9 years ago
Daniel Wagner-Hall
3951785f19
Fix alias path
9 years ago
Daniel Wagner-Hall
bc514dc9c4
Merge pull request #178 from matrix-org/daniel/directory
...
Fix and include /directory api docs
9 years ago
Daniel Wagner-Hall
7f2813354d
Swaggerify /ban
9 years ago
Mark Haines
a20a49abf6
Merge pull request #168 from matrix-org/markjh/client_config
...
Add API for setting client config
9 years ago
Mark Haines
c5f457cee9
Merge pull request #132 from matrix-org/markjh/room_tags
...
Document a v2 api for setting tags on rooms
9 years ago
Daniel Wagner-Hall
f0c99a6925
Generate API docs from swagger
9 years ago
Mark Haines
c539b208f9
Merge branch 'markjh/room_tags' into markjh/client_config
...
Conflicts:
api/client-server/v2_alpha/sync.yaml
9 years ago
Mark Haines
d39494b6df
Fix typo in sync example
9 years ago
Daniel Wagner-Hall
5e30b5b8d7
Remove POST version of /send
...
PUT should always be used.
9 years ago
Daniel Wagner-Hall
c25a806cef
Fix and include /directory api docs
9 years ago
Mark Haines
5ccc39b850
Say that type is an event type
9 years ago
Mark Haines
e76068a2a6
Merge branch 'markjh/room_tags' into markjh/client_config
9 years ago
Mark Haines
5bae15d47b
Merge branch 'master' into markjh/room_tags
...
Conflicts:
api/client-server/v2_alpha/sync.yaml
9 years ago
Erik Johnston
46870da57d
Add optional profile info and state in search response
9 years ago
Richard van der Hoff
d8dd380dfa
Merge pull request #164 from matrix-org/rav/SPEC-254
...
Fix /sync documentation, post SPEC-254
9 years ago
Mark Haines
05c0092664
s/config/account_data/
9 years ago
Richard van der Hoff
d7d59d78e1
/sync: Put state dict back to being a list
...
Turning the state into a dict-of-dicts caused more pain than it solved. Put it
back to a list.
9 years ago
Mark Haines
40f7eab73f
s/private_user_data/account_data/
9 years ago
Mark Haines
24c4b8b095
Merge branch 'markjh/room_tags' into markjh/client_config
...
Conflicts:
api/client-server/v1/rooms.yaml
api/client-server/v1/sync.yaml
api/client-server/v2_alpha/sync.yaml
specification/targets.yaml
9 years ago
Mark Haines
fcbb985073
s/private_user_data/account_data/
9 years ago
Richard van der Hoff
6653362f31
Unflatten 'unsigned'
...
It turns out that flattening 'unsigned' comes with too many downsides. Let's
stick with the status quo.
9 years ago
Daniel Wagner-Hall
6763317e64
Specify /rooms/:room_id/forget
9 years ago
Daniel Wagner-Hall
8201eaa042
Swaggerify /rooms/:room_id/leave
9 years ago
Erik Johnston
ffed14a0cd
Add next_batch token
9 years ago
Erik Johnston
8991c4fa78
Fix schema and example
9 years ago
Erik Johnston
5e0e4a8518
Document group and context response keys
9 years ago
Mark Haines
299af673da
Specify how ordering of tags is supposed to work
9 years ago
Mark Haines
3b390bff3c
Merge branch 'master' into markjh/room_tags
...
Conflicts:
api/client-server/v1/rooms.yaml
specification/targets.yaml
9 years ago
Mark Haines
8f5783615c
Merge branch 'master' into markjh/client_config
...
Conflicts:
api/client-server/v1/rooms.yaml
specification/targets.yaml
9 years ago
Mark Haines
22b3159a39
Add examples of v1 initialSync and v2 /sync returning the client config
9 years ago
Mark Haines
769c5285ab
Add API for setting client config
9 years ago
Erik Johnston
e2eb0c7ad9
Add new request options
9 years ago
Richard van der Hoff
e1b12a753e
Fix typos and missing file
9 years ago
Richard van der Hoff
29bd4d45ee
Flatten the response to /sync
...
Now that we don't expect there to be duplication betwen the 'timeline' and
'state' results, there's no point in having the state map. (That does mean the
events themselves need event_id fields though).
Also:
- move the contents of the 'unsigned' dictionary into the events themselves
- replace the state list with two layers of dictionary keyed on type and
state_key
- rename the children of the 'rooms' dict from "joined/invited/archived" to
"join/invite/leave" to match the membership states
9 years ago
Richard van der Hoff
b41d771c15
Fix typos in /sync example response
9 years ago
Richard van der Hoff
57995a815a
Fix a number of untruths in the documentation about /sync.
...
Attempts to make the /sync documentation better represent fact as it currently
stands - in particular document the structure of the returned events.
9 years ago
Richard van der Hoff
3f0262081c
Update sync API defn to reflect SPEC-254 changes
...
State now corresponds to the start of the timeline, not the end.
9 years ago
Daniel Wagner-Hall
061105c9dc
Guest users are allowed room initialSync
9 years ago
Daniel Wagner-Hall
dcf54e11b1
Specify /publicRooms world_readable and guest_access
...
Depends on https://github.com/matrix-org/matrix-doc/pull/154
9 years ago
Daniel Wagner-Hall
d7357ef9b7
Specify /publicRooms
9 years ago
Daniel Wagner-Hall
24c2036a35
3pid invites: remove mentions of display_name
9 years ago
Daniel Wagner-Hall
e72151f2c3
Specify guest room access
...
This was reviewed as PR #150 and merged from daniel/anonymousaccess
9 years ago
Daniel Wagner-Hall
161441fa3a
Update 3pid spec based on new implementation
9 years ago
Daniel Wagner-Hall
232b10b0f6
Merge branch 'master' of github.com:matrix-org/matrix-doc
9 years ago
Mark Haines
b7cc5b1018
Merge pull request #141 from matrix-org/markjh/full_http_api_docs
...
Include the full schema for an http API in the docs
9 years ago
Mark Haines
ebc0237109
Add the missing titles to the schema
9 years ago
Mark Haines
d53814097f
Add example content to the tags in example tag events
9 years ago
Mark Haines
e9d361841b
Fix tag examples
9 years ago
Daniel Wagner-Hall
2e3a0b4e00
Specify guest accounts
9 years ago
Mark Haines
52f55e0542
Allow room tags to have asssociated content, and return that content in the m.tag events
9 years ago
Mark Haines
f557e69860
Note that m.tag events can appear in v1 initialSync and /events as well as v2 sync. Only add the room_id for v1 /events since it is redundant in v1 /initialSync
9 years ago
Mark Haines
ad86426e95
Add private_user_data to v1 room /initialSync
9 years ago
Mark Haines
b49472e3b0
Add private_user_data to v1 /initialSync
9 years ago
Mark Haines
451801bf38
Add an example of ``prev_content`` in ``unsigned`` to v2 /sync
9 years ago
Erik Johnston
fa2fe2ddd9
Add event context api swagger
9 years ago
Matthew Hodgson
6c1df04b4b
typo
9 years ago
Richard van der Hoff
ece42688d0
Clarify the interaction between full_state and timeout.
9 years ago
Mark Haines
65066a76b3
Add the m.tags event to a ``private_user_data`` key rather than including it under the ``ephemeral`` key
9 years ago
Mark Haines
12e33a3b09
Document a v2 api for setting tags on rooms
9 years ago
Richard van der Hoff
13eddd456f
Proposal for adding full_state param to v2 sync
9 years ago
Kegsay
ade0ad5ed1
Merge pull request #129 from matrix-org/erikj/search_actual
...
Add filter param to search API
9 years ago
Erik Johnston
36634df355
Add filter param
9 years ago
Richard van der Hoff
f47a49de43
Merge pull request #126 from matrix-org/rav/send_events_api
...
Add the room send and state APIs to the spec
9 years ago
Richard van der Hoff
1945697456
Further tweaks to the room send and state APIs
...
- fix confusion re empty/absent state_keys
- move 'types of room events' section earlier in the 'Events' section
- remove some redundant anchors
9 years ago
Mark Haines
1d7cb6937f
Merge pull request #123 from matrix-org/markjh/list_formatting
...
Fix list formatting
9 years ago
Mark Haines
637718108e
Add newline before list
9 years ago
Richard van der Hoff
28ab643a4e
Remove duplicated registration/login APIs
...
Currently the spec duplicates all of the account-management APIs. There's still
work to be done here, but the complete duplication is confusing.
9 years ago
Richard van der Hoff
587a8ba7ce
Merge branch 'master' into rav/send_events_api
9 years ago
Richard van der Hoff
d2bbc461e4
mark stateKey as required in room/{id}/state
...
Swagger insists that path params be mandatory.
9 years ago
Richard van der Hoff
d18d406c41
Add the room send and state APIs to the spec
9 years ago
Mark Haines
cc14620932
Add a newline before the list
9 years ago
Mark Haines
e3e8026025
Fix list formatting so that we aren't including everything in blockquotes
9 years ago
Erik Johnston
f0c74a9c83
Merge pull request #96 from matrix-org/erikj/search_actual
...
Add search API
9 years ago
Kegan Dougal
f95d19cecd
Merge branch 'master' into appservice-swagger
...
Conflicts:
specification/application_service_api.rst
9 years ago
Kegan Dougal
4c3e1b9ed3
Find replace fail
9 years ago
Kegan Dougal
bd539c72b4
More review comments
9 years ago
Erik Johnston
1d01f69c3c
Merge remote-tracking branch 'origin/master' into erikj/search_actual
9 years ago
Kegan Dougal
26f27d95fb
Merge branch 'master' into registration-swagger
...
Conflicts:
specification/client_server_api.rst
9 years ago
Kegan Dougal
f450fc1db6
Typo
9 years ago
Kegan Dougal
4bb042daeb
Review comments round II
9 years ago
Kegan Dougal
e0fe3c42c8
Review comments
9 years ago
Kegan Dougal
6770d6b2d6
Review comments
9 years ago
Erik Johnston
716c5b7a8b
Add 400 and 429 response codes
9 years ago
Kegan Dougal
eca98af896
Swaggerify /register endpoint
...
Need to move registration/login/auth sections around once #94 lands.
9 years ago
Erik Johnston
cfca4a6c09
s/creteria/criteria/
9 years ago
Kegan Dougal
f20faa80e5
Swagger validation
9 years ago
Kegan Dougal
55cc5c5bb5
Swaggerify application services
9 years ago
Kegan Dougal
5de63b4f45
Merge branch 'master' into proofing
...
Conflicts:
specification/0-intro.rst
9 years ago
Kegan Dougal
1f2f14dc08
YAML tweaks
9 years ago
Kegan Dougal
84af5776d7
Newlines
9 years ago
Erik Johnston
2b9484cf48
Spell things correctly
9 years ago
Erik Johnston
392a1c5ad8
Another title
9 years ago
Erik Johnston
ca9e44baac
Moar titles
9 years ago
Erik Johnston
a7a5cb088b
Add titles
9 years ago
Erik Johnston
e42c8b5b63
Add search API
9 years ago
Richard van der Hoff
4a9db39277
Clean up some untruths in the login api doc
...
add "type", and "username" -> "user"
9 years ago
Kegan Dougal
6f6861a11d
Swaggerify the createRoom API
9 years ago
Kegan Dougal
41fb0645a9
Add message pagination API
9 years ago
Kegan Dougal
7bdb71b1c9
Tweak the syncing section
...
Bring together disparate sections to make it more cohesive.
9 years ago
Daniel Wagner-Hall
2502ca7ac6
Merge branch 'master' into daniel/threepidinvites-2
...
Conflicts:
specification/targets.yaml
9 years ago
Kegsay
616f3990aa
Merge pull request #87 from matrix-org/module-push
...
Push Module
9 years ago
Kegan Dougal
8f5c796884
Linkify 'pushers'
9 years ago
Mark Haines
d42c3195e6
Use 'true' rather than '1' for archived flag
9 years ago
Mark Haines
241096dc81
Add a flag to initial sync to indicate we want rooms that the user has left
9 years ago
Kegan Dougal
f2a6950cc3
Minor tweaks; allow objects without props/parents if a title is set
...
This allows us to do things like {Tweaks} where Tweaks is defined somewhere
else.
9 years ago
Daniel Wagner-Hall
dc3c02aff5
Review comments
9 years ago