Commit Graph

587 Commits (05a2427c7304292e48d9501574b7bdf006ce3153)

Author SHA1 Message Date
Richard van der Hoff c175039a08 Final public_rooms clarifications
* order by *joined* members
 * clarify pagination direction behaviour
8 years ago
Richard van der Hoff dca1d0c745 Merge branch 'master' into erikj/public_rooms 8 years ago
Richard van der Hoff 2bf0abcb9d Add missing tag to PUT /devices/{deviceId} 8 years ago
Richard van der Hoff b26c84a290 Fix schema validation fail 8 years ago
Richard van der Hoff 07dbf6fcf6 Add doc for PUT /devices/{deviceId}
Oops, forgot this.
8 years ago
Erik Johnston d66792d5ca Mention order of returned results 8 years ago
Richard van der Hoff af515012ea Device management API 8 years ago
Richard van der Hoff 9265b03008 Client device doc
Document client devices, and the mods to the login and register apis to support
them.
8 years ago
Erik Johnston a69d6c63c6 Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/public_rooms 8 years ago
Erik Johnston cafa9a01fd Move explanation of lack of direction param 8 years ago
Erik Johnston 71c1fc5ec0 Remove spurious 400 result 8 years ago
Erik Johnston de68c167b6 Add tags for GET endpoint 8 years ago
Erik Johnston 9d0960b206 Better wording 8 years ago
Richard van der Hoff 42616f839c Merge pull request #396 from matrix-org/dbkr/notifs_api
Spec notifs API
8 years ago
Richard van der Hoff 909aef2b18 Merge pull request #389 from matrix-org/erikj/create_room_is_direct
Spec /createRoom is_direct flag, is_direct in member event and m.direct
8 years ago
David Baker e0a434b248 Aaha, found a syntax that swagger will accept! 8 years ago
David Baker bd753d4bf4 Re-add required flags the correct way 8 years ago
David Baker af2c74c186 Revert `required`s
They're not boolean flags for object fields
8 years ago
David Baker 14944fe237 More PR feedback 8 years ago
David Baker fd8c1a43c7 ms, not s. Also add required flags 8 years ago
David Baker b789251f70 More PR feedback 8 years ago
David Baker 4a020025bc Make swagger happpy
These aren't strings, but 'any' causes swagger to break and
leaving it out makes the doc fail to build.
8 years ago
David Baker b4c89accb2 Params in query, not path 8 years ago
David Baker a463820d83 Typo 8 years ago
David Baker c1fa342b90 Swagger is failing on type 'any' 8 years ago
David Baker 136d5dc9ad Almost valid... 8 years ago
David Baker 595b75f299 Try & make example closer to valid 8 years ago
David Baker 41781e95b2 Attempt valid json 8 years ago
David Baker c16ba9488f Spec notifs API 8 years ago
Richard van der Hoff 37fb1ceb65 Merge pull request #395 from matrix-org/rav/kill_refresh_tokens
Remove references to refresh tokens and tokenrefresh
8 years ago
David Baker 1d7531e9a1 Typo 8 years ago
David Baker d39f662df5 PR feedback 8 years ago
Richard van der Hoff 556ced36a4 Merge remote-tracking branch 'origin/master' into rav/store_and_forward 8 years ago
David Baker 8fe8bd6a81 Add is_direct to member event spec. 8 years ago
Richard van der Hoff f4c7fdfd03 Remove references to refresh tokens and tokenrefresh
refresh tokens are dead.
8 years ago
David Baker 5fedc64230 double space 8 years ago
David Baker ae1c576648 Merge remote-tracking branch 'origin/master' into erikj/create_room_is_direct 8 years ago
Erik Johnston 069aa86a10 Update wording and add example to filter param 8 years ago
Erik Johnston 7919e8e159 Update wording. 8 years ago
Erik Johnston a5bb182c67 Explicitly mention that directio of pagination is specified by the token 8 years ago
Erik Johnston a66a744c45 Fix typo. Change responses in both places 8 years ago
Erik Johnston 06649b652d Mark booleans as required. Remove mention that things may be null 8 years ago
Erik Johnston b121feebce Comment what the is_direct flag actually does 8 years ago
Erik Johnston e8b21f357f Explicitlty mention total_room_count_estimate 8 years ago
Erik Johnston e854757c98 Mark required fields as required 8 years ago
Erik Johnston 0dc94d5c14 Expand on description of pagination tokens 8 years ago
Erik Johnston 37f6769a3c Spec filter param on /messagse 8 years ago
Erik Johnston 085131b617 Add contains_url filter option 8 years ago
Richard van der Hoff ebaaa7e3b3 Review feedback
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
8 years ago
Erik Johnston 3a5cbd14c3 Add /createRoom is_direct flag 8 years ago
Erik Johnston c05ee18f58 Add title and update description 8 years ago
Erik Johnston 130ea85576 Spec POST /publicRooms 8 years ago
Erik Johnston 877a6cfeb4 Spec new query params for /publicRooms 8 years ago
Erik Johnston d81d0dbd1d Spec canonical alias key 8 years ago
Richard van der Hoff ccd7bb32d5 Specification for direct-to-device messages 8 years ago
Benjamin Saunders cade909e25 Fix inconsistencies regarding redacted_because
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
Richard van der Hoff 7478e7f3cf Add top-level account_data to /sync response 8 years ago
Benjamin Saunders 77b668a5dc Fix some obsolete uses of user_id key in events
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
Matthew Hodgson 978d9ea6dd fix the descriptions of the /room/.../state APIs to not be the wrong way round 8 years ago
Richard van der Hoff c51c4acf7f Clarifications to authentication mechanisms
* Make the purpose of the `auth` key in /register requests explicit, and say
  that it should be empty at first.

