Commit Graph

542 Commits (8e97ec8badb5101910ce103bffd69c106f7e28df)

Author SHA1 Message Date
Benjamin Saunders 3e2dea4c52 Document filename query parameter for uploads
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
9 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.
10 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.
10 years ago
Erik Johnston a48437ced8 Spec /account/deactivate API 10 years ago
Richard van der Hoff a9d3cfd13c Merge branch 'master' into rav/link_undeprecated_endpoints 10 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
10 years ago
Richard van der Hoff 7080fd0618 Merge pull request #348 from Ralith/room-messages
Add missing "to" parameter to /messages
10 years ago
Benjamin Saunders dc7fc0309e Add missing "to" parameter to /messages
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
10 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).
10 years ago
Richard van der Hoff 6bcb1798f5 Mark deprecated endpoints with their replacements
Fixes https://matrix.org/jira/browse/SPEC-415
10 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.
10 years ago
David Baker e91214e78e More links
Also remove now redundant anchor
10 years ago
David Baker cf13c8997c Merge branch 'dbkr/dont_line_wrap_rst' into dbkr/more_requesttokens 10 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
10 years ago
Richard van der Hoff 19a59bc210 Merge pull request #345 from Ralith/require-prev_batch
Supply prev_batch unconditionally in timelines
10 years ago
David Baker c109da5b78 Attempt to make things clearer 10 years ago
David Baker 86db820bb1 Expand on summaries for requestToken endpoints 10 years ago
David Baker 191cb08a3a Add response section otherwise the checker fails 10 years ago
David Baker d74a320edd Stray tab 10 years ago
David Baker ead5648b8c Add requestToken endpoints
For password reset and 3pid adding
10 years ago
Benjamin Saunders ee5054fb42 Supply prev_batch unconditionally in timelines
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
10 years ago
David Baker 14ff3862e3 More PR feedback 10 years ago
David Baker e4db7be8e2 Better structure for error response
& add server not trusted error
10 years ago
David Baker 3dddc0dcdf Explain why not erroring on dup 3pid is desireable 10 years ago
David Baker a600386c05 Consistent working for error response
Also format json example better
10 years ago
David Baker 60293af83a PR feedback 10 years ago
David Baker 6a0c9edb49 Add the id_server param 10 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#
10 years ago
Richard van der Hoff 4f37e4ece0 Merge pull request #342 from matrix-org/erikj/presence
Fix and correctly document presence's currently_active
10 years ago
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 1fe00b1517 Reinstate validator.js
It turns out that validator.js is used by the jenkins build script to, uh,
validate the docs.

This partially reverts commit affb106014.
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
Richard van der Hoff affb106014 Remove redundant scripts under api/
We now use newer swagger, via scripts/dump-swagger.py
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 1d6c405f62 Fix presumably c+p fail 10 years ago
David Baker cf850b4270 Fix level of `counts` and `devices`
They are actually within the notification object rather than the top level object. Add titles to objects so it works.
10 years ago
David Baker 89453bfd8c Remove spurious blank line 10 years ago
David Baker 64c6d30f90 hopefully fix rst 10 years ago
David Baker 7faf2cf642 Paragraph breaks & missed word 10 years ago
David Baker 7e1cb9003c Make swagger valid 10 years ago
David Baker 71cb646541 Change `id` in the push gateway poke to be `event_id` and spec that it's the Matrix event ID of the message. Correct the spec for badge count pushes which omit fields previously described as mandatory. Add more detail about when to use event_id to suppress dupes. Also add the push gateway doc so it's actually included in the spec. 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 fecff8afdc Specify association lookup 10 years ago
Daniel Wagner-Hall e0c55eeccf Add initial identity server spec
More to come
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
Oddvar Lovaas b28989b2ad fix for https://github.com/matrix-org/matrix-doc/issues/270 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
Daniel Wagner-Hall 705556634a Add filters 10 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.
10 years ago
Daniel Wagner-Hall 614ee9ea1b Move application service swagger out of c-s dir 10 years ago
Mark Haines 140206ca69 s/archived/leave/ 10 years ago
Mark Haines 79d109f7cc Add an flag to control whether rooms the user has left are included in the sync 10 years ago
Daniel Wagner-Hall e0ebabf8cc Explicitly document /rooms/{roomId}/state/{eventType} without state key 10 years ago
Daniel Wagner-Hall 873b0dcecf Replace version numbers with release numbers 10 years ago
Daniel Wagner-Hall f308b7543c Specify /admin/whois/{userId} 10 years ago
Daniel Wagner-Hall 19ce17cfed Merge pull request #200 from matrix-org/daniel/redact
Merge pull request #200 from matrix-org/daniel/redact
10 years ago
Daniel Wagner-Hall 2f3a00fe34 Consistently spell homeserver as homeserver 10 years ago
Daniel Wagner-Hall e072d215cf Specify redaction 10 years ago
Daniel Wagner-Hall 7f07da4b50 Remove obsolete documentation 10 years ago
Daniel Wagner-Hall aa4ed10821 Unify v1 and v2 event schemas 10 years ago
Daniel Wagner-Hall 681c258206 Fix turnServer endpoint 10 years ago
Erik Johnston ca7ef1b536 Update Results description 10 years ago
Erik Johnston 5e8bb34f36 Change the results dict to a list 10 years ago
Erik Johnston 46fd0b252c Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian 10 years ago
Daniel Wagner-Hall c6e0322a9e Swaggerify /account 10 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.
10 years ago
Daniel Wagner-Hall 3951785f19 Fix alias path 10 years ago
Daniel Wagner-Hall bc514dc9c4 Merge pull request #178 from matrix-org/daniel/directory
Fix and include /directory api docs
10 years ago
Daniel Wagner-Hall 7f2813354d Swaggerify /ban 10 years ago
Mark Haines a20a49abf6 Merge pull request #168 from matrix-org/markjh/client_config
Add API for setting client config
10 years ago
Mark Haines c5f457cee9 Merge pull request #132 from matrix-org/markjh/room_tags
Document a v2 api for setting tags on rooms
10 years ago
Daniel Wagner-Hall f0c99a6925 Generate API docs from swagger 10 years ago
Mark Haines c539b208f9 Merge branch 'markjh/room_tags' into markjh/client_config
Conflicts:
	api/client-server/v2_alpha/sync.yaml
