60293af83a
PR feedback
8 years ago
6a0c9edb49
Add the id_server param
8 years ago
b0194a3016
Spec for endpoint-specific 3pid verification token
...
As per proposal https://docs.google.com/document/d/13mapDbaOnbob9ZYRDiGm1YbeZhFOBj_R1OvgBA9pA5s/edit?pref=2&pli=1#
8 years ago
4f37e4ece0
Merge pull request #342 from matrix-org/erikj/presence
...
Fix and correctly document presence's currently_active
8 years ago
0de8ba7f0a
currently_active is a param on GET response, not put
8 years ago
30a3302921
Merge pull request #274 from matrix-org/markjh/default_rules
...
Update the predefined push rules in the spec
8 years ago
e80e32173f
Merge pull request #278 from matrix-org/erikj/presence
...
Update presence spec.
8 years ago
2691d4925b
s/currently_online/currently_active/
8 years ago
7bbb664784
Improve documentation of directory API
9 years ago
86a81b0450
Fix schema for /logout
...
'properties' is a map, not a list
9 years ago
e7e9f5fa46
Document the /logout api
...
We have one, and it's useful, so we really ought to document it
9 years ago
3bce28a15c
Clarifications to the 'Client authentication' section
...
* Use the terminology 'login type' everywhere instead of mixing up 'stage type'
and 'login type'
* Don't have a separate 'APIs using the User-Interactive Authentication
mechanism' section, because (a) it doesn't make much sense to organise the
APIs this way, and (b) it was a set of lies anyway.
* Move '/account/password' definition into registration.yaml so that register
and password can share a section in the spec; remove duplicate doc for
/password.
* Write some words on using 3pids for /login
9 years ago
2093a6bac9
Merge pull request #332 from matrix-org/rav/update_login_api
...
Update the /login API spec
9 years ago
959f1ff09f
Update the /login API spec
...
Note that /login can be used with 3pid creds
9 years ago
9efd021f5e
Document the user-interactive api params
...
Document the parameters and responses on /register and /account/password which
are invoved in the user-interactive auth
9 years ago
2d28e5abce
Fix basePath on /redact API doc
9 years ago
432c78f3b5
Fix the swagger for /search so that it works without preprocessing
...
Makes the /search swagger work when it is imported directly into the swagger-UI
without preprocessing by dump_swagger
9 years ago
5383754a40
Access event-schemas via a symlink
...
Swagger gets a bit confused about $refs via '../..', so use a symlink to make
everything nicely relative.
9 years ago
23c4ffbc1b
Add securityDefintions to generated swagger JSON
...
Also factor out to a common file
9 years ago
cf87120d78
Fixes to the API docs
...
* fix security data for DELETE /user/{userId}/rooms/{roomId}/tags/{tag}
* fix definition for body of PUT /pushrules/{scope}/{kind}/{ruleId}/actions
9 years ago
1a856b53f3
Remove redundant info & add backticks
9 years ago
4b294b23de
Tailor descriptions to GET method
9 years ago
4fafe1ab73
Return an object as the root element
...
Because otherwise it's impossible to change later
9 years ago
42834340e7
Add title to the pushers array
9 years ago
0f6e414eb6
Fix format (array of objects, not object)
9 years ago
27113d71ff
Fix indentation
9 years ago
73d6e901ae
Add endpoint for getting a user's pushers
...
Also add profile_tag to the set docs as it was missing
9 years ago
c9ed063a36
Small copy paste error
...
'avatar url' should be 'profile information'
9 years ago
39fe9e3896
Merge pull request #284 from matrix-org/dbkr/notification_counts
...
Add notification counts to doc
9 years ago
11c572267e
Add titles where they're missing
9 years ago
a78dff3981
Add notification counts to doc
9 years ago
d2c05d64c7
Document an API for setting and getting the actions for a push rule
9 years ago
254fbe7983
Document GET for /pushrules/{scope}/{kind}/{ruleId}/enabled
9 years ago
e6143a6596
Merge pull request #281 from matrix-org/dbkr/fix_meta_escaping
...
Fix meta-escaping fail
9 years ago
2c5392f1d1
Fix meta-escaping fail
9 years ago
016ccf4544
Remove signed object which shouldn't exist
9 years ago
cbe466e572
Update API docs
9 years ago
ccac9e7882
/join accepts a signature for a third party invite
9 years ago
bc83677d98
Define the order for events returned by /context API
9 years ago
68a4306773
Split room previews into a separate module
...
Guest access and room peeking are orthogonal
9 years ago
3db6980e0b
Remove references to device specific push rules
...
Since they weren't implemented on the servers and weren't
used by the clients.
9 years ago
8a050aebc0
Add a note to the docs for before and after to make it clear that they cannot be used with the predefined rules
9 years ago
53a4a563e2
Actually we think they should not be present (which means synapse is buggy).
9 years ago
542b17e944
Clarify what profile endpoints return if avatar url / display name isn't set
9 years ago
58b346e204
s/user_id/sender/ in context example response
9 years ago
b2e0a855cc
Add 'event' to event context API
...
also link through to the event schemas
9 years ago
e7f80b7c71
Fix the key name to be three_pid_creds rather than threePidCreds
9 years ago
2e46b587b8
Require explicit un-banning
9 years ago
169cc98101
M_INVALID_USERNAME to be consistent with the name of the parameter
9 years ago
2301a792d7
Add an error code for invalid user names.
9 years ago
cfbb695fd3
typoe
9 years ago
1e2b63763e
/join and /room/:roomId/join aren't exact aliases
...
Separate them, clarify their differences.
Also, fix some links which weren't being properly populated.
9 years ago
6265d6ce06
Merge pull request #254 from matrix-org/rav/filter_spec
...
Add some missing titles to the filter upload spec
9 years ago
972153be4f
Fix endpoint path for /context
...
s/api//
9 years ago
ff26e0dc48
Add some missing titles to the filter upload spec
9 years ago
0e967edfd9
Fix thinko
9 years ago
7d9547274c
Clarify guest /events and /sync
9 years ago
48aab7bad9
Return room avatar URLs in /publicRooms
9 years ago
5e30d75ccb
Add /_matrix/versions to spec
9 years ago
48f56bfbfb
Support 3pid invites in /createRoom
9 years ago
1eee36e889
Merge pull request #232 from matrix-org/daniel/deprecatestuff
...
Deprecated deprecated APIs
9 years ago
c7d11335cf
Merge branch 'master' of git+ssh://github.com/matrix-org/matrix-doc
9 years ago
691d9ba664
typo :(
9 years ago
4c43939977
more backticks
9 years ago
9b4a37f57b
backticks
9 years ago
288c7ed353
Add top level filters for filtering by room id.
9 years ago
2ea66e9300
Merge branch 'markjh/account_data_filters' into markjh/room_filter
9 years ago
a32ed96a0f
Document filtering for account data
9 years ago
e413f05c87
Merge pull request #243 from matrix-org/markjh/wildcards
...
Filters don't support wildcards for senders or room ids
9 years ago
c9349b302a
Filters don't support wildcards for senders or room ids
9 years ago
b7c255a887
Tweaks/clarifications to search spec
...
Fixes https://matrix.org/jira/browse/SPEC-305
9 years ago
b6cd3adc2f
Merge pull request #233 from matrix-org/daniel/txnid
...
Merge pull request #233 from matrix-org/daniel/txnid
9 years ago
7090e491de
fix a typo in the example json for the old sync description
9 years ago
7980e65502
Merge pull request #234 from matrix-org/erikj/search_yet_agian
...
Note that count is approximate
9 years ago
88b350ca8b
Better wording
9 years ago
a2082e4b38
Note that count is approximate
9 years ago
dbba737135
Explain scope of uniqueness of txnid
9 years ago
3e086909f1
Deprecated deprecated APIs
9 years ago
a484f04b33
Merge pull request #221 from matrix-org/daniel/pushaway
...
Merge pull request #221 from matrix-org/daniel/pushaway
9 years ago
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
c3a1318886
Make it explicit that the JSON filter object is passed as a string
9 years ago
c96848d1bc
Merge pull request #169 from matrix-org/erikj/search_yet_agian
...
Search: Document event context, groups and orders.
9 years ago
95255bcdf5
Use rst not html
9 years ago
e1fda6b6b6
Remove double the
9 years ago
9c98c80bde
Fix up filter description
9 years ago
ed70bcb180
Add a rationale for allowing both inline filters and passing filters by id.
9 years ago
878ce2f206
Allow the filter JSON to be passed inline in the /sync request
9 years ago
6025569a73
Remove unused 403 stub
9 years ago
0fb88e26f0
Add tags
9 years ago
4290882034
Remove superfluous quote
9 years ago
8e7f6d44f6
Remove v1 references
9 years ago
4967b092aa
Add description of state response key
9 years ago
a2283f5499
Remove /notify from client-server API
9 years ago
f4b9433c7b
Better wording
9 years ago
584104c432
Make example valid event id
9 years ago
fda07e0d41
Merge remote-tracking branch 'origin/master' into erikj/event_context_api
9 years ago
856dd9100e
Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian
9 years ago
118a6aa040
Reword groupings descriptions
9 years ago
1ef9cc37e3
Typo
9 years ago
fca8e5abe7
Add top level next_batch key to example
9 years ago
f81b967e2d
Make all the schema files yaml
9 years ago
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
c9fee294df
Merge pull request #211 from matrix-org/daniel/extractas
...
Move application service swagger out of c-s dir
9 years ago
97579f15cb
Merge pull request #212 from matrix-org/daniel/pushdictification
...
Take object, not bool, as param
9 years ago
705556634a
Add filters
9 years ago
9c733a45e8
Take object, not bool, as param
...
Throughout our API we take objects. And swagger is unhappy with not
doing so.
9 years ago
614ee9ea1b
Move application service swagger out of c-s dir
9 years ago
140206ca69
s/archived/leave/
9 years ago
79d109f7cc
Add an flag to control whether rooms the user has left are included in the sync
9 years ago
e0ebabf8cc
Explicitly document /rooms/{roomId}/state/{eventType} without state key
9 years ago
873b0dcecf
Replace version numbers with release numbers
9 years ago
f308b7543c
Specify /admin/whois/{userId}
9 years ago
19ce17cfed
Merge pull request #200 from matrix-org/daniel/redact
...
Merge pull request #200 from matrix-org/daniel/redact
9 years ago
2f3a00fe34
Consistently spell homeserver as homeserver
9 years ago
e072d215cf
Specify redaction
9 years ago
7f07da4b50
Remove obsolete documentation
9 years ago
aa4ed10821
Unify v1 and v2 event schemas
9 years ago
681c258206
Fix turnServer endpoint
9 years ago
ca7ef1b536
Update Results description
9 years ago
5e8bb34f36
Change the results dict to a list
9 years ago
46fd0b252c
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian
9 years ago
c6e0322a9e
Swaggerify /account
9 years ago
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
3951785f19
Fix alias path
9 years ago
bc514dc9c4
Merge pull request #178 from matrix-org/daniel/directory
...
Fix and include /directory api docs
9 years ago
7f2813354d
Swaggerify /ban
9 years ago
a20a49abf6
Merge pull request #168 from matrix-org/markjh/client_config
...
Add API for setting client config
9 years ago
c5f457cee9
Merge pull request #132 from matrix-org/markjh/room_tags
...
Document a v2 api for setting tags on rooms
9 years ago
f0c99a6925
Generate API docs from swagger
9 years ago
c539b208f9
Merge branch 'markjh/room_tags' into markjh/client_config
...
Conflicts:
api/client-server/v2_alpha/sync.yaml
9 years ago
d39494b6df
Fix typo in sync example
9 years ago
5e30b5b8d7
Remove POST version of /send
...
PUT should always be used.
9 years ago
c25a806cef
Fix and include /directory api docs
9 years ago
5ccc39b850
Say that type is an event type
9 years ago
e76068a2a6
Merge branch 'markjh/room_tags' into markjh/client_config
9 years ago
5bae15d47b
Merge branch 'master' into markjh/room_tags
...
Conflicts:
api/client-server/v2_alpha/sync.yaml
9 years ago
46870da57d
Add optional profile info and state in search response
9 years ago
d8dd380dfa
Merge pull request #164 from matrix-org/rav/SPEC-254
...
Fix /sync documentation, post SPEC-254
9 years ago
05c0092664
s/config/account_data/
9 years ago
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
40f7eab73f
s/private_user_data/account_data/
9 years ago
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
fcbb985073
s/private_user_data/account_data/
9 years ago
6653362f31
Unflatten 'unsigned'
...
It turns out that flattening 'unsigned' comes with too many downsides. Let's
stick with the status quo.
9 years ago
6763317e64
Specify /rooms/:room_id/forget
9 years ago
8201eaa042
Swaggerify /rooms/:room_id/leave
9 years ago
ffed14a0cd
Add next_batch token
9 years ago
8991c4fa78
Fix schema and example
9 years ago
5e0e4a8518
Document group and context response keys
9 years ago
299af673da
Specify how ordering of tags is supposed to work
9 years ago
David Baker