* Restructure the UA-auth section a bit.

* In the UA-auth section, say that clients should submit no `auth` to start
  with, and add 'Stage 0' representing  this to the example.

* s/{stage,login} type/authentication type/ in the UA-auth section. Seems
   clearer to me.

* Try to distinguish the example responses from the example requests by giving
  an HTTP header.
8 years ago
Richard van der Hoff 4b0e546eeb PR feedback
Fix some typos, and clarify several aspects of server behaviour.
8 years ago
Richard van der Hoff 41368dc5a7 document CAS login
Following the spirit of "document how it is, not how we wish it was", document
the CAS login bits.
8 years ago
Mark Haines d2fe2f1ff6 Fix jenkins 8 years ago
Mark Haines 618f94699b Document the optional parameter for specifying a filename to download an attachment as 8 years ago
Richard van der Hoff 8328e485ea Clean up the pushrules API doc
* make it clearer which fields go in which parts of the rule
* the example given appeared to be for a content rule, so use a content rule
  consistently through the examples.
8 years ago
Richard van der Hoff 7ac2f51e4a /upload: fix example for filename
The example shouldn't be encoded, else it will be double-encoded by swagger.
8 years ago
Benjamin Saunders 3e2dea4c52 Document filename query parameter for uploads
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
Richard van der Hoff ec20f15407 /tokenrefresh should expire the access token
It's possible for clients to call /tokenrefresh before the access_token has
expired, potentially leading to a proliferation of valid access_tokens.
8 years ago
Richard van der Hoff 2370a4c970 Spell out the state algorithm for createRoom
Fixes https://matrix.org/jira/browse/SPEC-429.