10 years ago
Mark Haines d39494b6df Fix typo in sync example 10 years ago
Daniel Wagner-Hall 5e30b5b8d7 Remove POST version of /send
PUT should always be used.
10 years ago
Daniel Wagner-Hall c25a806cef Fix and include /directory api docs 10 years ago
Mark Haines 5ccc39b850 Say that type is an event type 10 years ago
Mark Haines e76068a2a6 Merge branch 'markjh/room_tags' into markjh/client_config 10 years ago
Mark Haines 5bae15d47b Merge branch 'master' into markjh/room_tags
Conflicts:
	api/client-server/v2_alpha/sync.yaml
10 years ago
Erik Johnston 46870da57d Add optional profile info and state in search response 10 years ago
Richard van der Hoff d8dd380dfa Merge pull request #164 from matrix-org/rav/SPEC-254
Fix /sync documentation, post SPEC-254
10 years ago
Mark Haines 05c0092664 s/config/account_data/ 10 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.
10 years ago
Mark Haines 40f7eab73f s/private_user_data/account_data/ 10 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
10 years ago
Mark Haines fcbb985073 s/private_user_data/account_data/ 10 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.
10 years ago
Daniel Wagner-Hall 6763317e64 Specify /rooms/:room_id/forget 10 years ago
Daniel Wagner-Hall 8201eaa042 Swaggerify /rooms/:room_id/leave 10 years ago
Erik Johnston ffed14a0cd Add next_batch token 10 years ago
Erik Johnston 8991c4fa78 Fix schema and example 10 years ago
Erik Johnston 5e0e4a8518 Document group and context response keys 10 years ago
Mark Haines 299af673da Specify how ordering of tags is supposed to work 10 years ago
Mark Haines 3b390bff3c Merge branch 'master' into markjh/room_tags
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
10 years ago
Mark Haines 8f5783615c Merge branch 'master' into markjh/client_config
Conflicts:
	api/client-server/v1/rooms.yaml
	specification/targets.yaml
10 years ago
Mark Haines 22b3159a39 Add examples of v1 initialSync and v2 /sync returning the client config 10 years ago
Mark Haines 769c5285ab Add API for setting client config 10 years ago
Erik Johnston e2eb0c7ad9 Add new request options 10 years ago
Richard van der Hoff e1b12a753e Fix typos and missing file 10 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
10 years ago
Richard van der Hoff b41d771c15 Fix typos in /sync example response 10 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.
10 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.
10 years ago
Daniel Wagner-Hall 061105c9dc Guest users are allowed room initialSync 10 years ago
Daniel Wagner-Hall dcf54e11b1 Specify /publicRooms world_readable and guest_access
Depends on https://github.com/matrix-org/matrix-doc/pull/154
10 years ago
Daniel Wagner-Hall d7357ef9b7 Specify /publicRooms 10 years ago