7cd22f5690
Describe the rate limit error everywhere
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1153
7 years ago
1f12637d3f
Getting presence requires authentication
7 years ago
a6b0125da6
Our swagger doesn't support explode yet
7 years ago
d279fdafa6
Document the server_name query parameter on /join/{roomIdOrAlias}
...
Fixes https://github.com/matrix-org/matrix-doc/issues/904
7 years ago
7d94aaace8
Explicitly declare that the kick/ban reason will be on the membership event
...
Fixes https://github.com/matrix-org/matrix-doc/issues/798
7 years ago
2409c84968
Document the GET version of /login
...
Fixes https://github.com/matrix-org/matrix-doc/issues/677
7 years ago
0dd330962d
initial draft of .well-known discovery
7 years ago
d73b247688
3PE lookup service
7 years ago
a1309d636c
Remove "Clients should handle gracefully" sentence
7 years ago
41c18bed0f
+repository
7 years ago
21e957edfb
Better note for /config
7 years ago
1820df02d9
media => content repository
7 years ago
091b2a6771
Hard limit on requiring accessToken. Rephrased some sections
7 years ago
eeaf4385d7
Speling is my weakniss
7 years ago
80935eadcf
Update content-repo.yaml
7 years ago
ddc152347b
Extending words and rate limiting
7 years ago
f032d6d1c3
Update keys.yaml
...
Fixed an end to end document bug , a format misleading in an claim response
7 years ago
1140c0c05b
Document StateEvent for /createRoom ( #1329 )
7 years ago
6d0a56d190
Suggestions by Travis tend to be sensible ones
7 years ago
6b9640bcb4
upload_size => m.upload.size
7 years ago
077cd04a6d
/limits => /config
7 years ago
5ab5fe08d1
Small grammatical and stylistic fixes
7 years ago
df5455de1f
re-arrange fields in example /search request to make them a valid request.
7 years ago
64f97c5b78
add example of highlights field in /search response
7 years ago
4ff5887c91
spec the highlights field in /search response
7 years ago
42fba1a87e
Add 'default' to formally enforce the description
...
A quick follow up on #1265 .
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
7 years ago
3dc54b20c6
Merge branch 'master' into travis/clarify-routing-loops
7 years ago
8610effad7
Merge branch 'master' into travis/reporting
7 years ago
7cc15f3315
Document the allow_remote query param on the media repo
...
Fixes https://github.com/matrix-org/matrix-doc/issues/837
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
9037f506ac
Document how to report content
...
Fixes: https://github.com/matrix-org/matrix-doc/issues/739
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
4278cd56a4
Document /logout/all
...
Fixes https://github.com/matrix-org/matrix-doc/issues/700
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
cc54a4f8cb
/rooms/{roomId}/members: specify access_token requirement
...
as the behaviour of which members the users see is user-specific
and therefore requires authentication.
Signed-off-by: Florian Jacob <projects+git AT florianjacob )DOT( de>
7 years ago
bb39bea44d
Merge pull request #1169 from mujx/event-id-format
...
Use the correct event_id format on examples
7 years ago
55b512c968
add delete_devices endpoint
...
fix #1041
7 years ago
34140a785d
fix typo in delete device
7 years ago
ffc8ee298a
a upload > an upload
7 years ago
de6fe1b76e
Add note about auth
7 years ago
c9abf36097
size > upload_size
7 years ago
2783820f98
Initial draft of GET media/limits
7 years ago
048de9803e
Fix typo.
7 years ago
7448ef0db0
Use the correct event_id format on examples
...
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
7 years ago
cd26c170de
Specify token used in /login is not an Access Token ( #1155 )
...
* Specify token used in /login is not an Access Token
While working through the implementation of /login in Dendrite, it was
confusing what the contents of the token attribute in the login request
body referred to. Initially, I thought it was an access token, which led
to further confusion. This commit explicitly states that the token is a
login token, which is separate from an access token, hopefully reducing
confusion for future readers.
Signed-off-by: Andrew Morgan (https://amorgan.xyz ) <andrew@amorgan.xyz>
7 years ago
2644e5657d
Merge pull request #1152 from turt2live/travis/clarify-whoami
...
Improve documentation around /account/whoami
7 years ago
159ab7313f
Fix typos in whoami.yaml
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
b7f8f20de9
Reword the appservice portion of /account/whoami
...
Credit goes to richvdh - suggestions taken with edits.
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
6ba5d7ca92
Reword appservice requirements for /account/whoami
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
a549baa01d
registration.yaml: fix typo
...
it's -> its
7 years ago
2e4e5e25e8
Improve documentation around /account/whoami
...
Clarifies: https://github.com/matrix-org/matrix-doc/issues/1135
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
15cdde3f49
Add GET /register/available
...
Adds https://github.com/matrix-org/matrix-doc/issues/911
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
d88a1308c2
Formatting and remove DELETE /directory/list
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
5cbfa73fe4
Improve documentation of /directory/list
...
* 404 for room not found instead of 400
* GET doesn't require an access token
* PUT (and therefore DELETE) can have it's own access control checks
* DELETE is implemented because of synapse
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
e4f7ba70f5
Merge branch 'master' into travis/spec-directory-list
7 years ago
595667d15d
Spec /directory/list
...
Adds https://github.com/matrix-org/matrix-doc/issues/417
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
c8393306d1
Add IS ping endpoint
7 years ago
de6d2c96fe
Minor grammar fix.
7 years ago
f7bbcd1678
Merge pull request #1110 from t3chguy/rooms/event
...
Document new rooms/$/event/$ API for fetching a single event (no ctx)
7 years ago
04eb6c7b65
link to both context and event in depr notice as per review
7 years ago
c5816a80af
move /rooms/{roomId}/event/{eventId} and update depr notice
7 years ago
06911d4fab
Merge branch 'master' of https://github.com/matrix-org/matrix-doc into t3chguy/search_defaults
7 years ago
a9c3d94f24
Merge branch 'master' of https://github.com/matrix-org/matrix-doc into rooms/event
7 years ago
a5374c7df7
Document new rooms/$/event/$ API for fetching a single event (no ctx)
7 years ago
dc27323d8b
Document the defaults for the /search API
7 years ago
59e4c625b3
Merge pull request #1093 from CromFr/guest_can_join
...
Add createRoom guest_can_join parameter
7 years ago
fa0eb2405f
all rooms, not any, and remove extra words
7 years ago
ca09415e80
Fix /keys/changes response to reflect reality
7 years ago
bb0bbedb87
indenting
7 years ago
1674b0e3b5
Doc /keys/query 'token' param
7 years ago
784adade9b
changes based on Pull Request feedback
7 years ago
3d8fe6e090
merge profiles with user directory into user data, also fix typo
7 years ago
605510e965
Merge branch 'master' into user_directory
7 years ago
d219cbc978
apply points from review
7 years ago
00b28495a6
Explain how to split an mxid
7 years ago
d9a4ddbf65
Mark `home_server` field deprecated
...
This is spelt wrong, and is redundant to user_id, so let's stop people using
it.
7 years ago
97445195f6
add user_directory
7 years ago
e9622bf9e4
Fix example in email based registration endpoint
...
The spec says `send_attempt` should be a number, but the example shows it as a string.
Signed-off-by: Gergely Polonkai <gergely@polonkai.eu>
7 years ago
b270233549
Add createRoom guest_can_join parameter
7 years ago
5e2a48f709
createRoom StateEvent.content should be an object
7 years ago
9d2e18cca1
Adapt paths as per feedback
7 years ago
d1e64daa10
Fix yaml title for directory api
7 years ago
28c09aed62
Properly mark required response keys to pass tests
7 years ago
8a6103798e
Fix for tests
7 years ago
bb50ec2e88
Document directory query endpoint
7 years ago
2128924933
Merge pull request #1072 from maxidor/max/ss/version
...
Document federation version endpoint
7 years ago
1045bc721d
Document federation version endpoint
7 years ago
828086a86c
Supply operationId for freshly added IS and AS operations
7 years ago
a68b7e1bbd
Supply operationId with freshly added operations
...
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
7 years ago
b53083732b
Merge remote-tracking branch 'remotes/origin/master'
7 years ago
868af0a7a1
Provide doc-comments with makeHandler(); cleanup
7 years ago
5147a3b975
Fix broken links & grammar
7 years ago
45af878e11
Merge remote-tracking branch 'origin/master' into dbkr/is_bulk_lookup
7 years ago
d728e67751
Merge pull request #1068 from matrix-org/dbkr/threepid_add_msisdn
...
Document threepids
7 years ago
836e6c81d1
Fix spelling
7 years ago
e80675c9e9
Link in markdown, not swagger
7 years ago
493b936209
Make these links more specific too
7 years ago
cdfff67878
Create spec for IS bulk lookup
7 years ago
0f5a4efce6
Spec URL previews ( #1064 )
...
* Spec URL previews
* Require authentication on /upload and /preview_url
7 years ago
6edb90a08e
Document threepids
...
Adds the /msisdn' 3pid type and generally fleshes out what a 3pid
is and how they work.
This merges most of the work from Max Dor in https://github.com/matrix-org/matrix-doc/pull/1039
with some tweaks and additions.
7 years ago
33463e3907
Factor out parser.validate callback
7 years ago
2468c38482
Add required property to whoami
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
41db12713d
Update whoami endpoint
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
9cf2b59f4e
Make it less obvious where this was copy/pasted from
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
b1801ea6db
Spec /account/whoami
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
7 years ago
77a9daccec
Validation that operationId is present
...
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
7 years ago
66268260c7
Merge remote-tracking branch 'remotes/origin/master'
7 years ago
1d4410b638
operationid -> operationId
...
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
7 years ago
88fb2e9abd
Merge pull request #1045 from maxidor/max/cs/unknow_filter_status
...
Add status for unknown user's filter ID
7 years ago
099a7e90ae
Change return code following feedback
7 years ago
dcaaf84395
Be clear that event_id is not applicable everywhere
7 years ago
efa9b5a8f1
Add missing required key for sync format
7 years ago
0fea380625
Add status for unknown user's filter ID
7 years ago
56c3e5a627
README.rst: Add notes on how to build the spec
7 years ago
628e723483
Move the MXID spec to the appendices
...
Also link to them from the /register API doc.
7 years ago
b4e24d443a
Clarify what happens when there is no power_levels event
7 years ago
a8afbfd27d
Avoid external link in search swagger
7 years ago
004a4d5148
Added/updated operationIds according to today's updates in the spec
...
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
7 years ago
24afe7987c
Add operationId to all endpoints of all APIs
...
To facilitate generation of API stubs from the spec.
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
7 years ago
bf3b49f13c
document joined_members and joined_rooms endpoints ( #999 )
7 years ago
820704a16a
Format examples as raw objects
...
According the the openapi spec, examples for responses and schemas should be
raw objects rather than being json strings. (It's unclear what non-json
examples should look like...).
The swagger UI used to support json strings, but no longer does. In short,
let's turn the json strings into their raw formats.
7 years ago
a84a34ee6c
GETting a filter requires auth ( #1003 )
7 years ago
1e3f5683c8
Make clear that the /sync timeout is zero by default
7 years ago
fee65dbacb
Fix response format and 404 example for room alias lookup
7 years ago
750d980bc0
Room member ( #950 )
...
* Fixed an incorrect membership on example
* Added precision on membership upon profile update
* Changed first example into a join
* Changed the state/{eventType}/{stateKey} example with an actual state key
7 years ago
da6938b818
Key management APIs ( #894 )
...
Spec the e2e key-management APIs.
8 years ago
09a768763d
Add missing enum fields for the set_presence parameter
...
Signed-off-by: Konstantinos Sideris <siderisk@auth.gr>
8 years ago
7adf95b4ad
Merge pull request #740 from matrix-org/rav/fix_736
...
Set default account 'kind' to 'user'
8 years ago
c83a556097
Set default account 'kind' to 'user'
...
Fixes https://github.com/matrix-org/matrix-doc/issues/736
8 years ago
c175039a08
Final public_rooms clarifications
...
* order by *joined* members
* clarify pagination direction behaviour
8 years ago
dca1d0c745
Merge branch 'master' into erikj/public_rooms
8 years ago
2bf0abcb9d
Add missing tag to PUT /devices/{deviceId}
8 years ago
b26c84a290
Fix schema validation fail
8 years ago
07dbf6fcf6
Add doc for PUT /devices/{deviceId}
...
Oops, forgot this.
8 years ago
d66792d5ca
Mention order of returned results
8 years ago
af515012ea
Device management API
8 years ago
9265b03008
Client device doc
...
Document client devices, and the mods to the login and register apis to support
them.
8 years ago
a69d6c63c6
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/public_rooms
8 years ago
cafa9a01fd
Move explanation of lack of direction param
8 years ago
71c1fc5ec0
Remove spurious 400 result
8 years ago
de68c167b6
Add tags for GET endpoint
8 years ago
9d0960b206
Better wording
8 years ago
49ee00c361
Use the right path for the identity API
8 years ago
42616f839c
Merge pull request #396 from matrix-org/dbkr/notifs_api
...
Spec notifs API
8 years ago
909aef2b18
Merge pull request #389 from matrix-org/erikj/create_room_is_direct
...
Spec /createRoom is_direct flag, is_direct in member event and m.direct
8 years ago
e0a434b248
Aaha, found a syntax that swagger will accept!
8 years ago
bd753d4bf4
Re-add required flags the correct way
8 years ago
af2c74c186
Revert `required`s
...
They're not boolean flags for object fields
8 years ago
14944fe237
More PR feedback
8 years ago
fd8c1a43c7
ms, not s. Also add required flags
8 years ago
b789251f70
More PR feedback
8 years ago
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
b4c89accb2
Params in query, not path
8 years ago
a463820d83
Typo
8 years ago
c1fa342b90
Swagger is failing on type 'any'
8 years ago
136d5dc9ad
Almost valid...
8 years ago
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
9 years ago
a9d3cfd13c
Merge branch 'master' into rav/link_undeprecated_endpoints
9 years ago
d92515bce3
Merge pull request #354 from matrix-org/rav/reorder_deprecated_initialsync
...
Move /room/x/initialSync to after the undeprecated APIs
9 years ago
7080fd0618
Merge pull request #348 from Ralith/room-messages
...
Add missing "to" parameter to /messages
9 years ago
dc7fc0309e
Add missing "to" parameter to /messages
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
9 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).
9 years ago
6bcb1798f5
Mark deprecated endpoints with their replacements
...
Fixes https://matrix.org/jira/browse/SPEC-415
9 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.
9 years ago
e91214e78e
More links
...
Also remove now redundant anchor
9 years ago
cf13c8997c
Merge branch 'dbkr/dont_line_wrap_rst' into dbkr/more_requesttokens
9 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
9 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
7e1cb9003c
Make swagger valid
9 years ago
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
39fe9e3896
Merge pull request #284 from matrix-org/dbkr/notification_counts
...
Add notification counts to doc
9 years ago
fecff8afdc
Specify association lookup
9 years ago
e0c55eeccf
Add initial identity server spec
...
More to come
9 years ago
11c572267e
Add titles where they're missing
9 years ago
a78dff3981
Add notification counts to doc
9 years ago
d2c05d64c7
Document an API for setting and getting the actions for a push rule
9 years ago
254fbe7983
Document GET for /pushrules/{scope}/{kind}/{ruleId}/enabled
9 years ago
e6143a6596
Merge pull request #281 from matrix-org/dbkr/fix_meta_escaping
...
Fix meta-escaping fail
9 years ago
2c5392f1d1
Fix meta-escaping fail
9 years ago
016ccf4544
Remove signed object which shouldn't exist
9 years ago
cbe466e572
Update API docs
9 years ago
ccac9e7882
/join accepts a signature for a third party invite
9 years ago
bc83677d98
Define the order for events returned by /context API
9 years ago
68a4306773
Split room previews into a separate module
...
Guest access and room peeking are orthogonal
9 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.
9 years ago
b28989b2ad
fix for https://github.com/matrix-org/matrix-doc/issues/270
9 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
9 years ago
53a4a563e2
Actually we think they should not be present (which means synapse is buggy).
9 years ago
542b17e944
Clarify what profile endpoints return if avatar url / display name isn't set
9 years ago
58b346e204
s/user_id/sender/ in context example response
9 years ago
b2e0a855cc
Add 'event' to event context API
...
also link through to the event schemas
9 years ago
e7f80b7c71
Fix the key name to be three_pid_creds rather than threePidCreds
9 years ago
2e46b587b8
Require explicit un-banning
9 years ago
169cc98101
M_INVALID_USERNAME to be consistent with the name of the parameter
9 years ago
2301a792d7
Add an error code for invalid user names.
9 years ago
cfbb695fd3
typoe
9 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.
9 years ago
6265d6ce06
Merge pull request #254 from matrix-org/rav/filter_spec
...
Add some missing titles to the filter upload spec
9 years ago
972153be4f
Fix endpoint path for /context
...
s/api//
9 years ago
ff26e0dc48
Add some missing titles to the filter upload spec
9 years ago
0e967edfd9
Fix thinko
9 years ago
7d9547274c
Clarify guest /events and /sync
9 years ago
48aab7bad9
Return room avatar URLs in /publicRooms
9 years ago
5e30d75ccb
Add /_matrix/versions to spec
9 years ago
48f56bfbfb
Support 3pid invites in /createRoom
9 years ago
1eee36e889
Merge pull request #232 from matrix-org/daniel/deprecatestuff
...
Deprecated deprecated APIs
9 years ago
c7d11335cf
Merge branch 'master' of git+ssh://github.com/matrix-org/matrix-doc
9 years ago
691d9ba664
typo :(
9 years ago
4c43939977
more backticks
9 years ago
9b4a37f57b
backticks
9 years ago
288c7ed353
Add top level filters for filtering by room id.
9 years ago
2ea66e9300
Merge branch 'markjh/account_data_filters' into markjh/room_filter
9 years ago
a32ed96a0f
Document filtering for account data
9 years ago
e413f05c87
Merge pull request #243 from matrix-org/markjh/wildcards
...
Filters don't support wildcards for senders or room ids
9 years ago
c9349b302a
Filters don't support wildcards for senders or room ids
9 years ago
b7c255a887
Tweaks/clarifications to search spec
...
Fixes https://matrix.org/jira/browse/SPEC-305
9 years ago
b6cd3adc2f
Merge pull request #233 from matrix-org/daniel/txnid
...
Merge pull request #233 from matrix-org/daniel/txnid
9 years ago
7090e491de
fix a typo in the example json for the old sync description
9 years ago
7980e65502
Merge pull request #234 from matrix-org/erikj/search_yet_agian
...
Note that count is approximate
9 years ago
88b350ca8b
Better wording
9 years ago
a2082e4b38
Note that count is approximate
9 years ago
dbba737135
Explain scope of uniqueness of txnid
9 years ago
3e086909f1
Deprecated deprecated APIs
9 years ago
a484f04b33
Merge pull request #221 from matrix-org/daniel/pushaway
...
Merge pull request #221 from matrix-org/daniel/pushaway
9 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
9 years ago
c3a1318886
Make it explicit that the JSON filter object is passed as a string
9 years ago
c96848d1bc
Merge pull request #169 from matrix-org/erikj/search_yet_agian
...
Search: Document event context, groups and orders.
9 years ago
95255bcdf5
Use rst not html
9 years ago
e1fda6b6b6
Remove double the
9 years ago
9c98c80bde
Fix up filter description
9 years ago
ed70bcb180
Add a rationale for allowing both inline filters and passing filters by id.
9 years ago
878ce2f206
Allow the filter JSON to be passed inline in the /sync request
9 years ago
6025569a73
Remove unused 403 stub
9 years ago
0fb88e26f0
Add tags
9 years ago
4290882034
Remove superfluous quote
9 years ago
8e7f6d44f6
Remove v1 references
9 years ago
4967b092aa
Add description of state response key
9 years ago
a2283f5499
Remove /notify from client-server API
9 years ago
f4b9433c7b
Better wording
9 years ago
584104c432
Make example valid event id
9 years ago
fda07e0d41
Merge remote-tracking branch 'origin/master' into erikj/event_context_api
9 years ago
856dd9100e
Merge remote-tracking branch 'origin/master' into erikj/search_yet_agian
9 years ago
118a6aa040
Reword groupings descriptions
9 years ago
1ef9cc37e3
Typo
9 years ago
fca8e5abe7
Add top level next_batch key to example
9 years ago
f81b967e2d
Make all the schema files yaml
9 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.
9 years ago
c9fee294df
Merge pull request #211 from matrix-org/daniel/extractas
...
Move application service swagger out of c-s dir
9 years ago
97579f15cb
Merge pull request #212 from matrix-org/daniel/pushdictification
...
Take object, not bool, as param
9 years ago
705556634a
Add filters
9 years ago
9c733a45e8
Take object, not bool, as param
...
Throughout our API we take objects. And swagger is unhappy with not
doing so.
9 years ago
614ee9ea1b
Move application service swagger out of c-s dir
9 years ago
140206ca69
s/archived/leave/
9 years ago
79d109f7cc
Add an flag to control whether rooms the user has left are included in the sync
9 years ago
e0ebabf8cc
Explicitly document /rooms/{roomId}/state/{eventType} without state key
9 years ago
873b0dcecf
Replace version numbers with release numbers
9 years ago
f308b7543c
Specify /admin/whois/{userId}
9 years ago
19ce17cfed
Merge pull request #200 from matrix-org/daniel/redact
...
Merge pull request #200 from matrix-org/daniel/redact
9 years ago
2f3a00fe34
Consistently spell homeserver as homeserver
9 years ago
e072d215cf
Specify redaction
9 years ago
7f07da4b50
Remove obsolete documentation
9 years ago
aa4ed10821
Unify v1 and v2 event schemas
9 years ago
681c258206
Fix turnServer endpoint
9 years ago
ca7ef1b536
Update Results description
9 years ago
5e8bb34f36
Change the results dict to a list
9 years ago
46fd0b252c
Merge branch 'master' of github.com:matrix-org/matrix-doc into erikj/search_yet_agian
9 years ago
c6e0322a9e
Swaggerify /account
9 years ago
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
3951785f19
Fix alias path
9 years ago
bc514dc9c4
Merge pull request #178 from matrix-org/daniel/directory
...
Fix and include /directory api docs
9 years ago
7f2813354d
Swaggerify /ban
9 years ago
a20a49abf6
Merge pull request #168 from matrix-org/markjh/client_config
...
Add API for setting client config
9 years ago
c5f457cee9
Merge pull request #132 from matrix-org/markjh/room_tags
...
Document a v2 api for setting tags on rooms
9 years ago
f0c99a6925
Generate API docs from swagger
9 years ago
c539b208f9
Merge branch 'markjh/room_tags' into markjh/client_config
...
Conflicts:
api/client-server/v2_alpha/sync.yaml
9 years ago
d39494b6df
Fix typo in sync example
9 years ago
5e30b5b8d7
Remove POST version of /send
...
PUT should always be used.
9 years ago
c25a806cef
Fix and include /directory api docs
9 years ago
5ccc39b850
Say that type is an event type
9 years ago
e76068a2a6
Merge branch 'markjh/room_tags' into markjh/client_config
9 years ago
5bae15d47b
Merge branch 'master' into markjh/room_tags
...
Conflicts:
api/client-server/v2_alpha/sync.yaml
9 years ago
46870da57d
Add optional profile info and state in search response
9 years ago
d8dd380dfa
Merge pull request #164 from matrix-org/rav/SPEC-254
...
Fix /sync documentation, post SPEC-254
9 years ago
05c0092664
s/config/account_data/
9 years ago
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
40f7eab73f
s/private_user_data/account_data/
9 years ago
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
fcbb985073
s/private_user_data/account_data/
9 years ago
6653362f31
Unflatten 'unsigned'
...
It turns out that flattening 'unsigned' comes with too many downsides. Let's
stick with the status quo.
9 years ago
6763317e64
Specify /rooms/:room_id/forget
9 years ago
8201eaa042
Swaggerify /rooms/:room_id/leave
9 years ago
ffed14a0cd
Add next_batch token
9 years ago
8991c4fa78
Fix schema and example
9 years ago
5e0e4a8518
Document group and context response keys
9 years ago
299af673da
Specify how ordering of tags is supposed to work
9 years ago
3b390bff3c
Merge branch 'master' into markjh/room_tags
...
Conflicts:
api/client-server/v1/rooms.yaml
specification/targets.yaml
9 years ago
8f5783615c
Merge branch 'master' into markjh/client_config
...
Conflicts:
api/client-server/v1/rooms.yaml
specification/targets.yaml
9 years ago
22b3159a39
Add examples of v1 initialSync and v2 /sync returning the client config
9 years ago
769c5285ab
Add API for setting client config
9 years ago
e2eb0c7ad9
Add new request options
9 years ago
e1b12a753e
Fix typos and missing file
9 years ago
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
b41d771c15
Fix typos in /sync example response
9 years ago
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
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
061105c9dc
Guest users are allowed room initialSync
9 years ago
dcf54e11b1
Specify /publicRooms world_readable and guest_access
...
Depends on https://github.com/matrix-org/matrix-doc/pull/154
9 years ago
d7357ef9b7
Specify /publicRooms
9 years ago
24c2036a35
3pid invites: remove mentions of display_name
9 years ago
e72151f2c3
Specify guest room access
...
This was reviewed as PR #150 and merged from daniel/anonymousaccess
9 years ago
161441fa3a
Update 3pid spec based on new implementation
9 years ago
232b10b0f6
Merge branch 'master' of github.com:matrix-org/matrix-doc
9 years ago
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
ebc0237109
Add the missing titles to the schema
9 years ago
d53814097f
Add example content to the tags in example tag events
9 years ago
e9d361841b
Fix tag examples
9 years ago
2e3a0b4e00
Specify guest accounts
9 years ago
52f55e0542
Allow room tags to have asssociated content, and return that content in the m.tag events
9 years ago
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
ad86426e95
Add private_user_data to v1 room /initialSync
9 years ago
b49472e3b0
Add private_user_data to v1 /initialSync
9 years ago
451801bf38
Add an example of ``prev_content`` in ``unsigned`` to v2 /sync
9 years ago
fa2fe2ddd9
Add event context api swagger
9 years ago
6c1df04b4b
typo
9 years ago
ece42688d0
Clarify the interaction between full_state and timeout.
9 years ago
65066a76b3
Add the m.tags event to a ``private_user_data`` key rather than including it under the ``ephemeral`` key
9 years ago
12e33a3b09
Document a v2 api for setting tags on rooms
9 years ago
13eddd456f
Proposal for adding full_state param to v2 sync
9 years ago
ade0ad5ed1
Merge pull request #129 from matrix-org/erikj/search_actual
...
Add filter param to search API
9 years ago
36634df355
Add filter param
9 years ago
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
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
1d7cb6937f
Merge pull request #123 from matrix-org/markjh/list_formatting
...
Fix list formatting
9 years ago
637718108e
Add newline before list
9 years ago
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
587a8ba7ce
Merge branch 'master' into rav/send_events_api
9 years ago
d2bbc461e4
mark stateKey as required in room/{id}/state
...
Swagger insists that path params be mandatory.
9 years ago
d18d406c41
Add the room send and state APIs to the spec
9 years ago
cc14620932
Add a newline before the list
9 years ago
e3e8026025
Fix list formatting so that we aren't including everything in blockquotes
9 years ago
f0c74a9c83
Merge pull request #96 from matrix-org/erikj/search_actual
...
Add search API
9 years ago
f95d19cecd
Merge branch 'master' into appservice-swagger
...
Conflicts:
specification/application_service_api.rst
9 years ago
4c3e1b9ed3
Find replace fail
9 years ago
bd539c72b4
More review comments
9 years ago
1d01f69c3c
Merge remote-tracking branch 'origin/master' into erikj/search_actual
9 years ago
26f27d95fb
Merge branch 'master' into registration-swagger
...
Conflicts:
specification/client_server_api.rst
9 years ago
f450fc1db6
Typo
9 years ago
4bb042daeb
Review comments round II
9 years ago
e0fe3c42c8
Review comments
9 years ago
6770d6b2d6
Review comments
9 years ago
716c5b7a8b
Add 400 and 429 response codes
9 years ago
eca98af896
Swaggerify /register endpoint
...
Need to move registration/login/auth sections around once #94 lands.
9 years ago
cfca4a6c09
s/creteria/criteria/
9 years ago
f20faa80e5
Swagger validation
9 years ago
55cc5c5bb5
Swaggerify application services
9 years ago
5de63b4f45
Merge branch 'master' into proofing
...
Conflicts:
specification/0-intro.rst
9 years ago
1f2f14dc08
YAML tweaks
9 years ago
84af5776d7
Newlines
9 years ago
2b9484cf48
Spell things correctly
9 years ago
392a1c5ad8
Another title
9 years ago
ca9e44baac
Moar titles
9 years ago
a7a5cb088b
Add titles
9 years ago
e42c8b5b63
Add search API
9 years ago
4a9db39277
Clean up some untruths in the login api doc
...
add "type", and "username" -> "user"
9 years ago
6f6861a11d
Swaggerify the createRoom API
9 years ago
41fb0645a9
Add message pagination API
9 years ago
7bdb71b1c9
Tweak the syncing section
...
Bring together disparate sections to make it more cohesive.
9 years ago
2502ca7ac6
Merge branch 'master' into daniel/threepidinvites-2
...
Conflicts:
specification/targets.yaml
9 years ago
616f3990aa
Merge pull request #87 from matrix-org/module-push
...
Push Module
9 years ago
8f5c796884
Linkify 'pushers'
9 years ago
d42c3195e6
Use 'true' rather than '1' for archived flag
9 years ago
241096dc81
Add a flag to initial sync to indicate we want rooms that the user has left
9 years ago
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
dc3c02aff5
Review comments
9 years ago
21a40b317d
Merge branch 'master' into daniel/threepidinvites-2
9 years ago
9c95ee5c1f
Modify wording and formatting
9 years ago
befa23624e
It's dangerous to go alone, take this.
9 years ago
65504db7bb
Display nested keys on arrays of objects. Make it valid swagger.
9 years ago
31ae4b3859
Swaggerify push notification API
...
Edit units.py to support nested JSON request keys
9 years ago
a9618a981b
Swaggerify the /enabled endpoint
9 years ago
56ce432399
Get profile tag keys displaying correctly.
9 years ago
f6da9d7760
Give valid swagger. Split out rule/ruleset to separate definitions.
9 years ago
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
9540069acd
Use valid JSON
9 years ago
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
034241eb20
Missing symlink for the v2 swagger APIs
9 years ago
509d178d58
Fix the receipts API to be valid swagger
9 years ago
4f606cf3a7
Add the fields required by the templating system to v2 sync
9 years ago
5a5a6565ff
Merge pull request #68 from matrix-org/markjh/v2_sync_api
...
Swagger documentation for the v2 sync API
9 years ago
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
0e5b00feaa
Fix event type in v2 sync example
9 years ago
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
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
ed0f6d3ff3
Typo
9 years ago
97cdd8106c
s|client/api/v2_alpha|/client/v2_alpha|
9 years ago
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
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
ead79614ff
Merge pull request #78 from matrix-org/module-typing2
...
Typing module
9 years ago
a73cc50aa9
s|client/api/v2_alpha|client/v2_alpha|
9 years ago
09ac367847
Merge branch 'master' into module-content-repo
...
Conflicts:
templating/matrix_templates/units.py
9 years ago
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
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
d2c56fb7a3
Merge branch 'master' into daniel/threepidinvites-2
9 years ago
8c4d7f5051
Do not try to parse non-json request examples as json
9 years ago
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
8aad238cda
Merge pull request #80 from matrix-org/module-receipts
...
Receipts module
9 years ago
da2be7eae4
Merge branch 'master' into module-voip
...
Conflicts:
specification/modules/voip_events.rst
9 years ago
1520f3647f
Merge branch 'master' into module-typing2
...
Conflicts:
specification/modules/typing_notifications.rst
9 years ago
c972dad8b3
Flesh out receipts module. Add receipts swagger
...
Add templating support for v2 apis.
9 years ago
e82661413e
Add /turnServer endpoint
9 years ago
abe5d08ac6
Merge pull request #64 from matrix-org/erikj/invite_state
...
Bundle some state into invites
9 years ago
2b7e02c080
Add sections for typing. Add swagger, JSON schema and example m.typing event
9 years ago
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
4cb3f78d2b
Wrap the "rooms" list inside an object so that we can add keys for pagination later
9 years ago
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
50e1b4c3a7
Fix up rst
9 years ago
6ad6c40147
List the allowed values for the 'event_format' as an enum
9 years ago
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
14b42a41d6
Document wildcard's in filters
9 years ago
c115b4c2f4
Document the valid values for the "set_presence" parameter
9 years ago
940e22940d
Document how the "not_foo" keys interact with the "foo" keys
9 years ago
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
00fd4aac26
s/publically/publicly/
9 years ago
3204c2f2b6
Fix spelling
9 years ago
f50e6d4c0a
Add x-example fields for v2 /sync
9 years ago
1aa916d690
s/indicies/indices/
9 years ago
393d283139
Add a "limit" to the timeline key in the example filter
9 years ago
8c22b715ca
Add title
9 years ago
c3b3b2df63
Add "set_presence" in the sync parameters
9 years ago
de07586ab7
Rename 'events' to 'timeline' in the sync filter
9 years ago
a0068e1ada
Draft documention for the v2 sync api
9 years ago
e1f73f5233
Add a limit to filters
9 years ago
37ccddb308
Typo
9 years ago
d7d9f406a6
Bundle some state into invites
9 years ago
cd6f15f627
Remove obsolete comment
9 years ago
0c1eb50ef4
Merge pull request #26 from matrix-org/macaroons
...
Spec macaroons and token refresh
9 years ago
6c1491b3ba
Respond to some review comments
9 years ago
5c4398c181
Remove superfluous comma
9 years ago
fc87f4cdb0
Remove unused keys
9 years ago
6c89e6ea67
Wrap refresh_token in `s
9 years ago
f34722485f
Check the request example JSON matches the schema
9 years ago
a31a446661
Fix the POST example for the v2 filter API
9 years ago
69298b9612
Check "v2_alpha" in jenkins
9 years ago
883105eae6
Document the v2 filter GET API
9 years ago
2f039a1142
Add swagger docs for the v2 filter POST API
9 years ago
385b6c4759
Only validate a file if it ends with ".yaml".
...
Otherwise we try to validate vim .swp files.
9 years ago
98d91d0c2b
Make the example room id more "random" so that people are less likely to think that it is supposed to be human readable
9 years ago
f60190086a
Describe the behaviour of /rooms/{roomId}/member when the user has left the room
9 years ago
ba6c7d267c
SPEC-216: Document the behaviour of the room getters when the user has left the room
9 years ago
615a9575cb
SPEC-216: Clarify when the room getters will return 403
9 years ago
cb41adee70
Fix the swagger host to be "localhost:8008" so that it can be used in a "Try it now" setup against localhost
9 years ago
6a2c4d27fc
Update the docs for room v1 api
9 years ago
f33c0846c3
Merge remote-tracking branch 'origin/master' into markjh/document_v1_rooms_api
9 years ago
f827765ba1
Make to code to skip checking swagger responses which don't have an
...
application/json example clearer.
9 years ago
9896f98e2b
Search for yaml swagger files if check_examples.py is run without
...
arguments.
9 years ago
299a4356d4
Add script to check that the example responses in the swagger matches
...
the examples.
9 years ago
63f08bace6
Fix the examples in the swagger API documentation to be valid JSON
9 years ago
7f81501762
Allow relative references to schema to work in python and node.
...
Rename "schema/v1/core" to "schema/v1/core-event-schema".
Add self-referential symlinks to schema/v1/core-event-schema
The python json schema libraries expect that relative references are
relative to the file they are in. The node json schema libraries
expect that relateive references are relative to the first file loaded.
To support both kinds we reference the core event schema using
"core-event-schema/event.json". We then symlink the core-event-schema
directory to both the location of the file refering to "event.json" so
that it will work in python and to the location of the top level file
so that it will work in node.
9 years ago
46d29e9eea
fix the room api swagger to be valid swagger
9 years ago
315f97e36b
Merge branch 'master' into markjh/document_v1_rooms_api
9 years ago
c49338006a
replace definitions/*event.yaml with symlinks to /event-schemas/
9 years ago
a19e18a4da
Merge branch 'master' into daniel/threepidinvites-2
9 years ago
2e9d3d283a
Swagger refresh tokens
9 years ago
7eb8b4fde2
Add new-style docs for the APIs for getting events for a room
9 years ago
59a4e84361
s/registration/login/
9 years ago
Travis Ralston