Synapse currently follows the specified ordering, but does *not* give the
specified error when the state is invalid (instead it creates the room anyway
but gives a 403 M_FORBIDDEN). Still, I don't think that should be a real
problem for any real clients, and nothing would break if we changed this in
synapse, so it might as well go in the spec anyway.
8 years ago
Erik Johnston a48437ced8 Spec /account/deactivate API 8 years ago
Richard van der Hoff a9d3cfd13c Merge branch 'master' into rav/link_undeprecated_endpoints 8 years ago
Richard van der Hoff d92515bce3 Merge pull request #354 from matrix-org/rav/reorder_deprecated_initialsync
Move /room/x/initialSync to after the undeprecated APIs
8 years ago
Richard van der Hoff 7080fd0618 Merge pull request #348 from Ralith/room-messages
Add missing "to" parameter to /messages
8 years ago
Benjamin Saunders dc7fc0309e Add missing "to" parameter to /messages
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
Richard van der Hoff 49cd65dd58 Add a license to the spec
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
8 years ago
Richard van der Hoff 6bcb1798f5 Mark deprecated endpoints with their replacements
Fixes https://matrix.org/jira/browse/SPEC-415
8 years ago
Richard van der Hoff 9d267795e0 Move /room/x/initialSync to after the undeprecated APIs
It's a bit incongruous to have to read through the deprecated /initialSync to
get to the good stuff. Separate out intialSync so that we can move it later in
the spec.
8 years ago
David Baker e91214e78e More links
Also remove now redundant anchor
8 years ago
David Baker cf13c8997c Merge branch 'dbkr/dont_line_wrap_rst' into dbkr/more_requesttokens 8 years ago
David Baker 7c8651480a Some PR feedback corrections
Including adding a hyperlink, although this requires a separate fix that I'll do on a different branch
8 years ago
Richard van der Hoff 19a59bc210 Merge pull request #345 from Ralith/require-prev_batch
Supply prev_batch unconditionally in timelines
8 years ago
David Baker c109da5b78 Attempt to make things clearer 8 years ago
David Baker 86db820bb1 Expand on summaries for requestToken endpoints 8 years ago
David Baker 191cb08a3a Add response section otherwise the checker fails 8 years ago
David Baker d74a320edd Stray tab 8 years ago
David Baker ead5648b8c Add requestToken endpoints
For password reset and 3pid adding
8 years ago
Benjamin Saunders ee5054fb42 Supply prev_batch unconditionally in timelines
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
David Baker 14ff3862e3 More PR feedback 8 years ago
David Baker e4db7be8e2 Better structure for error response
& add server not trusted error
8 years ago
David Baker 3dddc0dcdf Explain why not erroring on dup 3pid is desireable 8 years ago
David Baker a600386c05 Consistent working for error response
Also format json example better
8 years ago
David Baker 60293af83a PR feedback 8 years ago
David Baker 6a0c9edb49 Add the id_server param 8 years ago
David Baker 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
Richard van der Hoff 4f37e4ece0 Merge pull request #342 from matrix-org/erikj/presence
Fix and correctly document presence's currently_active
8 years ago
Erik Johnston 0de8ba7f0a currently_active is a param on GET response, not put 8 years ago
Mark Haines 30a3302921 Merge pull request #274 from matrix-org/markjh/default_rules
Update the predefined push rules in the spec
8 years ago
Erik Johnston e80e32173f Merge pull request #278 from matrix-org/erikj/presence
Update presence spec.
8 years ago
Erik Johnston 2691d4925b s/currently_online/currently_active/ 8 years ago
Richard van der Hoff 7bbb664784 Improve documentation of directory API 9 years ago
Richard van der Hoff 86a81b0450 Fix schema for /logout
'properties' is a map, not a list
9 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
9 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
9 years ago
Richard van der Hoff 2093a6bac9 Merge pull request #332 from matrix-org/rav/update_login_api
Update the /login API spec
9 years ago
Richard van der Hoff 959f1ff09f Update the /login API spec
Note that /login can be used with 3pid creds
9 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
9 years ago
Richard van der Hoff 2d28e5abce Fix basePath on /redact API doc 9 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
9 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.
9 years ago
Richard van der Hoff 23c4ffbc1b Add securityDefintions to generated swagger JSON
Also factor out to a common file
9 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
9 years ago
David Baker 1a856b53f3 Remove redundant info & add backticks 9 years ago
David Baker 4b294b23de Tailor descriptions to GET method 9 years ago
David Baker 4fafe1ab73 Return an object as the root element
Because otherwise it's impossible to change later
9 years ago
David Baker 42834340e7 Add title to the pushers array 9 years ago
David Baker 0f6e414eb6 Fix format (array of objects, not object) 9 years ago
David Baker 27113d71ff Fix indentation 9 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
9 years ago
Will Hunt c9ed063a36 Small copy paste error
'avatar url' should be 'profile information'
9 years ago
David Baker 39fe9e3896 Merge pull request #284 from matrix-org/dbkr/notification_counts
Add notification counts to doc
9 years ago
Daniel Wagner-Hall 11c572267e Add titles where they're missing 9 years ago
David Baker a78dff3981 Add notification counts to doc 9 years ago
Mark Haines d2c05d64c7 Document an API for setting and getting the actions for a push rule 9 years ago
Mark Haines 254fbe7983 Document GET for /pushrules/{scope}/{kind}/{ruleId}/enabled 9 years ago
David Baker e6143a6596 Merge pull request #281 from matrix-org/dbkr/fix_meta_escaping
Fix meta-escaping fail
9 years ago
David Baker 2c5392f1d1 Fix meta-escaping fail 9 years ago
Daniel Wagner-Hall 016ccf4544 Remove signed object which shouldn't exist 9 years ago
Erik Johnston cbe466e572 Update API docs 9 years ago
Daniel Wagner-Hall ccac9e7882 /join accepts a signature for a third party invite 9 years ago
Richard van der Hoff bc83677d98 Define the order for events returned by /context API 9 years ago
Richard van der Hoff 68a4306773 Split room previews into a separate module
Guest access and room peeking are orthogonal
9 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.
9 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 9 years ago
David Baker 53a4a563e2 Actually we think they should not be present (which means synapse is buggy). 9 years ago
David Baker 542b17e944 Clarify what profile endpoints return if avatar url / display name isn't set 9 years ago
Richard van der Hoff 58b346e204 s/user_id/sender/ in context example response 9 years ago
Richard van der Hoff b2e0a855cc Add 'event' to event context API
also link through to the event schemas
9 years ago
Mark Haines e7f80b7c71 Fix the key name to be three_pid_creds rather than threePidCreds 9 years ago
Daniel Wagner-Hall 2e46b587b8 Require explicit un-banning 9 years ago
David Baker 169cc98101 M_INVALID_USERNAME to be consistent with the name of the parameter 9 years ago
David Baker 2301a792d7 Add an error code for invalid user names. 9 years ago
Matthew Hodgson cfbb695fd3 typoe 9 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.
9 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
9 years ago
Richard van der Hoff 972153be4f Fix endpoint path for /context
s/api//
9 years ago
Richard van der Hoff ff26e0dc48 Add some missing titles to the filter upload spec 9 years ago
Daniel Wagner-Hall 0e967edfd9 Fix thinko 9 years ago
Daniel Wagner-Hall 7d9547274c Clarify guest /events and /sync 9 years ago
Daniel Wagner-Hall 48aab7bad9 Return room avatar URLs in /publicRooms 9 years ago
Daniel Wagner-Hall 5e30d75ccb Add /_matrix/versions to spec 9 years ago
Erik Johnston 48f56bfbfb Support 3pid invites in /createRoom 9 years ago
Daniel Wagner-Hall 1eee36e889 Merge pull request #232 from matrix-org/daniel/deprecatestuff
Deprecated deprecated APIs
9 years ago
Matthew Hodgson c7d11335cf Merge branch 'master' of git+ssh://github.com/matrix-org/matrix-doc 9 years ago
Matthew Hodgson 691d9ba664 typo :( 9 years ago
Mark Haines 4c43939977 more backticks 9 years ago
Mark Haines 9b4a37f57b backticks 9 years ago
Mark Haines 288c7ed353 Add top level filters for filtering by room id. 9 years ago
Mark Haines 2ea66e9300 Merge branch 'markjh/account_data_filters' into markjh/room_filter 9 years ago
Mark Haines a32ed96a0f Document filtering for account data 9 years ago
Mark Haines e413f05c87 Merge pull request #243 from matrix-org/markjh/wildcards
Filters don't support wildcards for senders or room ids
9 years ago
Mark Haines c9349b302a Filters don't support wildcards for senders or room ids 9 years ago
Richard van der Hoff b7c255a887 Tweaks/clarifications to search spec
Fixes https://matrix.org/jira/browse/SPEC-305
9 years ago
Daniel Wagner-Hall b6cd3adc2f Merge pull request #233 from matrix-org/daniel/txnid
Merge pull request #233 from matrix-org/daniel/txnid
9 years ago
Christine Dodrill 7090e491de fix a typo in the example json for the old sync description 9 years ago
Erik Johnston 7980e65502 Merge pull request #234 from matrix-org/erikj/search_yet_agian
Note that count is approximate
9 years ago
Erik Johnston 88b350ca8b Better wording 9 years ago
Erik Johnston a2082e4b38 Note that count is approximate 9 years ago
Daniel Wagner-Hall dbba737135 Explain scope of uniqueness of txnid 9 years ago
Daniel Wagner-Hall 3e086909f1 Deprecated deprecated APIs 9 years ago
Daniel Wagner-Hall a484f04b33 Merge pull request #221 from matrix-org/daniel/pushaway
Merge pull request #221 from matrix-org/daniel/pushaway
9 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
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