595b75f299
Try & make example closer to valid
8 years ago
41781e95b2
Attempt valid json
8 years ago
c16ba9488f
Spec notifs API
8 years ago
37fb1ceb65
Merge pull request #395 from matrix-org/rav/kill_refresh_tokens
...
Remove references to refresh tokens and tokenrefresh
8 years ago
1d7531e9a1
Typo
8 years ago
d39f662df5
PR feedback
8 years ago
556ced36a4
Merge remote-tracking branch 'origin/master' into rav/store_and_forward
8 years ago
8fe8bd6a81
Add is_direct to member event spec.
8 years ago
f4c7fdfd03
Remove references to refresh tokens and tokenrefresh
...
refresh tokens are dead.
8 years ago
5fedc64230
double space
8 years ago
ae1c576648
Merge remote-tracking branch 'origin/master' into erikj/create_room_is_direct
8 years ago
069aa86a10
Update wording and add example to filter param
8 years ago
7919e8e159
Update wording.
8 years ago
a5bb182c67
Explicitly mention that directio of pagination is specified by the token
8 years ago
a66a744c45
Fix typo. Change responses in both places
8 years ago
06649b652d
Mark booleans as required. Remove mention that things may be null
8 years ago
b121feebce
Comment what the is_direct flag actually does
8 years ago
e8b21f357f
Explicitlty mention total_room_count_estimate
8 years ago
e854757c98
Mark required fields as required
8 years ago
0dc94d5c14
Expand on description of pagination tokens
8 years ago
37f6769a3c
Spec filter param on /messagse
8 years ago
085131b617
Add contains_url filter option
8 years ago
ebaaa7e3b3
Review feedback
...
* store-and-forward -> send-to-device
* describe motivation
* device ids are 10 capital chars
* etc
8 years ago
3a5cbd14c3
Add /createRoom is_direct flag
8 years ago
c05ee18f58
Add title and update description
8 years ago
130ea85576
Spec POST /publicRooms
8 years ago
877a6cfeb4
Spec new query params for /publicRooms
8 years ago
d81d0dbd1d
Spec canonical alias key
8 years ago
ccd7bb32d5
Specification for direct-to-device messages
8 years ago
cade909e25
Fix inconsistencies regarding redacted_because
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
7478e7f3cf
Add top-level account_data to /sync response
8 years ago
77b668a5dc
Fix some obsolete uses of user_id key in events
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 years ago
978d9ea6dd
fix the descriptions of the /room/.../state APIs to not be the wrong way round
8 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.
8 years ago
4b0e546eeb
PR feedback
...
Fix some typos, and clarify several aspects of server behaviour.
8 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.
8 years ago
d2fe2f1ff6
Fix jenkins
8 years ago
618f94699b
Document the optional parameter for specifying a filename to download an attachment as
8 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.
8 years ago
7ac2f51e4a
/upload: fix example for filename
...
The example shouldn't be encoded, else it will be double-encoded by swagger.
8 years ago
3e2dea4c52
Document filename query parameter for uploads
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 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.
8 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.
8 years ago
a48437ced8
Spec /account/deactivate API
8 years ago
a9d3cfd13c
Merge branch 'master' into rav/link_undeprecated_endpoints
8 years ago
d92515bce3
Merge pull request #354 from matrix-org/rav/reorder_deprecated_initialsync
...
Move /room/x/initialSync to after the undeprecated APIs
8 years ago
7080fd0618
Merge pull request #348 from Ralith/room-messages
...
Add missing "to" parameter to /messages
8 years ago
dc7fc0309e
Add missing "to" parameter to /messages
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
8 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).
8 years ago
6bcb1798f5
Mark deprecated endpoints with their replacements
...
Fixes https://matrix.org/jira/browse/SPEC-415
8 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.
8 years ago
e91214e78e
More links
...
Also remove now redundant anchor
8 years ago
cf13c8997c
Merge branch 'dbkr/dont_line_wrap_rst' into dbkr/more_requesttokens
8 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
8 years ago
19a59bc210
Merge pull request #345 from Ralith/require-prev_batch
...
Supply prev_batch unconditionally in timelines
9 years ago
c109da5b78
Attempt to make things clearer
9 years ago
86db820bb1
Expand on summaries for requestToken endpoints
9 years ago
191cb08a3a
Add response section otherwise the checker fails
9 years ago
d74a320edd
Stray tab
9 years ago
ead5648b8c
Add requestToken endpoints
...
For password reset and 3pid adding
9 years ago
ee5054fb42
Supply prev_batch unconditionally in timelines
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
9 years ago
14ff3862e3
More PR feedback
9 years ago
e4db7be8e2
Better structure for error response
...
& add server not trusted error
9 years ago
3dddc0dcdf
Explain why not erroring on dup 3pid is desireable
9 years ago
a600386c05
Consistent working for error response
...
Also format json example better
9 years ago
60293af83a
PR feedback
9 years ago
6a0c9edb49
Add the id_server param
9 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#
9 years ago
4f37e4ece0
Merge pull request #342 from matrix-org/erikj/presence
...
Fix and correctly document presence's currently_active
9 years ago
0de8ba7f0a
currently_active is a param on GET response, not put
9 years ago
30a3302921
Merge pull request #274 from matrix-org/markjh/default_rules
...
Update the predefined push rules in the spec
9 years ago
e80e32173f
Merge pull request #278 from matrix-org/erikj/presence
...
Update presence spec.
9 years ago
2691d4925b
s/currently_online/currently_active/
9 years ago
7bbb664784
Improve documentation of directory API
9 years ago
86a81b0450
Fix schema for /logout
...
'properties' is a map, not a list
9 years ago
e7e9f5fa46
Document the /logout api
...
We have one, and it's useful, so we really ought to document it
9 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
9 years ago
2093a6bac9
Merge pull request #332 from matrix-org/rav/update_login_api
...
Update the /login API spec
9 years ago
959f1ff09f
Update the /login API spec
...
Note that /login can be used with 3pid creds
9 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
9 years ago
2d28e5abce
Fix basePath on /redact API doc
9 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
9 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.
9 years ago
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
23c4ffbc1b
Add securityDefintions to generated swagger JSON
...
Also factor out to a common file
9 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
9 years ago
affb106014
Remove redundant scripts under api/
...
We now use newer swagger, via scripts/dump-swagger.py
9 years ago
1a856b53f3
Remove redundant info & add backticks
9 years ago
4b294b23de
Tailor descriptions to GET method
9 years ago
4fafe1ab73
Return an object as the root element
...
Because otherwise it's impossible to change later
9 years ago
42834340e7
Add title to the pushers array
9 years ago
0f6e414eb6
Fix format (array of objects, not object)
9 years ago
27113d71ff
Fix indentation
9 years ago
73d6e901ae
Add endpoint for getting a user's pushers
...
Also add profile_tag to the set docs as it was missing
9 years ago
c9ed063a36
Small copy paste error
...
'avatar url' should be 'profile information'
9 years ago
1d6c405f62
Fix presumably c+p fail
9 years ago
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
89453bfd8c
Remove spurious blank line
9 years ago
64c6d30f90
hopefully fix rst
9 years ago
7faf2cf642
Paragraph breaks & missed word
9 years ago
David Baker