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
9 years ago
David Baker
3dddc0dcdf
Explain why not erroring on dup 3pid is desireable
9 years ago
David Baker
a600386c05
Consistent working for error response
...
Also format json example better
9 years ago
David Baker
60293af83a
PR feedback
9 years ago
David Baker
6a0c9edb49
Add the id_server param
9 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#
9 years ago
Richard van der Hoff
4f37e4ece0
Merge pull request #342 from matrix-org/erikj/presence
...
Fix and correctly document presence's currently_active
9 years ago
Erik Johnston
0de8ba7f0a
currently_active is a param on GET response, not put
9 years ago
Mark Haines
30a3302921
Merge pull request #274 from matrix-org/markjh/default_rules
...
Update the predefined push rules in the spec
9 years ago
Erik Johnston
e80e32173f
Merge pull request #278 from matrix-org/erikj/presence
...
Update presence spec.
9 years ago
Erik Johnston
2691d4925b
s/currently_online/currently_active/
9 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
Daniel Wagner-Hall
e0ebabf8cc
Explicitly document /rooms/{roomId}/state/{eventType} without state key
9 years ago
Daniel Wagner-Hall
873b0dcecf
Replace version numbers with release numbers
9 years ago
Daniel Wagner-Hall
f308b7543c
Specify /admin/whois/{userId}
9 years ago
Daniel Wagner-Hall
19ce17cfed
Merge pull request #200 from matrix-org/daniel/redact
...
Merge pull request #200 from matrix-org/daniel/redact
9 years ago
Daniel Wagner-Hall
2f3a00fe34
Consistently spell homeserver as homeserver
9 years ago
Daniel Wagner-Hall
e072d215cf
Specify redaction
9 years ago
Daniel Wagner-Hall
7f07da4b50
Remove obsolete documentation
9 years ago
Daniel Wagner-Hall
aa4ed10821
Unify v1 and v2 event schemas
9 years ago
Daniel Wagner-Hall
681c258206
Fix turnServer endpoint
9 years ago
Erik Johnston
ca7ef1b536
Update Results description
9 years ago
Erik Johnston
5e8bb34f36
Change the results dict to a list
9 years ago
Erik Johnston
46fd0b252c
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian
9 years ago
Daniel Wagner-Hall
c6e0322a9e
Swaggerify /account
9 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.
9 years ago
Daniel Wagner-Hall
3951785f19
Fix alias path
9 years ago
Daniel Wagner-Hall
bc514dc9c4
Merge pull request #178 from matrix-org/daniel/directory
...
Fix and include /directory api docs
9 years ago
Daniel Wagner-Hall
7f2813354d
Swaggerify /ban
9 years ago
Mark Haines
a20a49abf6
Merge pull request #168 from matrix-org/markjh/client_config
...
Add API for setting client config
9 years ago
Mark Haines
c5f457cee9
Merge pull request #132 from matrix-org/markjh/room_tags
...
Document a v2 api for setting tags on rooms
9 years ago
Daniel Wagner-Hall
f0c99a6925
Generate API docs from swagger
9 years ago
Mark Haines
c539b208f9
Merge branch 'markjh/room_tags' into markjh/client_config
...
Conflicts:
api/client-server/v2_alpha/sync.yaml
9 years ago
Mark Haines
d39494b6df
Fix typo in sync example
9 years ago
Daniel Wagner-Hall
5e30b5b8d7
Remove POST version of /send
...
PUT should always be used.
9 years ago
Daniel Wagner-Hall
c25a806cef
Fix and include /directory api docs
9 years ago
Mark Haines
5ccc39b850
Say that type is an event type
9 years ago
Mark Haines
e76068a2a6
Merge branch 'markjh/room_tags' into markjh/client_config
9 years ago
Mark Haines
5bae15d47b
Merge branch 'master' into markjh/room_tags
...
Conflicts:
api/client-server/v2_alpha/sync.yaml
9 years ago
Erik Johnston
46870da57d
Add optional profile info and state in search response
9 years ago
Richard van der Hoff
d8dd380dfa
Merge pull request #164 from matrix-org/rav/SPEC-254
...
Fix /sync documentation, post SPEC-254
9 years ago
Mark Haines
05c0092664
s/config/account_data/
9 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.
9 years ago
Mark Haines
40f7eab73f
s/private_user_data/account_data/
9 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
9 years ago
Mark Haines
fcbb985073
s/private_user_data/account_data/
9 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.
9 years ago
Daniel Wagner-Hall
6763317e64
Specify /rooms/:room_id/forget
9 years ago
Daniel Wagner-Hall
8201eaa042
Swaggerify /rooms/:room_id/leave
9 years ago
Erik Johnston
ffed14a0cd
Add next_batch token
9 years ago
Erik Johnston
8991c4fa78
Fix schema and example
9 years ago
Erik Johnston
5e0e4a8518
Document group and context response keys
9 years ago
Mark Haines
299af673da
Specify how ordering of tags is supposed to work
9 years ago
Mark Haines
3b390bff3c
Merge branch 'master' into markjh/room_tags
...
Conflicts:
api/client-server/v1/rooms.yaml
specification/targets.yaml
9 years ago
Mark Haines
8f5783615c
Merge branch 'master' into markjh/client_config
...
Conflicts:
api/client-server/v1/rooms.yaml
specification/targets.yaml
9 years ago
Mark Haines
22b3159a39
Add examples of v1 initialSync and v2 /sync returning the client config
9 years ago
Mark Haines
769c5285ab
Add API for setting client config
9 years ago
Erik Johnston
e2eb0c7ad9
Add new request options
9 years ago
Richard van der Hoff
e1b12a753e
Fix typos and missing file
9 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
9 years ago
Richard van der Hoff
b41d771c15
Fix typos in /sync example response
9 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.
9 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.
9 years ago
Daniel Wagner-Hall
061105c9dc
Guest users are allowed room initialSync
9 years ago
Daniel Wagner-Hall
dcf54e11b1
Specify /publicRooms world_readable and guest_access
...
Depends on https://github.com/matrix-org/matrix-doc/pull/154
9 years ago
Daniel Wagner-Hall
d7357ef9b7
Specify /publicRooms
9 years ago
Daniel Wagner-Hall
24c2036a35
3pid invites: remove mentions of display_name
9 years ago
Daniel Wagner-Hall
e72151f2c3
Specify guest room access
...
This was reviewed as PR #150 and merged from daniel/anonymousaccess
9 years ago
Daniel Wagner-Hall
161441fa3a
Update 3pid spec based on new implementation
9 years ago
Daniel Wagner-Hall
232b10b0f6
Merge branch 'master' of github.com:matrix-org/matrix-doc
9 years ago
Mark Haines
b7cc5b1018
Merge pull request #141 from matrix-org/markjh/full_http_api_docs
...
Include the full schema for an http API in the docs
9 years ago
Mark Haines
ebc0237109
Add the missing titles to the schema
9 years ago
Mark Haines
d53814097f
Add example content to the tags in example tag events
9 years ago
Mark Haines
e9d361841b
Fix tag examples
9 years ago
Daniel Wagner-Hall
2e3a0b4e00
Specify guest accounts
9 years ago
Mark Haines
52f55e0542
Allow room tags to have asssociated content, and return that content in the m.tag events
9 years ago
Mark Haines
f557e69860
Note that m.tag events can appear in v1 initialSync and /events as well as v2 sync. Only add the room_id for v1 /events since it is redundant in v1 /initialSync
9 years ago
Mark Haines
ad86426e95
Add private_user_data to v1 room /initialSync
9 years ago
Mark Haines
b49472e3b0
Add private_user_data to v1 /initialSync
9 years ago
Mark Haines
451801bf38
Add an example of ``prev_content`` in ``unsigned`` to v2 /sync
9 years ago
Erik Johnston
fa2fe2ddd9
Add event context api swagger
9 years ago
Matthew Hodgson
6c1df04b4b
typo
9 years ago
Richard van der Hoff
ece42688d0
Clarify the interaction between full_state and timeout.
9 years ago
Mark Haines
65066a76b3
Add the m.tags event to a ``private_user_data`` key rather than including it under the ``ephemeral`` key
9 years ago
Mark Haines
12e33a3b09
Document a v2 api for setting tags on rooms
9 years ago
Richard van der Hoff
13eddd456f
Proposal for adding full_state param to v2 sync
9 years ago
Kegsay
ade0ad5ed1
Merge pull request #129 from matrix-org/erikj/search_actual
...
Add filter param to search API
9 years ago
Erik Johnston
36634df355
Add filter param
9 years ago
Richard van der Hoff
f47a49de43
Merge pull request #126 from matrix-org/rav/send_events_api
...
Add the room send and state APIs to the spec
9 years ago
Richard van der Hoff
1945697456
Further tweaks to the room send and state APIs
...
- fix confusion re empty/absent state_keys
- move 'types of room events' section earlier in the 'Events' section
- remove some redundant anchors
9 years ago
Mark Haines
1d7cb6937f
Merge pull request #123 from matrix-org/markjh/list_formatting
...
Fix list formatting
9 years ago
Mark Haines
637718108e
Add newline before list
9 years ago
Richard van der Hoff
28ab643a4e
Remove duplicated registration/login APIs
...
Currently the spec duplicates all of the account-management APIs. There's still
work to be done here, but the complete duplication is confusing.
9 years ago
Richard van der Hoff
587a8ba7ce
Merge branch 'master' into rav/send_events_api
9 years ago
Richard van der Hoff
d2bbc461e4
mark stateKey as required in room/{id}/state
...
Swagger insists that path params be mandatory.
9 years ago
Richard van der Hoff
d18d406c41
Add the room send and state APIs to the spec
9 years ago
Mark Haines
cc14620932
Add a newline before the list
9 years ago
Mark Haines
e3e8026025
Fix list formatting so that we aren't including everything in blockquotes
9 years ago
Erik Johnston
f0c74a9c83
Merge pull request #96 from matrix-org/erikj/search_actual
...
Add search API
9 years ago
Kegan Dougal
f95d19cecd
Merge branch 'master' into appservice-swagger
...
Conflicts:
specification/application_service_api.rst
9 years ago
Kegan Dougal
4c3e1b9ed3
Find replace fail
9 years ago
Kegan Dougal
bd539c72b4
More review comments
9 years ago
Erik Johnston
1d01f69c3c
Merge remote-tracking branch 'origin/master' into erikj/search_actual
9 years ago
Kegan Dougal
26f27d95fb
Merge branch 'master' into registration-swagger
...
Conflicts:
specification/client_server_api.rst
9 years ago
Kegan Dougal
f450fc1db6
Typo
9 years ago
Kegan Dougal
4bb042daeb
Review comments round II
9 years ago
Kegan Dougal
e0fe3c42c8
Review comments
9 years ago
Kegan Dougal
6770d6b2d6
Review comments
9 years ago
Erik Johnston
716c5b7a8b
Add 400 and 429 response codes
9 years ago
Kegan Dougal
eca98af896
Swaggerify /register endpoint
...
Need to move registration/login/auth sections around once #94 lands.
9 years ago
Erik Johnston
cfca4a6c09
s/creteria/criteria/
9 years ago
Kegan Dougal
f20faa80e5
Swagger validation
9 years ago
Kegan Dougal
55cc5c5bb5
Swaggerify application services
9 years ago
Kegan Dougal
5de63b4f45
Merge branch 'master' into proofing
...
Conflicts:
specification/0-intro.rst
9 years ago
Kegan Dougal
1f2f14dc08
YAML tweaks
9 years ago
Kegan Dougal
84af5776d7
Newlines
9 years ago
Erik Johnston
2b9484cf48
Spell things correctly
9 years ago
Erik Johnston
392a1c5ad8
Another title
9 years ago
Erik Johnston
ca9e44baac
Moar titles
9 years ago
Erik Johnston
a7a5cb088b
Add titles
9 years ago
Erik Johnston
e42c8b5b63
Add search API
9 years ago
Richard van der Hoff
4a9db39277
Clean up some untruths in the login api doc
...
add "type", and "username" -> "user"
9 years ago
Kegan Dougal
6f6861a11d
Swaggerify the createRoom API
9 years ago
Kegan Dougal
41fb0645a9
Add message pagination API
9 years ago
Kegan Dougal
7bdb71b1c9
Tweak the syncing section
...
Bring together disparate sections to make it more cohesive.
9 years ago
Daniel Wagner-Hall
2502ca7ac6
Merge branch 'master' into daniel/threepidinvites-2
...
Conflicts:
specification/targets.yaml
9 years ago
Kegsay
616f3990aa
Merge pull request #87 from matrix-org/module-push
...
Push Module
9 years ago
Kegan Dougal
8f5c796884
Linkify 'pushers'
9 years ago
Mark Haines
d42c3195e6
Use 'true' rather than '1' for archived flag
9 years ago
Mark Haines
241096dc81
Add a flag to initial sync to indicate we want rooms that the user has left
9 years ago
Kegan Dougal
f2a6950cc3
Minor tweaks; allow objects without props/parents if a title is set
...
This allows us to do things like {Tweaks} where Tweaks is defined somewhere
else.
9 years ago
Daniel Wagner-Hall
dc3c02aff5
Review comments
9 years ago
Daniel Wagner-Hall
21a40b317d
Merge branch 'master' into daniel/threepidinvites-2
9 years ago
Kegan Dougal
9c95ee5c1f
Modify wording and formatting
9 years ago
Kegan Dougal
befa23624e
It's dangerous to go alone, take this.
9 years ago
Kegan Dougal
65504db7bb
Display nested keys on arrays of objects. Make it valid swagger.
9 years ago
Kegan Dougal
31ae4b3859
Swaggerify push notification API
...
Edit units.py to support nested JSON request keys
9 years ago
Kegan Dougal
a9618a981b
Swaggerify the /enabled endpoint
9 years ago
Kegan Dougal
56ce432399
Get profile tag keys displaying correctly.
9 years ago
Kegan Dougal
f6da9d7760
Give valid swagger. Split out rule/ruleset to separate definitions.
9 years ago
Kegan Dougal
db25276856
Start adding in push definitions
...
This is going to be painful to represent due to how the push API allows
mixed types (strings or objects) and mixed top-level keys ("content" rule kind
allowing "pattern" as a top-level key). We may wish to re-visit the design
of this API for v2.
9 years ago
Kegan Dougal
9540069acd
Use valid JSON
9 years ago
Kegan Dougal
c5edc60c4c
Add push YAML for pushers endpoint.
...
Also display "required" text on required JSON body request params. Also
increase the size of the request param column to support longer param names
present in the pushers API.
9 years ago
Mark Haines
034241eb20
Missing symlink for the v2 swagger APIs
9 years ago
Mark Haines
509d178d58
Fix the receipts API to be valid swagger
9 years ago
Mark Haines
4f606cf3a7
Add the fields required by the templating system to v2 sync
9 years ago
Mark Haines
5a5a6565ff
Merge pull request #68 from matrix-org/markjh/v2_sync_api
...
Swagger documentation for the v2 sync API
9 years ago
Mark Haines
0ce533d153
Split the room_map into separate sections based on whether they are
...
"joined/invited/archived".
Rename the room_map to rooms and remove the grouping indirection. When we
want groups then we can add them under a separate key, either at the
top-level or as part of the events themselves.
9 years ago
Mark Haines
0e5b00feaa
Fix event type in v2 sync example
9 years ago
Mark Haines
bbb5fa9398
Fix the state_key in the example v2 response, include the "sender" key in the list of keys included with invite_state events
9 years ago
Mark Haines
a7b808c5cd
Add a invite_state key for holding the state that is bundled with an
...
invite. This is kept separate from the actual state for the room as
it may be derived from an incomplete, unverified copy of the state
that was bundled with an invite event received over federation.
9 years ago
Mark Haines
ed0f6d3ff3
Typo
9 years ago
Mark Haines
97cdd8106c
s|client/api/v2_alpha|/client/v2_alpha|
9 years ago
Mark Haines
047419f2ad
Remove the room_id since it is redundent. Remove text about invite event handling till we've thought about it some more.
9 years ago
Mark Haines
bde003fe86
Split the rooms out into a separate top level key.
...
Divide the rooms into separate groups in preparation for adding tag
support.
Further subdivide the rooms into "joined/invited/archived" based the
membership of the user in the room because that membership affects what
events the user can view from the room. E.g only users that are joined
to a room may see the ephemeral events for the room.
9 years ago
Kegsay
ead79614ff
Merge pull request #78 from matrix-org/module-typing2
...
Typing module
9 years ago
Mark Haines
a73cc50aa9
s|client/api/v2_alpha|client/v2_alpha|
9 years ago
Kegan Dougal
09ac367847
Merge branch 'master' into module-content-repo
...
Conflicts:
templating/matrix_templates/units.py
9 years ago
Kegan Dougal
3d9dbe42e6
Bump to swagger-parser 3.2.1 - remove x- keys on headers
...
Removed x- keys due to https://github.com/BigstickCarpet/swagger-parser/issues/23
9 years ago
Daniel Wagner-Hall
af7d2ca9fc
Update 3pid invite spec
...
This takes into account:
1) That finding the existing servers of a room is hard
2) Federation
9 years ago
Daniel Wagner-Hall
d2c56fb7a3
Merge branch 'master' into daniel/threepidinvites-2
9 years ago
Kegan Dougal
87b6dd845e
Flesh out content repo; modify templating to support headers
...
Edit content-repo.yaml to include examples and headers.
Restructure content module to conform to the module template.
Adjust the HTTP API template to give 1 more char to the response
param to fit "Content-Disposition" correctly.
Edit the templating system to support displaying enums for
swagger APIs (before it was just JSON schema). Also add support
for introspecting headers from swagger. Finally, replace - with
_ when forming the {{ template_var }} else things whine.
9 years ago
Kegsay
8aad238cda
Merge pull request #80 from matrix-org/module-receipts
...
Receipts module
9 years ago
Kegan Dougal
da2be7eae4
Merge branch 'master' into module-voip
...
Conflicts:
specification/modules/voip_events.rst
9 years ago
Kegan Dougal
1520f3647f
Merge branch 'master' into module-typing2
...
Conflicts:
specification/modules/typing_notifications.rst
9 years ago
Kegan Dougal
c972dad8b3
Flesh out receipts module. Add receipts swagger
...
Add templating support for v2 apis.
9 years ago
Kegan Dougal
e82661413e
Add /turnServer endpoint
9 years ago
Erik Johnston
abe5d08ac6
Merge pull request #64 from matrix-org/erikj/invite_state
...
Bundle some state into invites
9 years ago
Kegan Dougal
2b7e02c080
Add sections for typing. Add swagger, JSON schema and example m.typing event
9 years ago
Mark Haines
931057accf
Add a top level presence key for the presence events and remove the public_user_data/private_user_data for now
9 years ago
Mark Haines
4cb3f78d2b
Wrap the "rooms" list inside an object so that we can add keys for pagination later
9 years ago
Mark Haines
218cf94ead
Replace the events array with events_map inside the room objects.
...
Only use indirection for the state and timeline events.
Use event_ids to reference the state and timeline events.
9 years ago
Erik Johnston
50e1b4c3a7
Fix up rst
9 years ago
Mark Haines
6ad6c40147
List the allowed values for the 'event_format' as an enum
9 years ago
Mark Haines
9dd3b07394
Allow '.' characters in event field names to be escaped with '\' so that
...
fields including a '.' can be included in a filter.
I considered replacing '.' with '/'. Since '/' was less likely to appear
in event field names. However if we used '\' to escape a literal '/' we
risk confusing it with the JSON escape '\/'.
9 years ago
Mark Haines
14b42a41d6
Document wildcard's in filters
9 years ago
Mark Haines
c115b4c2f4
Document the valid values for the "set_presence" parameter
9 years ago
Mark Haines
940e22940d
Document how the "not_foo" keys interact with the "foo" keys
9 years ago
Mark Haines
41bc09ea22
Split the event_filter into a event_filter and a room_event_filter that
...
extends it.
So that we don't include "rooms" and "not_rooms" keys for the public_user_data
and private_user_data filters.
9 years ago
Mark Haines
00fd4aac26
s/publically/publicly/
9 years ago
Mark Haines
3204c2f2b6
Fix spelling
9 years ago