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
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
.
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
Richard van der Hoff
affb106014
Remove redundant scripts under api/
...
We now use newer swagger, via scripts/dump-swagger.py
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
1d6c405f62
Fix presumably c+p fail
9 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.
9 years ago
David Baker
89453bfd8c
Remove spurious blank line
9 years ago
David Baker
64c6d30f90
hopefully fix rst
9 years ago
David Baker
7faf2cf642
Paragraph breaks & missed word
9 years ago
David Baker
7e1cb9003c
Make swagger valid
9 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.
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
fecff8afdc
Specify association lookup
9 years ago
Daniel Wagner-Hall
e0c55eeccf
Add initial identity server spec
...
More to come
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
Oddvar Lovaas
b28989b2ad
fix for https://github.com/matrix-org/matrix-doc/issues/270
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