Commit Graph

392 Commits (37fb1ceb65e02a17d1719c6367e4ca28e1c455f5)

Author SHA1 Message Date
Erik Johnston 0de8ba7f0a currently_active is a param on GET response, not put 10 years ago
Mark Haines 30a3302921 Merge pull request #274 from matrix-org/markjh/default_rules
Update the predefined push rules in the spec
10 years ago
Erik Johnston e80e32173f Merge pull request #278 from matrix-org/erikj/presence
Update presence spec.
10 years ago
Erik Johnston 2691d4925b s/currently_online/currently_active/ 10 years ago
Richard van der Hoff 7bbb664784 Improve documentation of directory API 10 years ago
Richard van der Hoff 86a81b0450 Fix schema for /logout
'properties' is a map, not a list
10 years ago
Richard van der Hoff e7e9f5fa46 Document the /logout api
We have one, and it's useful, so we really ought to document it
10 years ago
Richard van der Hoff 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
10 years ago
Richard van der Hoff 2093a6bac9 Merge pull request #332 from matrix-org/rav/update_login_api
Update the /login API spec
10 years ago
Richard van der Hoff 959f1ff09f Update the /login API spec
Note that /login can be used with 3pid creds
10 years ago
Richard van der Hoff 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
10 years ago
Richard van der Hoff 2d28e5abce Fix basePath on /redact API doc 10 years ago
Richard van der Hoff 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
10 years ago
Richard van der Hoff 5383754a40 Access event-schemas via a symlink
Swagger gets a bit confused about $refs via '../..', so use a symlink to make
everything nicely relative.
10 years ago
Richard van der Hoff 23c4ffbc1b Add securityDefintions to generated swagger JSON
Also factor out to a common file
10 years ago
Richard van der Hoff 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
10 years ago
David Baker 1a856b53f3 Remove redundant info & add backticks 10 years ago
David Baker 4b294b23de Tailor descriptions to GET method 10 years ago
David Baker 4fafe1ab73 Return an object as the root element
Because otherwise it's impossible to change later
10 years ago
David Baker 42834340e7 Add title to the pushers array 10 years ago
David Baker 0f6e414eb6 Fix format (array of objects, not object) 10 years ago
David Baker 27113d71ff Fix indentation 10 years ago
David Baker 73d6e901ae Add endpoint for getting a user's pushers
Also add profile_tag to the set docs as it was missing
10 years ago
Will Hunt c9ed063a36 Small copy paste error
'avatar url' should be 'profile information'
10 years ago
David Baker 39fe9e3896 Merge pull request #284 from matrix-org/dbkr/notification_counts
Add notification counts to doc
10 years ago
Daniel Wagner-Hall 11c572267e Add titles where they're missing 10 years ago
David Baker a78dff3981 Add notification counts to doc 10 years ago
Mark Haines d2c05d64c7 Document an API for setting and getting the actions for a push rule 10 years ago
Mark Haines 254fbe7983 Document GET for /pushrules/{scope}/{kind}/{ruleId}/enabled 10 years ago
David Baker e6143a6596 Merge pull request #281 from matrix-org/dbkr/fix_meta_escaping
Fix meta-escaping fail
10 years ago
David Baker 2c5392f1d1 Fix meta-escaping fail 10 years ago
Daniel Wagner-Hall 016ccf4544 Remove signed object which shouldn't exist 10 years ago
Erik Johnston cbe466e572 Update API docs 10 years ago
Daniel Wagner-Hall ccac9e7882 /join accepts a signature for a third party invite 10 years ago
Richard van der Hoff bc83677d98 Define the order for events returned by /context API 10 years ago
Richard van der Hoff 68a4306773 Split room previews into a separate module
Guest access and room peeking are orthogonal
10 years ago
Mark Haines 3db6980e0b Remove references to device specific push rules
Since they weren't implemented on the servers and weren't
used by the clients.
10 years ago
Mark Haines 8a050aebc0 Add a note to the docs for before and after to make it clear that they cannot be used with the predefined rules 10 years ago
David Baker 53a4a563e2 Actually we think they should not be present (which means synapse is buggy). 10 years ago
David Baker 542b17e944 Clarify what profile endpoints return if avatar url / display name isn't set 10 years ago
Richard van der Hoff 58b346e204 s/user_id/sender/ in context example response 10 years ago
Richard van der Hoff b2e0a855cc Add 'event' to event context API
also link through to the event schemas
10 years ago
Mark Haines e7f80b7c71 Fix the key name to be three_pid_creds rather than threePidCreds 10 years ago
Daniel Wagner-Hall 2e46b587b8 Require explicit un-banning 10 years ago
David Baker 169cc98101 M_INVALID_USERNAME to be consistent with the name of the parameter 10 years ago
David Baker 2301a792d7 Add an error code for invalid user names. 10 years ago
Matthew Hodgson cfbb695fd3 typoe 10 years ago
Daniel Wagner-Hall 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.
10 years ago
Richard van der Hoff 6265d6ce06 Merge pull request #254 from matrix-org/rav/filter_spec
Add some missing titles to the filter upload spec
10 years ago
Richard van der Hoff 972153be4f Fix endpoint path for /context
s/api//
10 years ago
Richard van der Hoff ff26e0dc48 Add some missing titles to the filter upload spec 10 years ago
Daniel Wagner-Hall 0e967edfd9 Fix thinko 10 years ago
Daniel Wagner-Hall 7d9547274c Clarify guest /events and /sync 10 years ago
Daniel Wagner-Hall 48aab7bad9 Return room avatar URLs in /publicRooms 10 years ago
Daniel Wagner-Hall 5e30d75ccb Add /_matrix/versions to spec 10 years ago
Erik Johnston 48f56bfbfb Support 3pid invites in /createRoom 10 years ago
Daniel Wagner-Hall 1eee36e889 Merge pull request #232 from matrix-org/daniel/deprecatestuff
Deprecated deprecated APIs
10 years ago
Matthew Hodgson c7d11335cf Merge branch 'master' of git+ssh://github.com/matrix-org/matrix-doc 10 years ago
Matthew Hodgson 691d9ba664 typo :( 10 years ago
Mark Haines 4c43939977 more backticks 10 years ago
Mark Haines 9b4a37f57b backticks 10 years ago
Mark Haines 288c7ed353 Add top level filters for filtering by room id. 10 years ago
Mark Haines 2ea66e9300 Merge branch 'markjh/account_data_filters' into markjh/room_filter 10 years ago
Mark Haines a32ed96a0f Document filtering for account data 10 years ago
Mark Haines e413f05c87 Merge pull request #243 from matrix-org/markjh/wildcards
Filters don't support wildcards for senders or room ids
10 years ago
Mark Haines c9349b302a Filters don't support wildcards for senders or room ids 10 years ago
Richard van der Hoff b7c255a887 Tweaks/clarifications to search spec
Fixes https://matrix.org/jira/browse/SPEC-305
10 years ago
Daniel Wagner-Hall b6cd3adc2f Merge pull request #233 from matrix-org/daniel/txnid
Merge pull request #233 from matrix-org/daniel/txnid
10 years ago
Christine Dodrill 7090e491de fix a typo in the example json for the old sync description 10 years ago
Erik Johnston 7980e65502 Merge pull request #234 from matrix-org/erikj/search_yet_agian
Note that count is approximate
10 years ago
Erik Johnston 88b350ca8b Better wording 10 years ago
Erik Johnston a2082e4b38 Note that count is approximate 10 years ago
Daniel Wagner-Hall dbba737135 Explain scope of uniqueness of txnid 10 years ago
Daniel Wagner-Hall 3e086909f1 Deprecated deprecated APIs 10 years ago
Daniel Wagner-Hall a484f04b33 Merge pull request #221 from matrix-org/daniel/pushaway
Merge pull request #221 from matrix-org/daniel/pushaway
10 years ago
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
10 years ago
Mark Haines c3a1318886 Make it explicit that the JSON filter object is passed as a string 10 years ago
Erik Johnston c96848d1bc Merge pull request #169 from matrix-org/erikj/search_yet_agian
Search: Document event context, groups and orders.
10 years ago
Erik Johnston 95255bcdf5 Use rst not html 10 years ago
Erik Johnston e1fda6b6b6 Remove double the 10 years ago
Erik Johnston 9c98c80bde Fix up filter description 10 years ago
Mark Haines ed70bcb180 Add a rationale for allowing both inline filters and passing filters by id. 10 years ago
Mark Haines 878ce2f206 Allow the filter JSON to be passed inline in the /sync request 10 years ago
Erik Johnston 6025569a73 Remove unused 403 stub 10 years ago
Erik Johnston 0fb88e26f0 Add tags 10 years ago
Erik Johnston 4290882034 Remove superfluous quote 10 years ago
Erik Johnston 8e7f6d44f6 Remove v1 references 10 years ago
Erik Johnston 4967b092aa Add description of state response key 10 years ago
Daniel Wagner-Hall a2283f5499 Remove /notify from client-server API 10 years ago
Erik Johnston f4b9433c7b Better wording 10 years ago
Erik Johnston 584104c432 Make example valid event id 10 years ago
Erik Johnston fda07e0d41 Merge remote-tracking branch 'origin/master' into erikj/event_context_api 10 years ago
Erik Johnston 856dd9100e Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian 10 years ago
Erik Johnston 118a6aa040 Reword groupings descriptions 10 years ago
Erik Johnston 1ef9cc37e3 Typo 10 years ago
Erik Johnston fca8e5abe7 Add top level next_batch key to example 10 years ago
Daniel Wagner-Hall f81b967e2d Make all the schema files yaml 10 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.
10 years ago
Daniel Wagner-Hall c9fee294df Merge pull request #211 from matrix-org/daniel/extractas
Move application service swagger out of c-s dir
10 years ago
Daniel Wagner-Hall 97579f15cb Merge pull request #212 from matrix-org/daniel/pushdictification
Take object, not bool, as param
10 years ago