Travis Ralston
f012da17a1
Explain why e2e previews are bad
2019-11-05 16:00:55 -07:00
Travis Ralston
b662a33081
Recommend that clients don't preview URLs in encrypted rooms
...
Any stronger of a recommendation would probably require a MSC due to the behaviour change.
Fixes https://github.com/matrix-org/matrix-doc/issues/2120
2019-11-04 15:47:25 -07:00
Travis Ralston
dc6d89caca
Split download endpoints back apart
...
Apparently you can't have an optional path parameter.
2019-06-02 21:31:06 -06:00
Travis Ralston
1f86e8e31b
Refactor documentation for content/media repository
...
Fixes https://github.com/matrix-org/matrix-doc/issues/2060
Fixes https://github.com/matrix-org/matrix-doc/issues/772
Fixes https://github.com/matrix-org/matrix-doc/issues/888
2019-06-02 21:25:11 -06:00
Travis Ralston
62890d21b2
Fix example Content-Type for /media/upload request
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1770
2019-05-27 23:08:02 -06:00
Richard van der Hoff
14715468bb
Make thumbnail dimensions mandatory
...
Fixes #1883
2019-04-26 14:41:19 +01:00
Travis Ralston
667fa082af
Replace applicable types of 'number' to 'integer'
...
`number` implies/represents a float where `integer` does not.
The only remaining `type: number` in the project appear on power levels: those have been left untouched pending clarification.
Fixes https://github.com/matrix-org/matrix-doc/issues/746
2018-08-26 21:32:44 -06:00
Travis Ralston
516000bdc3
Fix error reference in media repo
2018-07-06 08:53:04 -06:00
Travis Ralston
ab75fc4b20
Merge remote-tracking branch 'matrix-org/master' into travis/better-errors
2018-07-06 08:46:50 -06:00
Will Hunt
ff3c379339
Merge pull request #1189 from Half-Shot/hs/upload-limits
...
GET media/config 🎉
2018-07-06 11:37:35 +00:00
Will Hunt
77f4ac54aa
Wordy intro sentence for description
2018-07-06 10:36:17 +01:00
Will Hunt
2e6cc8045c
Better indent of description
2018-07-06 10:29:05 +01:00
Will Hunt
d5ce87e956
Split summary up into description and summary
2018-07-06 10:27:03 +01:00
Travis Ralston
55c27d6212
Merge branch 'master' into travis/better-errors
2018-07-05 13:40:17 -06:00
Travis Ralston
7cd22f5690
Describe the rate limit error everywhere
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1153
2018-07-04 13:45:34 -06:00
Will Hunt
a1309d636c
Remove "Clients should handle gracefully" sentence
2018-06-29 09:58:07 +01:00
Will Hunt
41c18bed0f
+repository
2018-06-28 17:53:57 +01:00
Will Hunt
21e957edfb
Better note for /config
2018-06-28 17:23:57 +01:00
Will Hunt
1820df02d9
media => content repository
2018-06-28 17:07:44 +01:00
Will Hunt
091b2a6771
Hard limit on requiring accessToken. Rephrased some sections
2018-06-28 16:42:36 +01:00
Will Hunt
eeaf4385d7
Speling is my weakniss
2018-06-28 09:04:01 +01:00
Will Hunt
80935eadcf
Update content-repo.yaml
2018-06-28 00:14:42 +01:00
Will Hunt
ddc152347b
Extending words and rate limiting
2018-06-27 20:14:29 +01:00
Will Hunt
6d0a56d190
Suggestions by Travis tend to be sensible ones
2018-06-22 09:38:53 +01:00
Will Hunt
6b9640bcb4
upload_size => m.upload.size
2018-06-20 17:06:17 +01:00
Will Hunt
077cd04a6d
/limits => /config
2018-06-20 16:01:06 +01:00
Kitsune Ral
42fba1a87e
Add 'default' to formally enforce the description
...
A quick follow up on #1265 .
Signed-off-by: Alexey Rusakov <Alexey.Rusakov@pm.me>
2018-06-03 13:12:59 +09:00
Travis Ralston
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>
2018-05-27 12:34:58 -06:00
Will Hunt
ffc8ee298a
a upload > an upload
2018-05-08 11:50:34 +01:00
Will Hunt
de6fe1b76e
Add note about auth
2018-05-03 18:00:50 +01:00
Will Hunt
c9abf36097
size > upload_size
2018-05-03 16:58:22 +01:00
Will Hunt
2783820f98
Initial draft of GET media/limits
2018-05-03 13:54:36 +01:00
Jason Volk
048de9803e
Fix typo.
2018-04-22 22:57:40 -07:00
Kitsune Ral
a68b7e1bbd
Supply operationId with freshly added operations
...
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
2017-11-15 07:37:02 +09:00
Kitsune Ral
b53083732b
Merge remote-tracking branch 'remotes/origin/master'
2017-11-15 07:32:44 +09:00
Travis Ralston
0f5a4efce6
Spec URL previews ( #1064 )
...
* Spec URL previews
* Require authentication on /upload and /preview_url
2017-11-14 14:52:51 +00:00
Kitsune Ral
1d4410b638
operationid -> operationId
...
Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>
2017-11-13 07:46:03 +09:00
Kitsune Ral
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>
2017-10-11 01:58:31 +09:00
Richard van der Hoff
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.
2017-09-27 08:04:24 +01:00
Mark Haines
d2fe2f1ff6
Fix jenkins
2016-08-02 13:59:46 +01:00
Mark Haines
618f94699b
Document the optional parameter for specifying a filename to download an attachment as
2016-08-02 13:49:54 +01:00
Richard van der Hoff
7ac2f51e4a
/upload: fix example for filename
...
The example shouldn't be encoded, else it will be double-encoded by swagger.
2016-07-25 09:07:42 +01:00
Benjamin Saunders
3e2dea4c52
Document filename query parameter for uploads
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
2016-07-24 23:27:56 -07:00
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).
2016-07-12 17:28:30 +01:00
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.
2015-12-07 12:45:13 +00:00
Daniel Wagner-Hall
873b0dcecf
Replace version numbers with release numbers
2015-12-04 11:09:35 +00:00
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.
2015-11-30 11:22:57 +00:00