cade909e25
Fix inconsistencies regarding redacted_because
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
9 years ago
7478e7f3cf
Add top-level account_data to /sync response
9 years ago
77b668a5dc
Fix some obsolete uses of user_id key in events
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
9 years ago
978d9ea6dd
fix the descriptions of the /room/.../state APIs to not be the wrong way round
9 years ago
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.
9 years ago
4b0e546eeb
PR feedback
...
Fix some typos, and clarify several aspects of server behaviour.
9 years ago
41368dc5a7
document CAS login
...
Following the spirit of "document how it is, not how we wish it was", document
the CAS login bits.
9 years ago
d2fe2f1ff6
Fix jenkins
9 years ago
618f94699b
Document the optional parameter for specifying a filename to download an attachment as
9 years ago
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.
9 years ago
7ac2f51e4a
/upload: fix example for filename
...
The example shouldn't be encoded, else it will be double-encoded by swagger.
10 years ago
3e2dea4c52
Document filename query parameter for uploads
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
10 years ago
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
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
a48437ced8
Spec /account/deactivate API
10 years ago
a9d3cfd13c
Merge branch 'master' into rav/link_undeprecated_endpoints
10 years ago
d92515bce3
Merge pull request #354 from matrix-org/rav/reorder_deprecated_initialsync
...
Move /room/x/initialSync to after the undeprecated APIs
10 years ago
7080fd0618
Merge pull request #348 from Ralith/room-messages
...
Add missing "to" parameter to /messages
10 years ago
dc7fc0309e
Add missing "to" parameter to /messages
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
10 years ago
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
6bcb1798f5
Mark deprecated endpoints with their replacements
...
Fixes https://matrix.org/jira/browse/SPEC-415
10 years ago
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
e91214e78e
More links
...
Also remove now redundant anchor
10 years ago
cf13c8997c
Merge branch 'dbkr/dont_line_wrap_rst' into dbkr/more_requesttokens
10 years ago
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
19a59bc210
Merge pull request #345 from Ralith/require-prev_batch
...
Supply prev_batch unconditionally in timelines
10 years ago
c109da5b78
Attempt to make things clearer
10 years ago
86db820bb1
Expand on summaries for requestToken endpoints
10 years ago
191cb08a3a
Add response section otherwise the checker fails
10 years ago
d74a320edd
Stray tab
10 years ago
ead5648b8c
Add requestToken endpoints
...
For password reset and 3pid adding
10 years ago
ee5054fb42
Supply prev_batch unconditionally in timelines
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
10 years ago
14ff3862e3
More PR feedback
10 years ago
e4db7be8e2
Better structure for error response
...
& add server not trusted error
10 years ago
3dddc0dcdf
Explain why not erroring on dup 3pid is desireable
10 years ago
a600386c05
Consistent working for error response
...
Also format json example better
10 years ago
60293af83a
PR feedback
10 years ago
6a0c9edb49
Add the id_server param
10 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#
10 years ago
4f37e4ece0
Merge pull request #342 from matrix-org/erikj/presence
...
Fix and correctly document presence's currently_active
10 years ago
0de8ba7f0a
currently_active is a param on GET response, not put
10 years ago
30a3302921
Merge pull request #274 from matrix-org/markjh/default_rules
...
Update the predefined push rules in the spec
10 years ago
e80e32173f
Merge pull request #278 from matrix-org/erikj/presence
...
Update presence spec.
10 years ago
2691d4925b
s/currently_online/currently_active/
10 years ago
7bbb664784
Improve documentation of directory API
10 years ago
86a81b0450
Fix schema for /logout
...
'properties' is a map, not a list
10 years ago
e7e9f5fa46
Document the /logout api
...
We have one, and it's useful, so we really ought to document it
10 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
10 years ago
2093a6bac9
Merge pull request #332 from matrix-org/rav/update_login_api
...
Update the /login API spec
10 years ago
959f1ff09f
Update the /login API spec
...
Note that /login can be used with 3pid creds
10 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
10 years ago
2d28e5abce
Fix basePath on /redact API doc
10 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
10 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.
10 years ago
23c4ffbc1b
Add securityDefintions to generated swagger JSON
...
Also factor out to a common file
10 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
10 years ago
1a856b53f3
Remove redundant info & add backticks
10 years ago
4b294b23de
Tailor descriptions to GET method
10 years ago
4fafe1ab73
Return an object as the root element
...
Because otherwise it's impossible to change later
10 years ago
42834340e7
Add title to the pushers array
10 years ago
0f6e414eb6
Fix format (array of objects, not object)
10 years ago
27113d71ff
Fix indentation
10 years ago
73d6e901ae
Add endpoint for getting a user's pushers
...
Also add profile_tag to the set docs as it was missing
10 years ago
c9ed063a36
Small copy paste error
...
'avatar url' should be 'profile information'
10 years ago
39fe9e3896
Merge pull request #284 from matrix-org/dbkr/notification_counts
...
Add notification counts to doc
10 years ago
11c572267e
Add titles where they're missing
10 years ago
a78dff3981
Add notification counts to doc
10 years ago
d2c05d64c7
Document an API for setting and getting the actions for a push rule
10 years ago
254fbe7983
Document GET for /pushrules/{scope}/{kind}/{ruleId}/enabled
10 years ago
e6143a6596
Merge pull request #281 from matrix-org/dbkr/fix_meta_escaping
...
Fix meta-escaping fail
10 years ago
2c5392f1d1
Fix meta-escaping fail
10 years ago
016ccf4544
Remove signed object which shouldn't exist
10 years ago
cbe466e572
Update API docs
10 years ago
ccac9e7882
/join accepts a signature for a third party invite
10 years ago
bc83677d98
Define the order for events returned by /context API
10 years ago
68a4306773
Split room previews into a separate module
...
Guest access and room peeking are orthogonal
10 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.
10 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
10 years ago
53a4a563e2
Actually we think they should not be present (which means synapse is buggy).
10 years ago
542b17e944
Clarify what profile endpoints return if avatar url / display name isn't set
10 years ago
58b346e204
s/user_id/sender/ in context example response
10 years ago
b2e0a855cc
Add 'event' to event context API
...
also link through to the event schemas
10 years ago
e7f80b7c71
Fix the key name to be three_pid_creds rather than threePidCreds
10 years ago
2e46b587b8
Require explicit un-banning
10 years ago
169cc98101
M_INVALID_USERNAME to be consistent with the name of the parameter
10 years ago
2301a792d7
Add an error code for invalid user names.
10 years ago
cfbb695fd3
typoe
10 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.
10 years ago
6265d6ce06
Merge pull request #254 from matrix-org/rav/filter_spec
...
Add some missing titles to the filter upload spec
10 years ago
972153be4f
Fix endpoint path for /context
...
s/api//
10 years ago
ff26e0dc48
Add some missing titles to the filter upload spec
10 years ago
0e967edfd9
Fix thinko
10 years ago
7d9547274c
Clarify guest /events and /sync
10 years ago
48aab7bad9
Return room avatar URLs in /publicRooms
10 years ago
5e30d75ccb
Add /_matrix/versions to spec
10 years ago
48f56bfbfb
Support 3pid invites in /createRoom
10 years ago
1eee36e889
Merge pull request #232 from matrix-org/daniel/deprecatestuff
...
Deprecated deprecated APIs
10 years ago
c7d11335cf
Merge branch 'master' of git+ssh://github.com/matrix-org/matrix-doc
10 years ago
691d9ba664
typo :(
10 years ago
4c43939977
more backticks
10 years ago
9b4a37f57b
backticks
10 years ago
288c7ed353
Add top level filters for filtering by room id.
10 years ago
2ea66e9300
Merge branch 'markjh/account_data_filters' into markjh/room_filter
10 years ago
a32ed96a0f
Document filtering for account data
10 years ago
e413f05c87
Merge pull request #243 from matrix-org/markjh/wildcards
...
Filters don't support wildcards for senders or room ids
10 years ago
c9349b302a
Filters don't support wildcards for senders or room ids
10 years ago
b7c255a887
Tweaks/clarifications to search spec
...
Fixes https://matrix.org/jira/browse/SPEC-305
10 years ago
b6cd3adc2f
Merge pull request #233 from matrix-org/daniel/txnid
...
Merge pull request #233 from matrix-org/daniel/txnid
10 years ago
7090e491de
fix a typo in the example json for the old sync description
10 years ago
7980e65502
Merge pull request #234 from matrix-org/erikj/search_yet_agian
...
Note that count is approximate
10 years ago
88b350ca8b
Better wording
10 years ago
a2082e4b38
Note that count is approximate
10 years ago
dbba737135
Explain scope of uniqueness of txnid
10 years ago
3e086909f1
Deprecated deprecated APIs
10 years ago
a484f04b33
Merge pull request #221 from matrix-org/daniel/pushaway
...
Merge pull request #221 from matrix-org/daniel/pushaway
10 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
10 years ago
c3a1318886
Make it explicit that the JSON filter object is passed as a string
10 years ago
c96848d1bc
Merge pull request #169 from matrix-org/erikj/search_yet_agian
...
Search: Document event context, groups and orders.
10 years ago
95255bcdf5
Use rst not html
10 years ago
e1fda6b6b6
Remove double the
10 years ago
9c98c80bde
Fix up filter description
10 years ago
ed70bcb180
Add a rationale for allowing both inline filters and passing filters by id.
10 years ago
878ce2f206
Allow the filter JSON to be passed inline in the /sync request
10 years ago
6025569a73
Remove unused 403 stub
10 years ago
0fb88e26f0
Add tags
10 years ago
4290882034
Remove superfluous quote
10 years ago
8e7f6d44f6
Remove v1 references
10 years ago
4967b092aa
Add description of state response key
10 years ago
a2283f5499
Remove /notify from client-server API
10 years ago
f4b9433c7b
Better wording
10 years ago
584104c432
Make example valid event id
10 years ago
fda07e0d41
Merge remote-tracking branch 'origin/master' into erikj/event_context_api
10 years ago
856dd9100e
Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian
10 years ago
118a6aa040
Reword groupings descriptions
10 years ago
1ef9cc37e3
Typo
10 years ago
fca8e5abe7
Add top level next_batch key to example
10 years ago
f81b967e2d
Make all the schema files yaml
10 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.
10 years ago
c9fee294df
Merge pull request #211 from matrix-org/daniel/extractas
...
Move application service swagger out of c-s dir
10 years ago
97579f15cb
Merge pull request #212 from matrix-org/daniel/pushdictification
...
Take object, not bool, as param
10 years ago
705556634a
Add filters
10 years ago
9c733a45e8
Take object, not bool, as param
...
Throughout our API we take objects. And swagger is unhappy with not
doing so.
10 years ago
614ee9ea1b
Move application service swagger out of c-s dir
10 years ago
140206ca69
s/archived/leave/
10 years ago
79d109f7cc
Add an flag to control whether rooms the user has left are included in the sync
10 years ago
e0ebabf8cc
Explicitly document /rooms/{roomId}/state/{eventType} without state key
10 years ago
873b0dcecf
Replace version numbers with release numbers
10 years ago
f308b7543c
Specify /admin/whois/{userId}
10 years ago
19ce17cfed
Merge pull request #200 from matrix-org/daniel/redact
...
Merge pull request #200 from matrix-org/daniel/redact
10 years ago
2f3a00fe34
Consistently spell homeserver as homeserver
10 years ago
Benjamin Saunders